#include <SampleSayResponseHandler.h>
Public Member Functions | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual void | execute (BESDataHandlerInterface &dhi) |
knows how to build a requested response object | |
virtual string | get_name () const |
return the name of this response object | |
virtual BESResponseObject * | get_response_object () |
return the current response object | |
SampleSayResponseHandler (const string &name) | |
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 respobse object built by the execute command using the specified transmitter object | |
virtual | ~SampleSayResponseHandler (void) |
Static Public Member Functions | |
static BESResponseHandler * | SampleSayResponseBuilder (const string &name) |
Protected Attributes | |
BESResponseObject * | _response |
string | _response_name |
Definition at line 38 of file SampleSayResponseHandler.h.
SampleSayResponseHandler::SampleSayResponseHandler | ( | const string & | name | ) |
Definition at line 38 of file SampleSayResponseHandler.cc.
Referenced by SampleSayResponseBuilder().
SampleSayResponseHandler::~SampleSayResponseHandler | ( | void | ) | [virtual] |
Definition at line 43 of file SampleSayResponseHandler.cc.
void SampleSayResponseHandler::dump | ( | ostream & | strm | ) | const [virtual] |
dumps information about this object
Displays the pointer value of this instance along with the name of this response handler and, if present, dumps the response object itself.
strm | C++ i/o stream to dump the information to |
Reimplemented from BESResponseHandler.
Definition at line 77 of file SampleSayResponseHandler.cc.
References BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
void SampleSayResponseHandler::execute | ( | BESDataHandlerInterface & | dhi | ) | [virtual] |
knows how to build a requested response object
Derived instances of this abstract base class know how to create a specific response object and what objects (including itself) to pass that response object to for it to be filled in.
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.
Definition at line 48 of file SampleSayResponseHandler.cc.
References BESResponseHandler::_response, BESInfo::add_tag(), BESInfo::begin_response(), BESInfoList::build_info(), BESDataHandlerInterface::data, BESInfo::end_response(), SAY_RESPONSE, SAY_TO, SAY_WHAT, 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 CSVRequestHandler::csv_build_das(), CSVRequestHandler::csv_build_data(), CSVRequestHandler::csv_build_dds(), CSVRequestHandler::csv_build_help(), CSVRequestHandler::csv_build_vers(), BESDapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_version(), BESDataHandlerInterface::get_response_object(), SampleRequestHandler::sample_build_help(), and SampleRequestHandler::sample_build_vers().
BESResponseHandler * SampleSayResponseHandler::SampleSayResponseBuilder | ( | const string & | name | ) | [static] |
Definition at line 87 of file SampleSayResponseHandler.cc.
References SampleSayResponseHandler().
Referenced by SampleModule::initialize().
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.
void SampleSayResponseHandler::transmit | ( | BESTransmitter * | transmitter, | |
BESDataHandlerInterface & | dhi | |||
) | [virtual] |
transmit the respobse object built by the execute command using the specified transmitter object
transmitter | object that knows how to transmit specific basic types | |
dhi | structure that holds the request and response information |
BESTransmitException | if problem transmitting the response obj |
Implements BESResponseHandler.
Definition at line 63 of file SampleSayResponseHandler.cc.
References BESResponseHandler::_response, and BESInfo::transmit().
BESResponseObject* BESResponseHandler::_response [protected, inherited] |
Definition at line 85 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), execute(), BESVersionResponseHandler::execute(), BESStreamResponseHandler::execute(), BESStatusResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESServicesResponseHandler::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(), transmit(), BESVersionResponseHandler::transmit(), BESStatusResponseHandler::transmit(), BESShowDefsResponseHandler::transmit(), BESShowContextResponseHandler::transmit(), BESShowContainersResponseHandler::transmit(), BESSetContextResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESServicesResponseHandler::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().
string BESResponseHandler::_response_name [protected, inherited] |
Definition at line 84 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESDDXResponseHandler::execute(), and BESResponseHandler::get_name().