OPeNDAP Hyrax Back End Server (BES)
Updated for version 3.8.3
|
response handler that returns the status of the server process serving the requesting client More...
#include <BESStatusResponseHandler.h>
Public Member Functions | |
BESStatusResponseHandler (const string &name) | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual void | execute (BESDataHandlerInterface &dhi) |
executes the command 'show status;' by returning the status of the server process | |
virtual string | get_name () const |
return the name of this response 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 void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the response object built by the execute command using the specified transmitter object | |
virtual | ~BESStatusResponseHandler (void) |
Static Public Member Functions | |
static BESResponseHandler * | StatusResponseBuilder (const string &name) |
Protected Attributes | |
BESResponseObject * | _response |
string | _response_name |
response handler that returns the status of the server process serving the requesting client
A request 'show status;' will be handled by this response handler. It returns the status of the server process handling the clients requests in an informational response object.
Definition at line 49 of file BESStatusResponseHandler.h.
BESStatusResponseHandler::BESStatusResponseHandler | ( | const string & | name | ) |
Definition at line 39 of file BESStatusResponseHandler.cc.
Referenced by StatusResponseBuilder().
BESStatusResponseHandler::~BESStatusResponseHandler | ( | void | ) | [virtual] |
Definition at line 44 of file BESStatusResponseHandler.cc.
void BESStatusResponseHandler::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 104 of file BESStatusResponseHandler.cc.
References BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
void BESStatusResponseHandler::execute | ( | BESDataHandlerInterface & | dhi | ) | [virtual] |
executes the command 'show status;' by returning the status of the server process
This response handler knows how to retrieve the status for the server process handing this clients requests from BESStatus and stores it in a BESInfo informational response object.
dhi | structure that holds request and response information |
Implements BESResponseHandler.
Definition at line 61 of file BESStatusResponseHandler.cc.
References BESResponseHandler::_response, BESDataHandlerInterface::action_name, BESInfo::add_tag(), BESInfo::begin_response(), BESInfoList::build_info(), BESInfo::end_response(), BESStatus::get_status(), STATUS_RESPONSE_STR, and BESInfoList::TheList().
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.
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(), BESDapRequestHandler::dap_build_version(), and BESDataHandlerInterface::get_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 |
Definition at line 59 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
BESResponseHandler * BESStatusResponseHandler::StatusResponseBuilder | ( | const string & | name | ) | [static] |
Definition at line 114 of file BESStatusResponseHandler.cc.
References BESStatusResponseHandler().
Referenced by BESDefaultModule::initialize().
void BESStatusResponseHandler::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.
Definition at line 85 of file BESStatusResponseHandler.cc.
References BESResponseHandler::_response, and BESInfo::transmit().
BESResponseObject* BESResponseHandler::_response [protected, inherited] |
Definition at line 85 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESStreamResponseHandler::execute(), BESServicesResponseHandler::execute(), BESProcIdResponseHandler::execute(), execute(), BESConfigResponseHandler::execute(), BESDDSResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESDataResponseHandler::execute(), BESDASResponseHandler::execute(), BESVersionResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESDataDDXResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESCatalogResponseHandler::execute(), BESHelpResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDDXResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESResponseHandler::get_response_object(), BESResponseHandler::set_response_object(), BESServicesResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), BESShowDefsResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESDDSResponseHandler::transmit(), transmit(), BESVersionResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESShowContextResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), BESShowContainersResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDataDDXResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESSetContextResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().
string BESResponseHandler::_response_name [protected, inherited] |
Definition at line 84 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESDataDDXResponseHandler::execute(), BESDDXResponseHandler::execute(), and BESResponseHandler::get_name().