#include <BESResponseHandler.h>
Inheritance diagram for BESResponseHandler:
Public Member Functions | |
virtual | ~BESResponseHandler (void) |
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 | execute (BESDataHandlerInterface &dhi)=0 |
knows how to build a requested response object | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)=0 |
transmit the respobse object built by the execute command using the specified transmitter object | |
virtual const string & | get_name () const |
return the name of this response object | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
Protected Member Functions | |
BESResponseHandler (string name) | |
Protected Attributes | |
string | _response_name |
BESResponseObject * | _response |
A response handler is something that knows how to create a response object, such as a DAS, DDS, DDX, informational response object. It knows how to construct the requested response object but does not necessarily fill in the response object. It does know, however, how to have other objects fill in the response object. For example, a BESDASResponseHandler knows that it needs to go to each of the request handlers (data handlers) for each of the containers requested so that those request handlers can fill in the response object. Another example is the BESHelpResponseHandler, which knows to construct an informational response object and then pass that informational response object to each registered request handler (data handler) so that each of the request handlers has an opportunity to add any help information it needs to add.
Response handlers such as the BESStatusResponseHandler (and others) are able to create the informational response object and fill it in without handing off the response object to any other object. But usually, the response handler passes the response object to another object to have it fill in the response object.
A response handler object also knows how to transmit the response object using a BESTransmitter object.
This is an abstract base class for response handlers. Derived classes implement the methods execute and transmit.
|
|
|
|
|
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.
Implements BESObj. Reimplemented in BESCatalogResponseHandler, BESDASResponseHandler, BESDataResponseHandler, BESDDSResponseHandler, BESDDXResponseHandler, BESDefineResponseHandler, BESDelContainerResponseHandler, BESDelContainersResponseHandler, BESDelDefResponseHandler, BESDelDefsResponseHandler, BESHelpResponseHandler, BESKeysResponseHandler, BESProcIdResponseHandler, BESSetContainerResponseHandler, BESSetContextResponseHandler, BESShowContainersResponseHandler, BESShowContextResponseHandler, BESShowDefsResponseHandler, BESStatusResponseHandler, BESStreamResponseHandler, BESVersionResponseHandler, TestEhmResponseHandler, TestSigResponseHandler, and OPENDAP_RESPONSEResponseHandler. |
|
|
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...
|
|
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.
|
|
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.
|
|
transmit the respobse object built by the execute command using the specified transmitter object
Implemented in BESCatalogResponseHandler, BESDASResponseHandler, BESDataResponseHandler, BESDDSResponseHandler, BESDDXResponseHandler, BESDefineResponseHandler, BESDelContainerResponseHandler, BESDelContainersResponseHandler, BESDelDefResponseHandler, BESDelDefsResponseHandler, BESHelpResponseHandler, BESKeysResponseHandler, BESProcIdResponseHandler, BESSetContainerResponseHandler, BESSetContextResponseHandler, BESShowContainersResponseHandler, BESShowContextResponseHandler, BESShowDefsResponseHandler, BESStatusResponseHandler, BESStreamResponseHandler, BESVersionResponseHandler, TestResponseHandler, TestEhmResponseHandler, TestSigResponseHandler, and OPENDAP_RESPONSEResponseHandler. |
|
|
|
|