bes  Updated for version 3.17.4
SampleSayResponseHandler Class Reference
Inheritance diagram for SampleSayResponseHandler:
Inheritance graph

Public Member Functions

virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual void execute (BESDataHandlerInterface &dhi)
 knows how to build a requested response object More...
 
virtual string get_name () const
 return the name of this response object More...
 
virtual BESResponseObjectget_response_object ()
 return the current response object More...
 
 SampleSayResponseHandler (const string &name)
 
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 BESResponseHandlerSampleSayResponseBuilder (const string &name)
 

Protected Attributes

BESResponseObject_response
 
string _response_name
 

Detailed Description

Definition at line 38 of file SampleSayResponseHandler.h.

Member Function Documentation

◆ dump()

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

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

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

Reimplemented from BESResponseHandler.

Definition at line 77 of file SampleSayResponseHandler.cc.

References BESResponseHandler::dump().

◆ execute()

void SampleSayResponseHandler::execute ( BESDataHandlerInterface dhi)
virtual

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
dhistructure that holds request and response information
Exceptions
BESHandlerExceptionif there is a problem building the response object
BESResponseExceptionupon fatal error building the response object
See also
BESDataHandlerInterface
BESResponseObject

Implements BESResponseHandler.

Definition at line 48 of file SampleSayResponseHandler.cc.

References BESInfo::begin_response(), and BESDataHandlerInterface::data.

◆ 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.

◆ 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 SampleSayResponseHandler::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface dhi 
)
virtual
Parameters
transmitterobject that knows how to transmit specific basic types
dhistructure that holds the request and response information
Exceptions
BESTransmitExceptionif problem transmitting the response obj
See also
BESResponseObject
BESTransmitter
BESDataHandlerInterface
BESTransmitException

Implements BESResponseHandler.

Definition at line 63 of file SampleSayResponseHandler.cc.

References BESInfo::transmit().


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