silent informational response object More...
#include <BESSilentInfo.h>
Public Member Functions | |
virtual void | add_break (unsigned long num_breaks) |
add a line break to the information | |
virtual void | add_data (const string &s) |
add data to the inforamtional object | |
virtual void | add_data_from_file (const string &key, const string &name) |
ignore data from a file to the informational object. | |
virtual void | add_exception (BESError &e, const string &admin) |
ignore exception data to this informational object. | |
virtual void | add_space (unsigned long num_spaces) |
add a space to the informational response | |
virtual void | add_tag (const string &tag_name, const string &tag_data, map< string, string > *attrs=0) |
add tagged information to the inforamtional response | |
virtual void | begin_response (const string &response_name, BESDataHandlerInterface &dhi) |
begin the informational response | |
virtual void | begin_tag (const string &tag_name, map< string, string > *attrs=0) |
begin a tagged part of the information, information to follow | |
BESSilentInfo () | |
constructs an informational object that doesn't write any output to the stream | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual void | end_response () |
virtual void | end_tag (const string &tag_name) |
end a tagged part of the informational response | |
virtual bool | is_buffered () |
return whether the information is to be buffered or not. | |
virtual void | print (ostream &strm) |
printg this informational object | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit this informational object | |
virtual | ~BESSilentInfo () |
Protected Attributes | |
bool | _buffered |
string | _response_name |
bool | _response_started |
ostream * | _strm |
bool | _strm_owned |
stack< string > | _tags |
silent informational response object
This class ignores any data added to an informational object and ignores the print command. Basically, it is silent!
Definition at line 49 of file BESSilentInfo.h.
BESSilentInfo::BESSilentInfo | ( | ) |
constructs an informational object that doesn't write any output to the stream
Definition at line 38 of file BESSilentInfo.cc.
BESSilentInfo::~BESSilentInfo | ( | ) | [virtual] |
Definition at line 43 of file BESSilentInfo.cc.
void BESSilentInfo::add_break | ( | unsigned long | num_breaks | ) | [virtual] |
add a line break to the information
because this is a silent response, nothing is added
num_breaks | number of breaks to be added |
Implements BESInfo.
Definition at line 127 of file BESSilentInfo.cc.
void BESSilentInfo::add_data | ( | const string & | s | ) | [virtual] |
add data to the inforamtional object
because this is a silent response, nothing is added
s | information to be ignored |
Reimplemented from BESInfo.
Definition at line 105 of file BESSilentInfo.cc.
void BESSilentInfo::add_data_from_file | ( | const string & | key, | |
const string & | name | |||
) | [virtual] |
ignore data from a file to the informational object.
key | Key from the initialization file specifying the file to be | |
name | naem information to add to error messages loaded. |
Reimplemented from BESInfo.
Definition at line 138 of file BESSilentInfo.cc.
void BESSilentInfo::add_exception | ( | BESError & | e, | |
const string & | admin | |||
) | [virtual] |
ignore exception data to this informational object.
If buffering is not set then the information is output directly to the output stream.
e | the exception to be added to this informational object | |
admin | The contact information for the person responsible for this error |
Reimplemented from BESInfo.
Definition at line 151 of file BESSilentInfo.cc.
void BESSilentInfo::add_space | ( | unsigned long | num_spaces | ) | [virtual] |
add a space to the informational response
because this is a silent response, nothing is added
num_spaces | number of spaces to add |
Implements BESInfo.
Definition at line 116 of file BESSilentInfo.cc.
void BESSilentInfo::add_tag | ( | const string & | tag_name, | |
const string & | tag_data, | |||
map< string, string > * | attrs = 0 | |||
) | [virtual] |
add tagged information to the inforamtional response
tag_name | name of the tag to add to the infroamtional response | |
tag_data | information describing the tag | |
attrs | map of attributes to add to the tag |
Implements BESInfo.
Definition at line 68 of file BESSilentInfo.cc.
void BESSilentInfo::begin_response | ( | const string & | response_name, | |
BESDataHandlerInterface & | dhi | |||
) | [virtual] |
begin the informational response
Because this is silent, there is nothing to do
response_name | name of the response represented by the information | |
dhi | information about the request and response |
Reimplemented from BESInfo.
Definition at line 55 of file BESSilentInfo.cc.
void BESSilentInfo::begin_tag | ( | const string & | tag_name, | |
map< string, string > * | attrs = 0 | |||
) | [virtual] |
begin a tagged part of the information, information to follow
tag_name | name of the tag to begin | |
attrs | map of attributes to begin the tag with |
Reimplemented from BESInfo.
Definition at line 80 of file BESSilentInfo.cc.
void BESSilentInfo::dump | ( | ostream & | strm | ) | const [virtual] |
dumps information about this object
Displays the pointer value of this instance
strm | C++ i/o stream to dump the information to |
Reimplemented from BESInfo.
Definition at line 186 of file BESSilentInfo.cc.
References BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
void BESInfo::end_response | ( | ) | [virtual, inherited] |
Reimplemented in BESHTMLInfo, BESVersionInfo, and BESXMLInfo.
Definition at line 131 of file BESInfo.cc.
References BESInfo::_response_started, and BESInfo::_tags.
Referenced by BESVersionInfo::end_response(), BESStatusResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESServicesResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESHelpResponseHandler::execute(), BESConfigResponseHandler::execute(), BESCatalogResponseHandler::execute(), and BESExceptionManager::handle_exception().
void BESSilentInfo::end_tag | ( | const string & | tag_name | ) | [virtual] |
end a tagged part of the informational response
If the named tag is not the current tag then an error is thrown.
tag_name | name of the tag to end |
Reimplemented from BESInfo.
Definition at line 93 of file BESSilentInfo.cc.
virtual bool BESInfo::is_buffered | ( | ) | [inline, virtual, inherited] |
return whether the information is to be buffered or not.
Definition at line 123 of file BESInfo.h.
References BESInfo::_buffered.
Referenced by BESBasicTransmitter::send_html(), BESBasicHttpTransmitter::send_html(), BESBasicTransmitter::send_text(), and BESBasicHttpTransmitter::send_text().
void BESSilentInfo::print | ( | ostream & | strm | ) | [virtual] |
printg this informational object
Nothing is to be printed as this is a silent object
strm | stream to send output to if not ignored. |
Reimplemented from BESInfo.
Definition at line 175 of file BESSilentInfo.cc.
void BESSilentInfo::transmit | ( | BESTransmitter * | transmitter, | |
BESDataHandlerInterface & | dhi | |||
) | [virtual] |
transmit this informational object
Nothing is to be transmotted as this is silent
transmitter | The type of transmitter to use to transmit the info | |
dhi | information to help with the transmission |
Implements BESInfo.
Definition at line 163 of file BESSilentInfo.cc.
bool BESInfo::_buffered [protected, inherited] |
Definition at line 73 of file BESInfo.h.
Referenced by BESTextInfo::add_data(), BESHTMLInfo::add_data(), BESInfo::BESInfo(), BESInfo::dump(), BESInfo::is_buffered(), and BESInfo::print().
string BESInfo::_response_name [protected, inherited] |
Definition at line 77 of file BESInfo.h.
Referenced by BESXMLInfo::add_tag(), BESXMLInfo::begin_response(), BESInfo::begin_response(), BESXMLInfo::begin_tag(), BESInfo::dump(), BESXMLInfo::end_response(), and BESXMLInfo::end_tag().
bool BESInfo::_response_started [protected, inherited] |
Definition at line 74 of file BESInfo.h.
Referenced by BESInfo::begin_response(), BESInfo::dump(), and BESInfo::end_response().
ostream* BESInfo::_strm [protected, inherited] |
Definition at line 71 of file BESInfo.h.
Referenced by BESTextInfo::add_data(), BESHTMLInfo::add_data(), BESInfo::BESInfo(), BESXMLInfo::end_tag(), BESInfo::print(), and BESInfo::~BESInfo().
bool BESInfo::_strm_owned [protected, inherited] |
Definition at line 72 of file BESInfo.h.
Referenced by BESInfo::BESInfo(), and BESInfo::~BESInfo().
stack<string> BESInfo::_tags [protected, inherited] |
Definition at line 76 of file BESInfo.h.
Referenced by BESInfo::begin_tag(), BESInfo::dump(), BESInfo::end_response(), and BESInfo::end_tag().