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

Public Member Functions

 BESStreamResponseHandler (const string &name)
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual void execute (BESDataHandlerInterface &r)
 executes the command 'get file <filename>;' by streaming the specified file 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 &r)
 transmit the file, streaming it back to the client More...
 

Static Public Member Functions

static BESResponseHandlerBESStreamResponseBuilder (const string &name)
 

Protected Attributes

BESResponseObject_response
 
string _response_name
 

Detailed Description

Definition at line 38 of file BESStreamResponseHandler.h.

Member Function Documentation

◆ dump()

void BESStreamResponseHandler::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 158 of file BESStreamResponseHandler.cc.

References BESResponseHandler::dump().

◆ execute()

void BESStreamResponseHandler::execute ( BESDataHandlerInterface dhi)
virtual
Parameters
dhistructure that holds request and response information
Exceptions
BESNotFoundErrorif the specified file to stream does not exist
BESInternalErrorif not all required information is provided
See also
BESDataHandlerInterface
BESHTMLInfo
BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 73 of file BESStreamResponseHandler.cc.

References BESContainer::access(), BESDataHandlerInterface::container, and BESDataHandlerInterface::first_container().

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

References BESResponseHandler::dump().

◆ 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 BESStreamResponseHandler::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface r 
)
virtual
Parameters
transmitterobject that knows how to transmit specific basic types
dhistructure that holds the request and response information
See also
BESTransmitter
BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 144 of file BESStreamResponseHandler.cc.


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