#include <BESShowDefsResponseHandler.h>
Inheritance diagram for BESShowDefsResponseHandler:
Public Member Functions | |
BESShowDefsResponseHandler (const string &name) | |
virtual | ~BESShowDefsResponseHandler (void) |
virtual void | execute (BESDataHandlerInterface &dhi) |
executes the command 'show definitions;' by returning the list of currently defined definitions | |
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 * | ShowDefsResponseBuilder (const string &handler_name) |
Protected Attributes | |
string | _response_name |
BESResponseObject * | _response |
A request 'show definitions;' will be handled by this response handler. It returns the list of currently defined definitions and transmits the response as an informational response object.
Definition at line 49 of file BESShowDefsResponseHandler.h.
BESShowDefsResponseHandler::BESShowDefsResponseHandler | ( | const string & | name | ) |
Definition at line 39 of file BESShowDefsResponseHandler.cc.
Referenced by ShowDefsResponseBuilder().
BESShowDefsResponseHandler::~BESShowDefsResponseHandler | ( | void | ) | [virtual] |
Definition at line 44 of file BESShowDefsResponseHandler.cc.
void BESShowDefsResponseHandler::execute | ( | BESDataHandlerInterface & | dhi | ) | [virtual] |
executes the command 'show definitions;' by returning the list of currently defined definitions
This response handler knows how to retrieve the list of definitions currently defined in the server. It simply asks the definition list to show all definitions given the BESInfo object created here.
dhi | structure that holds request and response information |
Implements BESResponseHandler.
Definition at line 61 of file BESShowDefsResponseHandler.cc.
References BESResponseHandler::_response, _BESDataHandlerInterface::action_name, BESInfo::begin_response(), BESInfoList::build_info(), BESInfo::end_response(), BESDefinitionStorageList::show_definitions(), SHOWDEFS_RESPONSE_STR, BESDefinitionStorageList::TheList(), and BESInfoList::TheList().
Here is the call graph for this function:
void BESShowDefsResponseHandler::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.
transmitter | object that knows how to transmit specific basic types | |
dhi | structure that holds the request and response information |
Implements BESResponseHandler.
Definition at line 84 of file BESShowDefsResponseHandler.cc.
References BESResponseHandler::_response, and BESInfo::transmit().
Here is the call graph for this function:
void BESShowDefsResponseHandler::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.
Definition at line 101 of file BESShowDefsResponseHandler.cc.
References BESResponseHandler::dump(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
Here is the call graph for this function:
BESResponseHandler * BESShowDefsResponseHandler::ShowDefsResponseBuilder | ( | const string & | handler_name | ) | [static] |
Definition at line 111 of file BESShowDefsResponseHandler.cc.
References BESShowDefsResponseHandler().
Referenced by BESDefaultModule::initialize().
Here is the call graph for this function:
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.
Definition at line 53 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
Referenced by BESDapRequestHandler::dap_build_help(), and BESDapRequestHandler::dap_build_version().
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 |
Definition at line 59 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
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...
Definition at line 156 of file BESResponseHandler.h.
References BESResponseHandler::_response_name.
string BESResponseHandler::_response_name [protected, inherited] |
Definition at line 84 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESDDXResponseHandler::execute(), and BESResponseHandler::get_name().
BESResponseObject* BESResponseHandler::_response [protected, inherited] |
Definition at line 85 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESVersionResponseHandler::execute(), BESStreamResponseHandler::execute(), BESStatusResponseHandler::execute(), execute(), BESShowContextResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESDDXResponseHandler::execute(), BESDDSResponseHandler::execute(), BESDataResponseHandler::execute(), BESDASResponseHandler::execute(), BESConfigResponseHandler::execute(), BESCatalogResponseHandler::execute(), BESResponseHandler::get_response_object(), BESResponseHandler::set_response_object(), BESVersionResponseHandler::transmit(), BESStatusResponseHandler::transmit(), transmit(), BESShowContextResponseHandler::transmit(), BESShowContainersResponseHandler::transmit(), BESSetContextResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().