bes  Updated for version 3.17.4
BESShowDefsResponseHandler Class Reference

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

#include <BESShowDefsResponseHandler.h>

Inheritance diagram for BESShowDefsResponseHandler:
Inheritance graph

Public Member Functions

 BESShowDefsResponseHandler (const string &name)
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command 'show definitions;' by returning the list of currently defined definitions More...
 
virtual string get_name () const
 return the name of this response object More...
 
virtual BESResponseObjectget_response_object ()
 return the current response object More...
 
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 BESResponseHandlerShowDefsResponseBuilder (const string &handler_name)
 

Protected Attributes

BESResponseObject_response
 
string _response_name
 

Detailed Description

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.

Member Function Documentation

◆ dump()

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

Displays the pointer value of this instance

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

Reimplemented from BESResponseHandler.

Definition at line 103 of file BESShowDefsResponseHandler.cc.

References BESResponseHandler::dump().

◆ execute()

void BESShowDefsResponseHandler::execute ( BESDataHandlerInterface dhi)
virtual

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
dhistructure that holds request and response information
See also
BESDataHandlerInterface
BESInfo
BESDefinitionStorageList

Implements BESResponseHandler.

Definition at line 61 of file BESShowDefsResponseHandler.cc.

References BESInfo::begin_response(), and BESDefinitionStorageList::show_definitions().

◆ 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 BESShowDefsResponseHandler::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface dhi 
)
virtual

If a response object was built then transmit it as text using the specified transmitter.

Parameters
transmitterobject that knows how to transmit specific basic types
dhistructure that holds the request and response information
See also
BESInfo
BESTransmitter
BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 84 of file BESShowDefsResponseHandler.cc.

References BESInfo::transmit().


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