#include <BESShowContextResponseHandler.h>
Inheritance diagram for BESShowContextResponseHandler:
Public Member Functions | |
BESShowContextResponseHandler (const string &name) | |
virtual | ~BESShowContextResponseHandler (void) |
virtual void | execute (BESDataHandlerInterface &dhi) |
executes the command to list the current context in the BES | |
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 * | ShowContextResponseBuilder (const string &name) |
Protected Attributes | |
string | _response_name |
BESResponseObject * | _response |
This response handler list all context name/vallue pairs currently set within the system with the command:
show context;
The response is an informational object
BESShowContextResponseHandler::BESShowContextResponseHandler | ( | const string & | name | ) |
BESShowContextResponseHandler::~BESShowContextResponseHandler | ( | void | ) | [virtual] |
void BESShowContextResponseHandler::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 BESShowContextResponseHandler::execute | ( | BESDataHandlerInterface & | dhi | ) | [virtual] |
executes the command to list the current context in the BES
Context in the BES refers to name/value pairs set in the BES to help direct the operation of the BES. For example, there might be an error display context, an error context, a response context (make them all silent), a test run context (don't actually execute the commands, just go through the motions). This response handler knows how to retrieve the list of context name/value pairs.
dhi | structure that holds request and response information |
BESHandlerException | if there is a problem building the response object | |
BESResponseException | upon fatal error building the response object |
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 |
BESResponseHandler * BESShowContextResponseHandler::ShowContextResponseBuilder | ( | const string & | name | ) | [static] |
void BESShowContextResponseHandler::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.
BESResponseObject* BESResponseHandler::_response [protected, inherited] |
string BESResponseHandler::_response_name [protected, inherited] |