bes
Updated for version 3.20.6
|
#include <BESVersionInfo.h>
Public Member Functions | |
virtual void | add_break (unsigned long num_breaks) |
virtual void | add_data (const std::string &s) |
add data to this informational object. If buffering is not set then the information is output directly to the output stream. More... | |
virtual void | add_data_from_file (const std::string &key, const std::string &name) |
add data from a file to the informational object. More... | |
virtual void | add_exception (BESError &e, const std::string &admin) |
add exception information to this informational object More... | |
virtual void | add_library (const std::string &n, const std::string &v) |
virtual void | add_module (const std::string &n, const std::string &v) |
virtual void | add_service (const std::string &n, const std::list< std::string > &vers) |
virtual void | add_space (unsigned long num_spaces) |
virtual void | add_tag (const std::string &tag_name, const std::string &tag_data, std::map< std::string, std::string > *attrs=0) |
virtual void | begin_response (const std::string &response_name, BESDataHandlerInterface &dhi) |
begin the informational response More... | |
virtual void | begin_response (const std::string &response_name, std::map< std::string, std::string > *attrs, BESDataHandlerInterface &dhi) |
begin the informational response More... | |
virtual void | begin_tag (const std::string &tag_name, std::map< std::string, std::string > *attrs=0) |
BESVersionInfo () | |
constructs a basic text information response object to write version information More... | |
virtual void | dump (std::ostream &strm) const |
dumps information about this object More... | |
virtual void | end_response () |
virtual void | end_tag (const std::string &tag_name) |
virtual bool | is_buffered () |
return whether the information is to be buffered or not. More... | |
virtual void | print (std::ostream &strm) |
print the information from this informational object to the specified stream More... | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the informational object More... | |
Protected Attributes | |
bool | _buffered |
std::string | _response_name |
bool | _response_started |
std::ostream * | _strm |
bool | _strm_owned |
std::stack< std::string > | _tags |
brief represents simple text information in a response object, such as version and help information.
Uses the default add_data and print methods, where the print method, if the response is going to a browser, sets the MIME type to text.
Definition at line 47 of file BESVersionInfo.h.
BESVersionInfo::BESVersionInfo | ( | ) |
constructs a basic text information response object to write version information
Definition at line 49 of file BESVersionInfo.cc.
|
inlinevirtual |
add data to this informational object. If buffering is not set then the information is output directly to the output stream.
s | information to be added to this informational response object |
Reimplemented from BESInfo.
Definition at line 83 of file BESVersionInfo.h.
|
inlinevirtual |
add data from a file to the informational object.
Adds data from a file to the informational object using the file specified by the passed key string. The key is found from the bes configuration file.
If the key does not exist in the initialization file then this information is added to the informational object, no excetion is thrown.
If the file does not exist then this information is added to the informational object, no exception is thrown.
key | Key from the initialization file specifying the file to be |
name | A description of what is the information being loaded |
Reimplemented from BESInfo.
Definition at line 95 of file BESVersionInfo.h.
|
inlinevirtual |
add exception information to this informational object
Exception information is added differently to different informational objects, such as html, xml, plain text. But, using the other methods of this class we can take care of exceptions here.
e | The exception to add to the informational response object |
admin | The contact information for the person responsible for this error |
Reimplemented from BESInfo.
Definition at line 99 of file BESVersionInfo.h.
|
inlinevirtual |
begin the informational response
basic setup of the response from abstract class
response_name | name of the response this information represents |
dhi | information about the request and response |
Reimplemented from BESInfo.
Definition at line 61 of file BESVersionInfo.h.
|
virtualinherited |
begin the informational response
basic setup of the response from abstract class
response_name | name of the response this information represents |
dhi | information about the request and response |
Reimplemented in BESXMLInfo.
Definition at line 111 of file BESInfo.cc.
|
virtual |
dumps information about this object
Displays the pointer value of this instance along with information about this version information object
strm | C++ i/o stream to dump the information to |
Reimplemented from BESInfo.
Definition at line 98 of file BESVersionInfo.cc.
|
inlinevirtualinherited |
|
inlinevirtual |
print the information from this informational object to the specified stream
If the information was not buffered then this method does nothing, otherwise the information is output to the specified ostream.
strm | output to this file descriptor if information buffered. |
Reimplemented from BESInfo.
Definition at line 107 of file BESVersionInfo.h.
|
inlinevirtual |
transmit the informational object
The derived informational object knows how it needs to be transmitted. Does it need to be sent as html? As text? As something else?
transmitter | The type of transmitter to use to transmit the info |
dhi | information to help with the transmission |
Implements BESInfo.
Definition at line 103 of file BESVersionInfo.h.