BESHelpResponseHandler Class Reference

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

#include <BESHelpResponseHandler.h>

Inheritance diagram for BESHelpResponseHandler:

Collaboration diagram for BESHelpResponseHandler:

Public Member Functions
	BESHelpResponseHandler (const std::string &name)
virtual void	dump (std::ostream &strm) const
	dumps information about this object
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 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	transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
	transmit the response object built by the execute command using the specified transmitter object

Static Public Member Functions
static BESResponseHandler *	HelpResponseBuilder (const std::string &name)

Protected Attributes
std::string	d_annotation_service_url
std::string	d_response_name
BESResponseObject *	d_response_object = nullptr

Detailed Description

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

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.

Constructor & Destructor Documentation

BESHelpResponseHandler()

BESHelpResponseHandler::BESHelpResponseHandler

(

const std::string &

name

)

Definition at line 46 of file BESHelpResponseHandler.cc.

~BESHelpResponseHandler()

BESHelpResponseHandler::~BESHelpResponseHandler ( void )

virtual

Definition at line 51 of file BESHelpResponseHandler.cc.

Member Function Documentation

dump()

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

virtual

dumps information about this object

Displays the pointer value of this instance

Parameters

strm	C++ i/o stream to dump the information to

Implements BESObj.

Definition at line 130 of file BESHelpResponseHandler.cc.

execute()

void BESHelpResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

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.

Parameters

dhi	structure that holds request and response information

See also

BESDataHandlerInterface

BESHTMLInfo

BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 75 of file BESHelpResponseHandler.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 62 of file BESResponseHandler.cc.

HelpResponseBuilder()

BESResponseHandler * BESHelpResponseHandler::HelpResponseBuilder ( const std::string & name )

static

Definition at line 140 of file BESHelpResponseHandler.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

o	new response object used to replace the current one

Returns

the response object being replaced

See also

BESResponseObject

Definition at line 68 of file BESResponseHandler.cc.

transmit()

void BESHelpResponseHandler::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 as text or html, depending on whether the client making the request can handle HTML information.

Parameters

transmitter	object that knows how to transmit specific basic types
dhi	structure that holds the request and response information

See also

BESHTMLInfo

BESTransmitter

BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 111 of file BESHelpResponseHandler.cc.

Member Data Documentation

d_annotation_service_url

std::string BESResponseHandler::d_annotation_service_url

protectedinherited

Definition at line 82 of file BESResponseHandler.h.

d_response_name

std::string BESResponseHandler::d_response_name

protectedinherited

Definition at line 79 of file BESResponseHandler.h.

d_response_object

BESResponseObject* BESResponseHandler::d_response_object = nullptr

protectedinherited

Definition at line 80 of file BESResponseHandler.h.

---

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

• BESHelpResponseHandler.h
• BESHelpResponseHandler.cc