#include <SampleRequestHandler.h>
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) |
Definition at line 38 of file SampleRequestHandler.h.
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.
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.
SampleRequestHandler::~SampleRequestHandler | ( | void | ) | [virtual] |
Definition at line 51 of file SampleRequestHandler.cc.
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.
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 |
Definition at line 51 of file BESRequestHandler.cc.
References BESRequestHandler::find_handler().
Referenced by BESDapRequestHandler::BESDapRequestHandler(), CSVRequestHandler::CSVRequestHandler(), and SampleRequestHandler().
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
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().
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.
handler_name | name of the method that can fill in the response object type |
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
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
handler_name | name of the method to be removed, same as the name of the response object |
Definition at line 70 of file BESRequestHandler.cc.
bool SampleRequestHandler::sample_build_help | ( | BESDataHandlerInterface & | dhi | ) | [static] |
Definition at line 71 of file SampleRequestHandler.cc.
References BESInfo::add_data_from_file(), BESInfo::begin_tag(), BESInfo::end_tag(), BESResponseHandler::get_response_object(), PACKAGE_NAME, PACKAGE_VERSION, and BESDataHandlerInterface::response_handler.
Referenced by SampleRequestHandler().
bool SampleRequestHandler::sample_build_vers | ( | BESDataHandlerInterface & | dhi | ) | [static] |
Definition at line 56 of file SampleRequestHandler.cc.
References BESVersionInfo::add_module(), BESResponseHandler::get_response_object(), PACKAGE_NAME, PACKAGE_VERSION, and BESDataHandlerInterface::response_handler.
Referenced by SampleRequestHandler().