bes  Updated for version 3.20.6
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 <string>
37 #include <ostream>
38 
39 #include "BESObj.h"
40 
41 class BESError;
42 class BESTransmitter;
44 
118 class BESInterface: public BESObj {
119 private:
120  std::ostream *d_strm;
121  int d_timeout_from_keys;
122 
123 protected:
126 
127 #if 0
128  virtual int exception_manager(BESError &e);
129 #endif
130 
131  virtual void end_request();
132 
133  virtual void build_data_request_plan() = 0;
134 
135  virtual void execute_data_request_plan() = 0;
136 
137  virtual void transmit_data() = 0;
138 
139  virtual void log_status() = 0;
140 
141  virtual void clean() = 0;
142 
143  BESInterface(std::ostream *strm);
144 
145  virtual ~BESInterface() { }
146 
147  static int handleException(BESError &e, BESDataHandlerInterface &dhi);
148 
149 public:
150  // This is the point where BESServerHandler::execute(Connection *c) passes control
151  // to the 'run the command' part of the server. jhrg 11/7/17
152  virtual int execute_request(const std::string &from);
153 
154  virtual int finish(int status);
155 
156  virtual void dump(std::ostream &strm) const;
157 };
158 
159 #endif // BESInterface_h_
160 
BESInterface::end_request
virtual void end_request()
End the BES request.
Definition: BESInterface.cc:610
BESInterface
Entry point into BES, building responses to given requests.
Definition: BESInterface.h:118
BESInterface::finish
virtual int finish(int status)
Definition: BESInterface.cc:580
BESObj
top level BES object to house generic methods
Definition: BESObj.h:49
BESTransmitter
Definition: BESTransmitter.h:47
BESInterface::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: BESInterface.cc:629
BESInterface::d_transmitter
BESTransmitter * d_transmitter
The Transmitter to use for the result.
Definition: BESInterface.h:125
BESInterface::handleException
static int handleException(BESError &e, BESDataHandlerInterface &dhi)
Make a BESXMLInfo object to hold the error information.
Definition: BESInterface.cc:329
BESInterface::d_dhi_ptr
BESDataHandlerInterface * d_dhi_ptr
Allocated by the child class.
Definition: BESInterface.h:124
BESDataHandlerInterface
Structure storing information used by the BES to handle the request.
Definition: BESDataHandlerInterface.h:56
BESError
Abstract exception class for the BES with basic string message.
Definition: BESError.h:58
BESInterface::execute_request
virtual int execute_request(const std::string &from)
The entry point for command execution; called by BESServerHandler::execute()
Definition: BESInterface.cc:447