bes  Updated for version 3.17.4
BESConfigResponseHandler Class Reference

response handler that returns the list of keys defined in the BES initialization file. More...

#include <BESConfigResponseHandler.h>

Inheritance diagram for BESConfigResponseHandler:
Inheritance graph

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 BESResponseObjectget_response_object ()
 return the current response object More...
 
virtual BESResponseObjectset_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 BESResponseHandlerConfigResponseBuilder (const string &handler_name)
 

Protected Attributes

BESResponseObject_response
 
string _response_name
 

Detailed Description

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.

See also
BESResponseObject
BESContainer
BESTransmitter

Definition at line 49 of file BESConfigResponseHandler.h.

Member Function Documentation

◆ dump()

void BESConfigResponseHandler::dump ( ostream &  strm) const
virtual

Displays the pointer value of this instance

Parameters
strmC++ i/o stream to dump the information to

Reimplemented from BESResponseHandler.

Definition at line 125 of file BESConfigResponseHandler.cc.

References BESResponseHandler::dump().

◆ execute()

void BESConfigResponseHandler::execute ( BESDataHandlerInterface dhi)
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: "&lt;key_name&gt;", value: "&lt;key_value&gt"

Parameters
dhistructure that holds request and response information
See also
BESDataHandlerInterface
BESInfo
TheBESKeys

Implements BESResponseHandler.

Definition at line 65 of file BESConfigResponseHandler.cc.

References BESInfo::begin_response(), and TheBESKeys::TheKeys().

◆ get_name()

virtual string BESResponseHandler::get_name ( ) const
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...

Returns
response name

Definition at line 156 of file BESResponseHandler.h.

◆ get_response_object()

BESResponseObject * BESResponseHandler::get_response_object ( )
virtualinherited

Returns the current response object, null if one has not yet been created. The response handler maintains ownership of the response object.

Returns
current response object
See also
BESResponseObject

Definition at line 53 of file BESResponseHandler.cc.

◆ set_response_object()

BESResponseObject * BESResponseHandler::set_response_object ( BESResponseObject o)
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.

Parameters
onew response object used to replace the current one
Returns
the response object being replaced
See also
BESResponseObject

Definition at line 59 of file BESResponseHandler.cc.

◆ transmit()

void BESConfigResponseHandler::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface dhi 
)
virtual

If a response object was built then transmit it as text using the specified transmitter object.

Parameters
transmitterobject that knows how to transmit specific basic types
dhistructure that holds the request and response information
See also
BESInfo
BESTransmitter
BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 106 of file BESConfigResponseHandler.cc.

References BESInfo::transmit().


The documentation for this class was generated from the following files: