#include <BESVersionResponseHandler.h>
Inheritance diagram for BESVersionResponseHandler:
Public Member Functions | |
BESVersionResponseHandler (const string &name) | |
virtual | ~BESVersionResponseHandler (void) |
virtual void | execute (BESDataHandlerInterface &dhi) |
executes the command 'show version;' by returning the version of the BES and the version of all registered data request handlers. | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the response object built by the execute command using the specified transmitter object | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual BESResponseObject * | get_response_object () |
return the current response object | |
virtual BESResponseObject * | set_response_object (BESResponseObject *o) |
replaces the current response object with the specified one, returning the current response object | |
virtual string | get_name () const |
return the name of this response object | |
Static Public Member Functions | |
static BESResponseHandler * | VersionResponseBuilder (const string &name) |
Protected Attributes | |
string | _response_name |
BESResponseObject * | _response |
A request 'show version;' will be handled by this response handler. It returns the version of the BES and the version of any data request handlers registered with the server.
BESVersionResponseHandler::BESVersionResponseHandler | ( | const string & | name | ) |
BESVersionResponseHandler::~BESVersionResponseHandler | ( | void | ) | [virtual] |
void BESVersionResponseHandler::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 BESResponseHandler.
void BESVersionResponseHandler::execute | ( | BESDataHandlerInterface & | dhi | ) | [virtual] |
executes the command 'show version;' by returning the version of the BES and the version of all registered data request handlers.
This response handler knows how to retrieve the version of the BES server. It adds this information to a BESVersionInfo informational response object. It also forwards the request to all registered data request handlers to add their version information.
dhi | structure that holds request and response information |
Implements BESResponseHandler.
virtual string BESResponseHandler::get_name | ( | ) | const [inline, virtual, inherited] |
return the name of this response object
This name is used to determine which response handler can handle a requested responose, such as das, dds, ddx, tab, info, version, help, etc...
BESResponseObject * BESResponseHandler::get_response_object | ( | ) | [virtual, inherited] |
return the current response object
Returns the current response object, null if one has not yet been created. The response handler maintains ownership of the response object.
BESResponseObject * BESResponseHandler::set_response_object | ( | BESResponseObject * | o | ) | [virtual, inherited] |
replaces the current response object with the specified one, returning the current response object
This method is used to replace the response object with a new one, for example if during aggregation a new response object is built from the current response object.
The caller of set_response_object now owns the returned response object. The new response object is now owned by the response object.
o | new response object used to replace the current one |
void BESVersionResponseHandler::transmit | ( | BESTransmitter * | transmitter, | |
BESDataHandlerInterface & | dhi | |||
) | [virtual] |
transmit the response object built by the execute command using the specified transmitter object
If a response object was built then transmit it as text using the specified transmitter object.
transmitter | object that knows how to transmit specific basic types | |
dhi | structure that holds the request and response information |
Implements BESResponseHandler.
BESResponseHandler * BESVersionResponseHandler::VersionResponseBuilder | ( | const string & | name | ) | [static] |
BESResponseObject* BESResponseHandler::_response [protected, inherited] |
string BESResponseHandler::_response_name [protected, inherited] |