bes  Updated for version 3.19.1
BESInterface.h
1 // BESInterface.h
2 
3 // This file is part of bes, A C++ back-end server implementation framework
4 // for the OPeNDAP Data Access Protocol.
5 
6 // Copyright (c) 2004-2009 University Corporation for Atmospheric Research
7 // Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU Lesser General Public
11 // License as published by the Free Software Foundation; either
12 // version 2.1 of the License, or (at your option) any later version.
13 //
14 // This library is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // Lesser General Public License for more details.
18 //
19 // You should have received a copy of the GNU Lesser General Public
20 // License along with this library; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 //
23 // You can contact University Corporation for Atmospheric Research at
24 // 3080 Center Green Drive, Boulder, CO 80301
25 
26 // (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
27 // Please read the full copyright statement in the file COPYRIGHT_UCAR.
28 //
29 // Authors:
30 // pwest Patrick West <pwest@ucar.edu>
31 // jgarcia Jose Garcia <jgarcia@ucar.edu>
32 
33 #ifndef BESInterface_h_
34 #define BESInterface_h_ 1
35 
36 #include "BESObj.h"
37 
38 class BESError;
39 class BESTransmitter;
41 
115 class BESInterface: public BESObj {
116 private:
117  ostream *d_strm;
118  int d_timeout_from_keys;
119 
120 protected:
123 
124  virtual int exception_manager(BESError &e);
125  virtual void finish();
126  virtual void end_request();
127 
128  virtual void build_data_request_plan() = 0;
129 
130  virtual void execute_data_request_plan() = 0;
131 
132  virtual void transmit_data() = 0;
133 
134  virtual void log_status() = 0;
135 
136  virtual void clean() = 0;
137 
138  BESInterface(ostream *strm);
139 
140  virtual ~BESInterface() { }
141 
142 public:
143  // This is the point where BESServerHandler::execute(Connection *c) passes control
144  // to the 'run the command' part of the server. jhrg 11/7/17
145  virtual int execute_request(const string &from);
146 
147  virtual int finish_with_error(int status);
148 
149  virtual void dump(ostream &strm) const;
150 };
151 
152 #endif // BESInterface_h_
153 
virtual void dump(ostream &strm) const
dumps information about this object
BESDataHandlerInterface * d_dhi_ptr
Allocated by the child class.
Definition: BESInterface.h:121
virtual int exception_manager(BESError &e)
Manage any exceptions thrown during the whole process.
BESTransmitter * d_transmitter
The Transmitter to use for the result.
Definition: BESInterface.h:122
Base object for bes objects.
Definition: BESObj.h:52
Abstract exception class for the BES with basic string message.
Definition: BESError.h:56
Entry point into BES, building responses to given requests.
Definition: BESInterface.h:115
Structure storing information used by the BES to handle the request.
virtual void end_request()
End the BES request.
virtual int execute_request(const string &from)
The entry point for command execution; called by BESServerHandler::execute()