BESShowDefsResponseHandler Class Reference

response handler that returns list of definitions currently defined More...

#include <BESShowDefsResponseHandler.h>

Inheritance diagram for BESShowDefsResponseHandler:

Collaboration diagram for BESShowDefsResponseHandler:

Public Member Functions
	BESShowDefsResponseHandler (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 definitions;' by returning the list of currently defined definitions
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 *	ShowDefsResponseBuilder (const std::string &handler_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 list of definitions currently defined

A request 'show definitions;' will be handled by this response handler. It returns the list of currently defined definitions and transmits the response as an informational response object.

See also

BESResponseObject

BESContainer

BESTransmitter

BESInfo

Definition at line 49 of file BESShowDefsResponseHandler.h.

Constructor & Destructor Documentation

BESShowDefsResponseHandler()

BESShowDefsResponseHandler::BESShowDefsResponseHandler

(

const std::string &

name

)

Definition at line 43 of file BESShowDefsResponseHandler.cc.

~BESShowDefsResponseHandler()

BESShowDefsResponseHandler::~BESShowDefsResponseHandler ( void )

virtual

Definition at line 48 of file BESShowDefsResponseHandler.cc.

Member Function Documentation

dump()

void BESShowDefsResponseHandler::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 107 of file BESShowDefsResponseHandler.cc.

execute()

void BESShowDefsResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

executes the command 'show definitions;' by returning the list of currently defined definitions

This response handler knows how to retrieve the list of definitions currently defined in the server. It simply asks the definition list to show all definitions given the BESInfo object created here.

Parameters

dhi	structure that holds request and response information

See also

BESDataHandlerInterface

BESInfo

BESDefinitionStorageList

Implements BESResponseHandler.

Definition at line 65 of file BESShowDefsResponseHandler.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.

ShowDefsResponseBuilder()

BESResponseHandler * BESShowDefsResponseHandler::ShowDefsResponseBuilder ( const std::string & handler_name )

static

Definition at line 117 of file BESShowDefsResponseHandler.cc.

transmit()

void BESShowDefsResponseHandler::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.

Parameters

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

See also

BESInfo

BESTransmitter

BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 88 of file BESShowDefsResponseHandler.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:

• BESShowDefsResponseHandler.h
• BESShowDefsResponseHandler.cc