SampleSayResponseHandler Class Reference

Inheritance diagram for SampleSayResponseHandler:

Collaboration diagram for SampleSayResponseHandler:

Public Member Functions
virtual void	dump (std::ostream &strm) const
	dumps information about this object
virtual void	execute (BESDataHandlerInterface &dhi)
	knows how to build a requested response object
virtual BESResponseObject *	get_response_object ()
	return the current response object
	SampleSayResponseHandler (const std::string &name)
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 *	SampleSayResponseBuilder (const std::string &name)

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

Detailed Description

Definition at line 38 of file SampleSayResponseHandler.h.

Constructor & Destructor Documentation

SampleSayResponseHandler()

SampleSayResponseHandler::SampleSayResponseHandler

(

const std::string &

name

)

Definition at line 45 of file SampleSayResponseHandler.cc.

~SampleSayResponseHandler()

SampleSayResponseHandler::~SampleSayResponseHandler ( void )

virtual

Definition at line 50 of file SampleSayResponseHandler.cc.

Member Function Documentation

dump()

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

virtual

dumps information about this object

Displays the pointer value of this instance along with the name of this response handler and, if present, dumps the response object itself.

Parameters

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

Reimplemented from BESResponseHandler.

Definition at line 82 of file SampleSayResponseHandler.cc.

execute()

void SampleSayResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

knows how to build a requested response object

Derived instances of this abstract base class know how to create a specific response object and what objects (including itself) to pass that response object to for it to be filled in.

Parameters

dhi	structure that holds request and response information

Exceptions

BESHandlerException	if there is a problem building the response object
BESResponseException	upon fatal error building the response object

See also

BESDataHandlerInterface

BESResponseObject

Implements BESResponseHandler.

Definition at line 54 of file SampleSayResponseHandler.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.

SampleSayResponseBuilder()

BESResponseHandler * SampleSayResponseHandler::SampleSayResponseBuilder ( const std::string & name )

static

Definition at line 91 of file SampleSayResponseHandler.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 SampleSayResponseHandler::transmit ( BESTransmitter * transmitter, BESDataHandlerInterface & dhi )

virtual

transmit the response object built by the execute command 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

Exceptions

BESTransmitException

if problem transmitting the response obj

See also

BESResponseObject

BESTransmitter

BESDataHandlerInterface

BESTransmitException

Implements BESResponseHandler.

Definition at line 68 of file SampleSayResponseHandler.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:

• SampleSayResponseHandler.h
• SampleSayResponseHandler.cc