BESVersionResponseHandler Class Reference

response handler that returns the version of the BES and the version of any data request handlers registered with the server. More...

#include <BESVersionResponseHandler.h>

Inheritance diagram for BESVersionResponseHandler:

Collaboration diagram for BESVersionResponseHandler:

Public Member Functions
	BESVersionResponseHandler (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 version;' by returning the version of the BES and the version of all registered data request handlers.
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 *	VersionResponseBuilder (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 the version of the BES and the version of any data request handlers registered with the server.

A request 'show version;' will be handled by this response handler. It returns the version of the BES and the version of any data request handlers registered with the server.

See also

BESResponseObject

BESRequestHandler

BESContainer

BESTransmitter

Definition at line 50 of file BESVersionResponseHandler.h.

Constructor & Destructor Documentation

BESVersionResponseHandler()

BESVersionResponseHandler::BESVersionResponseHandler

(

const std::string &

name

)

Definition at line 51 of file BESVersionResponseHandler.cc.

~BESVersionResponseHandler()

BESVersionResponseHandler::~BESVersionResponseHandler ( void )

virtual

Definition at line 56 of file BESVersionResponseHandler.cc.

Member Function Documentation

dump()

void BESVersionResponseHandler::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

Reimplemented from BESResponseHandler.

Definition at line 128 of file BESVersionResponseHandler.cc.

execute()

void BESVersionResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

executes the command 'show version;' by returning the version of the BES and the version of all registered data request handlers.

This response handler knows how to retrieve the version of the BES server. It adds this information to a BESVersionInfo informational response object. It also forwards the request to all registered data request handlers to add their version information.

Parameters

dhi	structure that holds request and response information

See also

BESDataHandlerInterface

BESVersionInfo

BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 74 of file BESVersionResponseHandler.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.

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 BESVersionResponseHandler::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 using the specified transmitter object.

Parameters

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

See also

BESResponseObject

BESTransmitter

BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 113 of file BESVersionResponseHandler.cc.

VersionResponseBuilder()

BESResponseHandler * BESVersionResponseHandler::VersionResponseBuilder ( const std::string & name )

static

Definition at line 137 of file BESVersionResponseHandler.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:

• BESVersionResponseHandler.h
• BESVersionResponseHandler.cc