bes  Updated for version 3.20.6
BESDDSResponseHandler Class Reference

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

#include <BESDDSResponseHandler.h>

Collaboration diagram for BESDDSResponseHandler:
Collaboration graph

Public Member Functions

 BESDDSResponseHandler (const std::string &name)
 
virtual void dump (std::ostream &strm) const
 dumps information about this object More...
 
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command <get type="dds" definition=...> 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 BESResponseHandlerDDSResponseBuilder (const std::string &name)
 

Protected Attributes

std::string d_annotation_service_url
 
std::string d_response_name
 
BESResponseObjectd_response_object
 

Detailed Description

response handler that builds an OPeNDAP DDS response object

A request <get type="dds" definition=d1" [space="s"]> will be handled by this response handler. Given a definition name it determines what container is to be used to build the DAP2 DDS response object. It then transmits the DDS object using the method send_dds on a specified transmitter object.

This handler is registered with BESRequestHandlerList using the string get.dds as the key.

See also
DDS
BESContainer
BESTransmitter

Definition at line 54 of file BESDDSResponseHandler.h.

Member Function Documentation

◆ dump()

void BESDDSResponseHandler::dump ( std::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 186 of file BESDDSResponseHandler.cc.

◆ execute()

void BESDDSResponseHandler::execute ( BESDataHandlerInterface dhi)
virtual

executes the command <get type="dds" 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. The ResponseHandler now supports the Metadata store, so cached/stored DDS responses will be used if found there and if the MDS is configured in the bes.conf file.

Note
This ResponseHandler does not work for multiple containers when using the Global Metadata Store.
Parameters
dhistructure that holds request and response information
See also
BESDataHandlerInterface
BESDDSResponse
BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 95 of file BESDDSResponseHandler.cc.

◆ 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 82 of file BESResponseHandler.cc.

◆ 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 88 of file BESResponseHandler.cc.

◆ 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 173 of file BESDDSResponseHandler.cc.


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