#include <BESHelpResponseHandler.h>
Inheritance diagram for BESHelpResponseHandler:
Public Member Functions | |
BESHelpResponseHandler (string name) | |
virtual | ~BESHelpResponseHandler (void) |
virtual void | execute (BESDataHandlerInterface &dhi) |
executes the command 'show help;' by returning general help information as well as help information for all of the data request handlers registered. | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the response object built by the execute command using the specified transmitter object | |
virtual void | dump (ostream &strm) const |
dumps information about this 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 const string & | get_name () const |
return the name of this response object | |
Static Public Member Functions | |
static BESResponseHandler * | HelpResponseBuilder (string handler_name) |
Protected Attributes | |
string | _response_name |
BESResponseObject * | _response |
A request 'show help;' will be handled by this response handler. It returns general help information as well as help information for all of the different types of data handled by this server. The list of request handlers (data handlers) registered with the server are listed along with the responses those handlers can handle. Each of those request handlers are given the chance to provide further help.
|
|
|
|
|
dumps information about this object Displays the pointer value of this instance
Reimplemented from BESResponseHandler. |
|
executes the command 'show help;' by returning general help information as well as help information for all of the data request handlers registered. The BESHelpResponseHandler first retreives general help information from help files located in the file pointed to by either the key BES.Help.TXT if the client is a basic text client or BES.Help.HTTP if the client is HTML based. It then lists each of the data types registered to handle requests (such as NetCDF, HDF, Cedar, etc...). Then for all data request handlers registered with BESRequestHandlerList help information can be added to the informational object. The response object BESHTMLInfo is created to store the help information.
Implements BESResponseHandler. |
|
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 response object built by the execute command using the specified transmitter object If a response object was built then transmit it as text or html, depending on whether the client making the request can handle HTML information.
Implements BESResponseHandler. |
|
|
|
|