SampleRequestHandler Class Reference

#include <SampleRequestHandler.h>

Inheritance diagram for SampleRequestHandler:
Inheritance graph
[legend]
Collaboration diagram for SampleRequestHandler:
Collaboration graph
[legend]

List of all members.

Public Types

typedef map< string,
p_request_handler >
::const_iterator 
Handler_citer
typedef map< string,
p_request_handler >::iterator 
Handler_iter

Public Member Functions

virtual bool add_handler (const string &handler_name, p_request_handler handler_method)
 add a handler method to the request handler that knows how to fill in a specific response object
virtual void dump (ostream &strm) const
 dumps information about this object
virtual p_request_handler find_handler (const string &handler_name)
 find the method that can handle the specified response object type
virtual string get_handler_names ()
 return a comma separated list of response object types handled by this request handler
virtual const string & get_name () const
virtual bool remove_handler (const string &handler_name)
 remove the specified handler method from this request handler
 SampleRequestHandler (const string &name)
virtual ~SampleRequestHandler (void)

Static Public Member Functions

static bool sample_build_help (BESDataHandlerInterface &dhi)
static bool sample_build_vers (BESDataHandlerInterface &dhi)

Detailed Description

Definition at line 38 of file SampleRequestHandler.h.


Member Typedef Documentation

typedef map< string, p_request_handler >::const_iterator BESRequestHandler::Handler_citer [inherited]

Definition at line 83 of file BESRequestHandler.h.

typedef map< string, p_request_handler >::iterator BESRequestHandler::Handler_iter [inherited]

Definition at line 84 of file BESRequestHandler.h.


Constructor & Destructor Documentation

SampleRequestHandler::SampleRequestHandler ( const string &  name  ) 

Definition at line 44 of file SampleRequestHandler.cc.

References BESRequestHandler::add_handler(), HELP_RESPONSE, sample_build_help(), sample_build_vers(), and VERS_RESPONSE.

Here is the call graph for this function:

SampleRequestHandler::~SampleRequestHandler ( void   )  [virtual]

Definition at line 51 of file SampleRequestHandler.cc.


Member Function Documentation

bool BESRequestHandler::add_handler ( const string &  handler_name,
p_request_handler  handler_method 
) [virtual, inherited]

add a handler method to the request handler that knows how to fill in a specific response object

Add a handler method for a specific response object to the request handler. The handler method takes a reference to a BESDataHandlerInterface and returns bool, true if the response object is filled in successfully by the method, false otherwise.

Parameters:
handler_name name of the response object this method can fill in
handler_method a function pointer to the method that can fill in the specified response object
Returns:
true if the handler is added, false if it already exists
See also:
BESResponseObject
BESResponseNames

Definition at line 51 of file BESRequestHandler.cc.

References BESRequestHandler::find_handler().

Referenced by BESDapRequestHandler::BESDapRequestHandler(), CSVRequestHandler::CSVRequestHandler(), and SampleRequestHandler().

Here is the call graph for this function:

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

dumps information about this object

Displays the pointer value of this instance, the name of the request handler, and the names of all registered handler functions

Parameters:
strm C++ i/o stream to dump the information to

Reimplemented from BESRequestHandler.

Definition at line 92 of file SampleRequestHandler.cc.

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

Here is the call graph for this function:

p_request_handler BESRequestHandler::find_handler ( const string &  handler_name  )  [virtual, inherited]

find the method that can handle the specified response object type

Find the method that can handle the specified response object type. The response object type is the same as the handler name.

Parameters:
handler_name name of the method that can fill in the response object type
Returns:
the method that can fill in the specified response object type
See also:
BESResponseObject
BESResponseNames

Definition at line 93 of file BESRequestHandler.cc.

Referenced by BESRequestHandler::add_handler(), BESRequestHandlerList::execute_all(), and BESRequestHandlerList::execute_current().

string BESRequestHandler::get_handler_names (  )  [virtual, inherited]

return a comma separated list of response object types handled by this request handler

Returns:
the comma separated list of response object types
See also:
BESResponseObject
BESResponseNames

Definition at line 112 of file BESRequestHandler.cc.

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

Definition at line 86 of file BESRequestHandler.h.

bool BESRequestHandler::remove_handler ( const string &  handler_name  )  [virtual, inherited]

remove the specified handler method from this request handler

Parameters:
handler_name name of the method to be removed, same as the name of the response object
Returns:
true if successfully removed, false if not found
See also:
BESResponseNames

Definition at line 70 of file BESRequestHandler.cc.

bool SampleRequestHandler::sample_build_help ( BESDataHandlerInterface dhi  )  [static]
bool SampleRequestHandler::sample_build_vers ( BESDataHandlerInterface dhi  )  [static]

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

Generated on 18 Feb 2010 for OPeNDAP Hyrax Back End Server (BES) by  doxygen 1.6.1