BESStreamResponseHandler Class Reference

#include <BESStreamResponseHandler.h>

Inheritance diagram for BESStreamResponseHandler:

Inheritance graph
[legend]
Collaboration diagram for BESStreamResponseHandler:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 BESStreamResponseHandler (const string &name)
virtual void dump (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 string get_name () const
 return the name of this response object
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
virtual ~BESStreamResponseHandler (void)

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.


Constructor & Destructor Documentation

BESStreamResponseHandler::BESStreamResponseHandler ( const string &  name  ) 

Definition at line 53 of file BESStreamResponseHandler.cc.

Referenced by BESStreamResponseBuilder().

BESStreamResponseHandler::~BESStreamResponseHandler ( void   )  [virtual]

Definition at line 58 of file BESStreamResponseHandler.cc.


Member Function Documentation

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

Definition at line 168 of file BESStreamResponseHandler.cc.

References BESStreamResponseHandler().

Referenced by BESDefaultModule::initialize().

Here is the call graph for this function:

void BESStreamResponseHandler::dump ( ostream &  strm  )  const [virtual]

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

References BESResponseHandler::dump(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Here is the call graph for this function:

void BESStreamResponseHandler::execute ( BESDataHandlerInterface dhi  )  [virtual]

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 73 of file BESStreamResponseHandler.cc.

References BESResponseHandler::_response, BESContainer::access(), BES_STREAM_BUFFER_SIZE, BESDataHandlerInterface::container, BESDataHandlerInterface::containers, BESDataHandlerInterface::first_container(), and BESDataHandlerInterface::get_output_stream().

Here is the call graph for this function:

virtual string BESResponseHandler::get_name (  )  const [inline, virtual, inherited]

return the name of this response object

This name is used to determine which response handler can handle a requested responose, such as das, dds, ddx, tab, info, version, help, etc...

Returns:
response name

Definition at line 156 of file BESResponseHandler.h.

References BESResponseHandler::_response_name.

BESResponseObject * BESResponseHandler::get_response_object (  )  [virtual, inherited]

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 53 of file BESResponseHandler.cc.

References BESResponseHandler::_response.

Referenced by CSVRequestHandler::csv_build_das(), CSVRequestHandler::csv_build_data(), CSVRequestHandler::csv_build_dds(), CSVRequestHandler::csv_build_help(), CSVRequestHandler::csv_build_vers(), BESDapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_version(), and BESDataHandlerInterface::get_response_object().

BESResponseObject * BESResponseHandler::set_response_object ( BESResponseObject o  )  [virtual, inherited]

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 59 of file BESResponseHandler.cc.

References BESResponseHandler::_response.

void BESStreamResponseHandler::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface dhi 
) [virtual]

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 144 of file BESStreamResponseHandler.cc.


Member Data Documentation

BESResponseObject* BESResponseHandler::_response [protected, inherited]

Definition at line 85 of file BESResponseHandler.h.

Referenced by BESResponseHandler::dump(), BESVersionResponseHandler::execute(), execute(), BESStatusResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESServicesResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESDDXResponseHandler::execute(), BESDDSResponseHandler::execute(), BESDataResponseHandler::execute(), BESDataDDXResponseHandler::execute(), BESDASResponseHandler::execute(), BESConfigResponseHandler::execute(), BESCatalogResponseHandler::execute(), BESResponseHandler::get_response_object(), BESResponseHandler::set_response_object(), BESVersionResponseHandler::transmit(), BESStatusResponseHandler::transmit(), BESShowDefsResponseHandler::transmit(), BESShowContextResponseHandler::transmit(), BESShowContainersResponseHandler::transmit(), BESSetContextResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESServicesResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDataDDXResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().

string BESResponseHandler::_response_name [protected, inherited]

Definition at line 84 of file BESResponseHandler.h.

Referenced by BESResponseHandler::dump(), BESDDXResponseHandler::execute(), BESDataDDXResponseHandler::execute(), and BESResponseHandler::get_name().


The documentation for this class was generated from the following files:
Generated on Thu Feb 11 09:17:09 2010 for OPeNDAP Hyrax Back End Server (BES) by  doxygen 1.4.7