bes  Updated for version 3.17.4
BESHelpResponseHandler Class Reference

response handler that returns help information about the server and currently loaded modules. More...

#include <BESHelpResponseHandler.h>

Inheritance diagram for BESHelpResponseHandler:
Inheritance graph

Public Member Functions

 BESHelpResponseHandler (const string &name)
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
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. 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...
 

Static Public Member Functions

static BESResponseHandlerHelpResponseBuilder (const string &name)
 

Protected Attributes

BESResponseObject_response
 
string _response_name
 

Detailed Description

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.

See also
BESResponseObject
BESContainer
BESTransmitter

Definition at line 52 of file BESHelpResponseHandler.h.

Member Function Documentation

◆ dump()

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

Displays the pointer value of this instance

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

Reimplemented from BESResponseHandler.

Definition at line 125 of file BESHelpResponseHandler.cc.

References BESResponseHandler::dump().

◆ execute()

void BESHelpResponseHandler::execute ( BESDataHandlerInterface dhi)
virtual

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.

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

Implements BESResponseHandler.

Definition at line 70 of file BESHelpResponseHandler.cc.

References BESInfo::add_data_from_file(), BESInfo::begin_response(), and BESRequestHandlerList::execute_all().

◆ get_name()

virtual string BESResponseHandler::get_name ( ) const
inlinevirtualinherited

This name is used to determine which response handler can handle a requested response, such as das, dds, ddx, tab, info, version, help, etc...

Returns
response name

Definition at line 156 of file BESResponseHandler.h.

References BESResponseHandler::dump().

◆ get_response_object()

BESResponseObject * BESResponseHandler::get_response_object ( )
virtualinherited

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.

◆ set_response_object()

BESResponseObject * BESResponseHandler::set_response_object ( BESResponseObject o)
virtualinherited

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.

◆ transmit()

void BESHelpResponseHandler::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface dhi 
)
virtual

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.

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

Implements BESResponseHandler.

Definition at line 106 of file BESHelpResponseHandler.cc.

References BESInfo::transmit().


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