|
typedef map< string, p_request_handler >::const_iterator | Handler_citer |
|
typedef map< string, p_request_handler >::iterator | Handler_iter |
|
|
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 More...
|
|
virtual void | dump (ostream &strm) const |
| dumps information about this object More...
|
|
virtual p_request_handler | find_handler (const string &handler_name) |
| find the method that can handle the specified response object type More...
|
|
virtual string | get_handler_names () |
| return a comma separated list of response object types handled by this request handler More...
|
|
virtual const string & | get_name () const |
|
virtual bool | remove_handler (const string &handler_name) |
| remove the specified handler method from this request handler More...
|
|
| SampleRequestHandler (const string &name) |
|
Definition at line 38 of file SampleRequestHandler.h.
◆ add_handler()
bool BESRequestHandler::add_handler |
( |
const string & |
handler_name, |
|
|
p_request_handler |
handler_method |
|
) |
| |
|
virtualinherited |
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 50 of file BESRequestHandler.cc.
◆ dump()
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 86 of file SampleRequestHandler.cc.
◆ find_handler()
p_request_handler BESRequestHandler::find_handler |
( |
const string & |
handler_name | ) |
|
|
virtualinherited |
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 87 of file BESRequestHandler.cc.
◆ get_handler_names()
string BESRequestHandler::get_handler_names |
( |
| ) |
|
|
virtualinherited |
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 104 of file BESRequestHandler.cc.
◆ remove_handler()
bool BESRequestHandler::remove_handler |
( |
const string & |
handler_name | ) |
|
|
virtualinherited |
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 66 of file BESRequestHandler.cc.
The documentation for this class was generated from the following files: