bes  Updated for version 3.20.6
BESInfo.h
1 // BESInfo.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 BESInfo_h_
34 #define BESInfo_h_ 1
35 
36 #include <string>
37 #include <ostream>
38 #include <stack>
39 #include <map>
40 
41 #include "BESResponseObject.h"
42 #include "BESDataHandlerInterface.h"
43 #include "BESTransmitter.h"
44 #include "BESError.h"
45 
63 class BESInfo: public BESResponseObject {
64 protected:
65  std::ostream *_strm;
66  bool _strm_owned;
67  bool _buffered;
68  bool _response_started;
69 
70  std::stack<std::string> _tags;
71  std::string _response_name;
72 
73 public:
74  BESInfo();
75  BESInfo(const std::string &buffered_key, std::ostream *strm, bool strm_owned);
76  virtual ~BESInfo();
77 
78  virtual void begin_response(const std::string &response_name, BESDataHandlerInterface &dhi);
79  virtual void begin_response(const std::string &response_name, std::map<std::string, std::string> *attrs, BESDataHandlerInterface &dhi);
80  virtual void end_response();
81 
82  virtual void add_tag(const std::string &tag_name, const std::string &tag_data, std::map<std::string, std::string> *attrs = 0) = 0;
83  virtual void begin_tag(const std::string &tag_name, std::map<std::string, std::string> *attrs = 0);
84  virtual void end_tag(const std::string &tag_name);
85 
86  virtual void add_data(const std::string &s);
87  virtual void add_space(unsigned long num_spaces) = 0;
88  virtual void add_break(unsigned long num_breaks) = 0;
89 
90  virtual void add_data_from_file(const std::string &key, const std::string &name);
91 
92  virtual void add_exception(BESError &e, const std::string &admin);
93 
103  virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi) = 0;
104 
105  virtual void print(std::ostream &strm);
106 
111  virtual bool is_buffered()
112  {
113  return _buffered;
114  }
115 
120  virtual void dump(std::ostream &strm) const;
121 };
122 
123 #endif // BESInfo_h_
124 
BESInfo::print
virtual void print(std::ostream &strm)
print the information from this informational object to the specified stream
Definition: BESInfo.cc:261
BESInfo::transmit
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)=0
transmit the informational object
BESInfo
informational response object
Definition: BESInfo.h:63
BESInfo::add_data_from_file
virtual void add_data_from_file(const std::string &key, const std::string &name)
add data from a file to the informational object.
Definition: BESInfo.cc:182
BESInfo::add_exception
virtual void add_exception(BESError &e, const std::string &admin)
add exception information to this informational object
Definition: BESInfo.cc:234
BESTransmitter
Definition: BESTransmitter.h:47
BESInfo::add_data
virtual void add_data(const std::string &s)
add data to this informational object. If buffering is not set then the information is output directl...
Definition: BESInfo.cc:160
BESInfo::dump
virtual void dump(std::ostream &strm) const
Displays debug information about this object.
Definition: BESInfo.cc:275
BESInfo::begin_response
virtual void begin_response(const std::string &response_name, BESDataHandlerInterface &dhi)
begin the informational response
Definition: BESInfo.cc:124
BESInfo::BESInfo
BESInfo()
constructs a BESInfo object
Definition: BESInfo.cc:52
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
BESInfo::is_buffered
virtual bool is_buffered()
return whether the information is to be buffered or not.
Definition: BESInfo.h:111
BESResponseObject
Abstract base class representing a specific set of information in response to a request to the BES.
Definition: BESResponseObject.h:45