OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESDDSResponseHandler Class Reference

response handler that builds an OPeNDAP DDS response object More...

#include <BESDDSResponseHandler.h>

Inheritance diagram for BESDDSResponseHandler:
Inheritance graph
Collaboration diagram for BESDDSResponseHandler:
Collaboration graph

Public Member Functions

 BESDDSResponseHandler (const string &name)
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command 'get dds for <def_name>;' by executing the request for each container in the specified definition. 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...
 
virtual ~BESDDSResponseHandler (void)
 

Static Public Member Functions

static BESResponseHandlerDDSResponseBuilder (const string &name)
 

Protected Attributes

BESResponseObject_response
 
string _response_name
 

Detailed Description

response handler that builds an OPeNDAP DDS response object

A request 'get dds for <def_name>;' will be handled by this response handler. Given a definition name it determines what containers are to be used to build the OPeNDAP DDS response object. It then transmits the DDS object using the method send_dds on a specified transmitter object.

See also
DDS
BESContainer
BESTransmitter

Definition at line 50 of file BESDDSResponseHandler.h.

Constructor & Destructor Documentation

◆ BESDDSResponseHandler()

BESDDSResponseHandler::BESDDSResponseHandler ( const string &  name)

Definition at line 39 of file BESDDSResponseHandler.cc.

Referenced by DDSResponseBuilder().

◆ ~BESDDSResponseHandler()

BESDDSResponseHandler::~BESDDSResponseHandler ( void  )
virtual

Definition at line 44 of file BESDDSResponseHandler.cc.

Member Function Documentation

◆ DDSResponseBuilder()

BESResponseHandler * BESDDSResponseHandler::DDSResponseBuilder ( const string &  name)
static

Definition at line 111 of file BESDDSResponseHandler.cc.

References BESDDSResponseHandler().

Referenced by BESDapModule::initialize().

Here is the call graph for this function:

◆ dump()

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

dumps information about this object

Displays the pointer value of this instance

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

Reimplemented from BESResponseHandler.

Definition at line 101 of file BESDDSResponseHandler.cc.

References BESResponseHandler::dump(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Here is the call graph for this function:

◆ execute()

void BESDDSResponseHandler::execute ( BESDataHandlerInterface dhi)
virtual

executes the command 'get dds for <def_name>;' by executing the request for each container in the specified definition.

For each container in the specified definition go to the request handler for that container and have it add to the OPeNDAP DDS response object. The DDS response object is created within this method and passed to the request handler list.

Parameters
dhistructure that holds request and response information
See also
BESDataHandlerInterface
BESDDSResponse
BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 62 of file BESDDSResponseHandler.cc.

References BESResponseHandler::_response, BESDataHandlerInterface::action_name, DDS_RESPONSE_STR, BESRequestHandlerList::execute_each(), and BESRequestHandlerList::TheList().

Here is the call graph for this function:

◆ get_name()

virtual string BESResponseHandler::get_name ( ) const
inlinevirtualinherited

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...

Returns
response name

Definition at line 156 of file BESResponseHandler.h.

References BESResponseHandler::_response_name, and BESResponseHandler::dump().

Here is the call graph for this function:

◆ get_response_object()

BESResponseObject * BESResponseHandler::get_response_object ( )
virtualinherited

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.

Returns
current response object
See also
BESResponseObject

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().

◆ set_response_object()

BESResponseObject * BESResponseHandler::set_response_object ( BESResponseObject o)
virtualinherited

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.

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.

References BESResponseHandler::_response.

◆ transmit()

void BESDDSResponseHandler::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 using the send_dds method on the specified transmitter object.

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

Implements BESResponseHandler.

Definition at line 85 of file BESDDSResponseHandler.cc.

References BESResponseHandler::_response, DDS_SERVICE, and BESTransmitter::send_response().

Here is the call graph for this function:

Member Data Documentation

◆ _response

BESResponseObject* BESResponseHandler::_response
protectedinherited

Definition at line 85 of file BESResponseHandler.h.

Referenced by BESResponseHandler::dump(), BESStreamResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESServicesResponseHandler::execute(), BESConfigResponseHandler::execute(), execute(), BESShowDefsResponseHandler::execute(), BESStatusResponseHandler::execute(), BESDataResponseHandler::execute(), BESDASResponseHandler::execute(), BESVersionResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESCatalogResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDataDDXResponseHandler::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(), transmit(), BESStatusResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESShowDefsResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESVersionResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESShowContextResponseHandler::transmit(), BESShowContainersResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDataDDXResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESSetContextResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().

◆ _response_name

string BESResponseHandler::_response_name
protectedinherited

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