bes  Updated for version 3.20.6
BESTransmitter.h
1 // BESTransmitter.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 A_BESTransmitter_h
34 #define A_BESTransmitter_h 1
35 
36 #include <string>
37 #include <map>
38 
39 #include "BESObj.h"
40 
41 class BESInfo;
43 class BESResponseObject;
44 
45 typedef void (*p_transmitter)(BESResponseObject *obj, BESDataHandlerInterface &dhi);
46 
47 class BESTransmitter: public BESObj {
48 private:
49  std::map<std::string, p_transmitter> _method_list;
50 
51  typedef std::map<std::string, p_transmitter>::const_iterator _method_citer;
52  typedef std::map<std::string, p_transmitter>::iterator _method_iter;
53 
54 public:
56  {
57  }
58  virtual ~BESTransmitter()
59  {
60  }
61 
62  virtual bool add_method(std::string method_name, p_transmitter trans_method);
63  virtual bool remove_method(std::string method_name);
64  virtual p_transmitter find_method(std::string method_name);
65 
66  // TODO I think BESResponseObject may be superfluous here since it's in the DHI,
67  // but maybe not... should check. jhrg 2/20/15
68  virtual void send_response(const std::string &method, BESResponseObject *obj, BESDataHandlerInterface &dhi);
69 
70  virtual void send_text(BESInfo &info, BESDataHandlerInterface &dhi);
71  virtual void send_html(BESInfo &info, BESDataHandlerInterface &dhi);
72 
73  virtual void dump(std::ostream &strm) const;
74 };
75 
76 #endif // A_BESTransmitter_h
BESTransmitter::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: BESTransmitter.cc:132
BESInfo
informational response object
Definition: BESInfo.h:63
BESObj
top level BES object to house generic methods
Definition: BESObj.h:49
BESTransmitter
Definition: BESTransmitter.h:47
BESDataHandlerInterface
Structure storing information used by the BES to handle the request.
Definition: BESDataHandlerInterface.h:56
BESResponseObject
Abstract base class representing a specific set of information in response to a request to the BES.
Definition: BESResponseObject.h:45