bes  Updated for version 3.17.0
BESProcIdResponseHandler Class Reference

response handler that returns the process id for the server process More...

#include <BESProcIdResponseHandler.h>

Inheritance diagram for BESProcIdResponseHandler:
Inheritance graph

Public Member Functions

 BESProcIdResponseHandler (const string &name)
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command 'show process;' by returning the process id of the server process 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 BESResponseHandlerProcIdResponseBuilder (const string &name)
 

Protected Attributes

BESResponseObject_response
 
string _response_name
 

Detailed Description

A request 'show process;' will be handled by this response handler. It returns the process id of the server process connected to the requesting client.

See also
BESResponseObject
BESContainer
BESTransmitter

Definition at line 48 of file BESProcIdResponseHandler.h.

Member Function Documentation

void BESProcIdResponseHandler::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 108 of file BESProcIdResponseHandler.cc.

References BESResponseHandler::dump().

void BESProcIdResponseHandler::execute ( BESDataHandlerInterface dhi)
virtual

This response handler knows how to retrieve the process id for the server process handling this client's requests and stores it in a BESInfo informational response object.

Parameters
dhistructure that holds request and response information
See also
BESDataHandlerInterface
BESInfo

Implements BESResponseHandler.

Definition at line 62 of file BESProcIdResponseHandler.cc.

References BESInfo::begin_response(), and BESUtil::fastpidconverter().

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.

References BESResponseHandler::dump().

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.

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.

void BESProcIdResponseHandler::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface dhi 
)
virtual

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

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

Implements BESResponseHandler.

Definition at line 89 of file BESProcIdResponseHandler.cc.

References BESInfo::transmit().


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