bes
Updated for version 3.17.4
|
response handler that returns the list of keys defined in the BES initialization file. More...
#include <BESConfigResponseHandler.h>
Public Member Functions | |
BESConfigResponseHandler (const string &name) | |
virtual void | dump (ostream &strm) const |
dumps information about this object More... | |
virtual void | execute (BESDataHandlerInterface &dhi) |
executes the command 'show keys;' by returning the list of all key/value pairs defined in the BES initialization file. More... | |
virtual string | get_name () const |
return the name of this response object More... | |
virtual BESResponseObject * | get_response_object () |
return the current response object More... | |
virtual BESResponseObject * | set_response_object (BESResponseObject *o) |
replaces the current response object with the specified one, returning the current response object More... | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the response object built by the execute command using the specified transmitter object More... | |
Static Public Member Functions | |
static BESResponseHandler * | ConfigResponseBuilder (const string &handler_name) |
Protected Attributes | |
BESResponseObject * | _response |
string | _response_name |
A request 'show keys;' will be handled by this response handler. It returns the list of all key/value pairs currently defined in the BES initialization file and transmits the response as an informational response.
Definition at line 49 of file BESConfigResponseHandler.h.
|
virtual |
Displays the pointer value of this instance
strm | C++ i/o stream to dump the information to |
Reimplemented from BESResponseHandler.
Definition at line 125 of file BESConfigResponseHandler.cc.
References BESResponseHandler::dump().
|
virtual |
This response handler knows how to retrieve the list of keys retrieved from the BES initialization file and stored in TheBESKeys. A BESInfo informational response object is built to hold all of the key/value pairs.
The information is returned, one key per line, like:
key: "<key_name>", value: "<key_value>"
dhi | structure that holds request and response information |
Implements BESResponseHandler.
Definition at line 65 of file BESConfigResponseHandler.cc.
References BESInfo::begin_response(), and TheBESKeys::TheKeys().
|
inlinevirtualinherited |
This name is used to determine which response handler can handle a requested response, such as das, dds, ddx, tab, info, version, help, etc...
Definition at line 156 of file BESResponseHandler.h.
References BESResponseHandler::dump().
|
virtualinherited |
Returns the current response object, null if one has not yet been created. The response handler maintains ownership of the response object.
Definition at line 53 of file BESResponseHandler.cc.
|
virtualinherited |
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 |
Definition at line 59 of file BESResponseHandler.cc.
|
virtual |
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.
Definition at line 106 of file BESConfigResponseHandler.cc.
References BESInfo::transmit().