bes
Updated for version 3.17.0
|
#include <BESTextInfo.h>
Public Member Functions | |
virtual void | add_break (unsigned long num_breaks) |
add a line break to the information More... | |
virtual void | add_data (const string &s) |
add string data to the informational response More... | |
virtual void | add_data_from_file (const string &key, const string &name) |
add data from a file to the informational object More... | |
virtual void | add_exception (BESError &e, const string &admin) |
add exception information to this informational object More... | |
virtual void | add_space (unsigned long num_spaces) |
add a space to the informational response More... | |
virtual void | add_tag (const string &tag_name, const string &tag_data, map< string, string > *attrs=0) |
add tagged information to the inforamtional response More... | |
virtual void | begin_response (const string &response_name, BESDataHandlerInterface &dhi) |
begin the informational response More... | |
virtual void | begin_tag (const string &tag_name, map< string, string > *attrs=0) |
begin a tagged part of the information, information to follow More... | |
BESTextInfo (bool ishttp=false) | |
constructs a basic text information response object. More... | |
BESTextInfo (const string &key, ostream *strm, bool strm_owned, bool ishttp=false) | |
constructs a basic text information response object. More... | |
virtual void | dump (ostream &strm) const |
dumps information about this object More... | |
virtual void | end_response () |
virtual void | end_tag (const string &tag_name) |
end a tagged part of the informational response More... | |
virtual bool | is_buffered () |
return whether the information is to be buffered or not. More... | |
virtual void | print (ostream &strm) |
print the information from this informational object to the specified stream More... | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the text information as text More... | |
Static Public Member Functions | |
static BESInfo * | BuildTextInfo (const string &info_type) |
Protected Attributes | |
bool | _buffered |
string | _response_name |
bool | _response_started |
ostream * | _strm |
bool | _strm_owned |
stack< string > | _tags |
brief represents simple text information in a response object, such as version and help inforamtion.
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 BESTextInfo.h.
BESTextInfo::BESTextInfo | ( | bool | ishttp = false | ) |
Text informational objects can also be sent as html with an html header. We need to know this if the informationl is not buffered. If it isn't buffered then we need to send that text header.
Definition at line 50 of file BESTextInfo.cc.
BESTextInfo::BESTextInfo | ( | const string & | key, |
ostream * | strm, | ||
bool | strm_owned, | ||
bool | ishttp = false |
||
) |
Uses the default specified key in the bes configuration file to determine whether the information should be buffered or not.
Text informational objects can also be sent as html with an html header. We need to know this if the informationl is not buffered. If it isn't buffered then we need to send that text header.
key | parameter from BES configuration file |
strm | if not buffered then use the passed stream |
strm_owned | if strm created (not cout or cerr for example) then tells whether strm owned or not and can be deleted |
ishttp | tells whether this text information is html text and therefor requires the html header |
Definition at line 76 of file BESTextInfo.cc.
|
virtual |
num_breaks | the number of line breaks to add to the information |
Implements BESInfo.
Definition at line 201 of file BESTextInfo.cc.
References add_data().
|
virtual |
s | string data to add the informational response |
Reimplemented from BESInfo.
Definition at line 171 of file BESTextInfo.cc.
References BESInfo::add_data(), and BESUtil::set_mime_text().
|
virtual |
This method simply adds a .TXT to the end of the key and passes the request on up to the BESInfo parent class.
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 220 of file BESTextInfo.cc.
References BESInfo::add_data_from_file().
|
virtualinherited |
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 in BESVersionInfo, BESDapErrorInfo, and BESSilentInfo.
Definition at line 222 of file BESInfo.cc.
References BESError::get_error_type(), BESError::get_file(), BESError::get_line(), and BESError::get_message().
|
virtual |
num_spaces | the number of spaces to add to the information |
Implements BESInfo.
Definition at line 186 of file BESTextInfo.cc.
References add_data().
|
virtual |
tag_name | name of the tag to be added to the response |
tag_data | information describing the tag |
attrs | map of attributes to add to the tag |
Implements BESInfo.
Definition at line 109 of file BESTextInfo.cc.
References add_data().
|
virtual |
Because this is text informational object, no begin tags are needed
response_name | name of the response this information represents |
dhi | information about the request and response |
Reimplemented from BESInfo.
Definition at line 96 of file BESTextInfo.cc.
References BESInfo::begin_response().
|
virtual |
tag_name | name of the tag to begin |
attrs | map of attributes to begin the tag with |
Reimplemented from BESInfo.
Definition at line 133 of file BESTextInfo.cc.
References add_data().
|
virtual |
Displays the pointer value of this instance along with information about this text information object
strm | C++ i/o stream to dump the information to |
Reimplemented from BESInfo.
Definition at line 249 of file BESTextInfo.cc.
References BESTextInfo(), and BESInfo::dump().
|
virtual |
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 159 of file BESTextInfo.cc.
|
inlinevirtualinherited |
Definition at line 123 of file BESInfo.h.
References BESInfo::dump().
|
virtualinherited |
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 in BESVersionInfo, BESXMLInfo, BESDapErrorInfo, and BESSilentInfo.
Definition at line 249 of file BESInfo.cc.
|
virtual |
use the send_text method on the transmitter to transmit the information back to the client.
transmitter | The type of transmitter to use to transmit the info |
dhi | information to help with the transmission |
Implements BESInfo.
Definition at line 235 of file BESTextInfo.cc.