response handler that returns the status of the server process serving the requesting client More...

#include <BESStatusResponseHandler.h>

Inheritance diagram for BESStatusResponseHandler:

Collaboration diagram for BESStatusResponseHandler:

Public Member Functions
	BESStatusResponseHandler (const BESStatusResponseHandler &)=delete

	BESStatusResponseHandler (const std::string &name)

void	dump (std::ostream &strm) const override
	dumps information about this object

void	execute (BESDataHandlerInterface &dhi) override
	executes the command 'show status;' by returning the status of the server process

virtual BESResponseObject *	get_response_object ()
	return the current response object

BESStatusResponseHandler &	operator= (const BESStatusResponseHandler &)=delete

virtual BESResponseObject *	set_response_object (BESResponseObject *o)
	replaces the current response object with the specified one, returning the current response object

void	transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) override
	transmit the response object built by the execute command using the specified transmitter object

Static Public Member Functions
static BESResponseHandler *	StatusResponseBuilder (const std::string &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 the status of the server process serving the requesting client

A request 'show status;' will be handled by this response handler. It returns the status of the server process handling the clients requests in an informational response object.

See also: BESResponseObject; BESContainer; BESTransmitter

Definition at line 49 of file BESStatusResponseHandler.h.

Constructor & Destructor Documentation

◆ BESStatusResponseHandler()

BESStatusResponseHandler::BESStatusResponseHandler ( const std::string & name )

inlineexplicit

Definition at line 55 of file BESStatusResponseHandler.h.

Member Function Documentation

◆ dump()

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

overridevirtual

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 95 of file BESStatusResponseHandler.cc.

◆ execute()

void BESStatusResponseHandler::execute ( BESDataHandlerInterface & dhi )

overridevirtual

executes the command 'show status;' by returning the status of the server process

This response handler knows how to retrieve the status for the server process handing this clients requests from BESStatus and stores it in a BESInfo informational response object.

Parameters

dhi	structure that holds request and response information

See also: BESDataHandlerInterface; BESInfo; BESStatus

Implements BESResponseHandler.

Definition at line 56 of file BESStatusResponseHandler.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.

◆ StatusResponseBuilder()

static BESResponseHandler * BESStatusResponseHandler::StatusResponseBuilder ( const std::string & name )

inlinestatic

Definition at line 66 of file BESStatusResponseHandler.h.

◆ transmit()

void BESStatusResponseHandler::transmit	(	BESTransmitter *	transmitter,
		BESDataHandlerInterface &	dhi )

overridevirtual

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

Parameters

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

See also: BESResponseObject; BESTransmitter; BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 79 of file BESStatusResponseHandler.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:

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BESStatusResponseHandler()

Member Function Documentation

◆ dump()

◆ execute()

◆ get_response_object()

◆ set_response_object()

◆ StatusResponseBuilder()

◆ transmit()

Member Data Documentation

◆ d_annotation_service_url

◆ d_response_name

◆ d_response_object