bes Updated for version 3.20.13
BESStreamResponseHandler Class Reference
Collaboration diagram for BESStreamResponseHandler:
Collaboration graph

Public Member Functions

 BESStreamResponseHandler (const std::string &name)
 
virtual void dump (std::ostream &strm) const
 dumps information about this object
 
virtual void execute (BESDataHandlerInterface &r)
 executes the command 'get file <filename>;' by streaming the specified file
 
virtual BESResponseObjectget_response_object ()
 return the current response object
 
virtual BESResponseObjectset_response_object (BESResponseObject *o)
 replaces the current response object with the specified one, returning the current response object
 
virtual void transmit (BESTransmitter *transmitter, BESDataHandlerInterface &r)
 transmit the file, streaming it back to the client
 

Static Public Member Functions

static BESResponseHandlerBESStreamResponseBuilder (const std::string &name)
 

Protected Attributes

std::string d_annotation_service_url
 
std::string d_response_name
 
BESResponseObjectd_response_object
 

Detailed Description

Definition at line 38 of file BESStreamResponseHandler.h.

Constructor & Destructor Documentation

◆ BESStreamResponseHandler()

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

Definition at line 63 of file BESStreamResponseHandler.cc.

◆ ~BESStreamResponseHandler()

BESStreamResponseHandler::~BESStreamResponseHandler ( void  )
virtual

Definition at line 68 of file BESStreamResponseHandler.cc.

Member Function Documentation

◆ BESStreamResponseBuilder()

BESResponseHandler * BESStreamResponseHandler::BESStreamResponseBuilder ( const std::string &  name)
static

Definition at line 195 of file BESStreamResponseHandler.cc.

◆ dump()

void BESStreamResponseHandler::dump ( std::ostream &  strm) const
virtual

dumps information about this object

Displays the pointer value of this instance

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

Reimplemented from BESResponseHandler.

Definition at line 186 of file BESStreamResponseHandler.cc.

◆ execute()

void BESStreamResponseHandler::execute ( BESDataHandlerInterface dhi)
virtual

executes the command 'get file <filename>;' by streaming the specified file

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 84 of file BESStreamResponseHandler.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 82 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
onew response object used to replace the current one
Returns
the response object being replaced
See also
BESResponseObject

Definition at line 88 of file BESResponseHandler.cc.

◆ transmit()

void BESStreamResponseHandler::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface r 
)
virtual

transmit the file, streaming it back to the client

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 174 of file BESStreamResponseHandler.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
protectedinherited

Definition at line 80 of file BESResponseHandler.h.


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