BESStreamResponseHandler Class Reference

Inheritance diagram for BESStreamResponseHandler:

Collaboration diagram for BESStreamResponseHandler:

Public Member Functions
	BESStreamResponseHandler (const std::string &name)
void	dump (std::ostream &strm) const override
	dumps information about this object
void	execute (BESDataHandlerInterface &r) override
	executes the command 'get file <filename>;' by streaming the specified file
virtual BESResponseObject *	get_response_object ()
	return the current response object
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 &r) override
	transmit the file, streaming it back to the client

Static Public Member Functions
static BESResponseHandler *	BESStreamResponseBuilder (const std::string &name)

Protected Attributes
std::string	d_annotation_service_url
std::string	d_response_name
BESResponseObject *	d_response_object = nullptr

Detailed Description

Definition at line 38 of file BESStreamResponseHandler.h.

Constructor & Destructor Documentation

BESStreamResponseHandler()

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

inlineexplicit

Definition at line 40 of file BESStreamResponseHandler.h.

Member Function Documentation

BESStreamResponseBuilder()

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

static

Definition at line 160 of file BESStreamResponseHandler.cc.

dump()

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

execute()

void BESStreamResponseHandler::execute ( BESDataHandlerInterface & dhi )

overridevirtual

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

Parameters

dhi	structure that holds request and response information

Exceptions

BESNotFoundError	if the specified file to stream does not exist
BESInternalError	if not all required information is provided

See also

BESDataHandlerInterface

BESHTMLInfo

BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 71 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 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.

transmit()

void BESStreamResponseHandler::transmit ( BESTransmitter * transmitter, BESDataHandlerInterface & r )

overridevirtual

transmit the file, streaming it back to the client

Parameters

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

See also

BESTransmitter

BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 139 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 = nullptr

protectedinherited

Definition at line 80 of file BESResponseHandler.h.

---

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

• BESStreamResponseHandler.h
• BESStreamResponseHandler.cc