Teko Version of the Day
Public Member Functions
Teko::RequestHandler Class Reference

#include <Teko_RequestHandler.hpp>

List of all members.

Public Member Functions

void addRequestCallback (const Teuchos::RCP< RequestCallbackBase > &callback)
template<typename DataT >
DataT request (const RequestMesg &rm) const
template<typename DataT >
DataT request (const std::string &rm) const
template<typename DataT >
void preRequest (const RequestMesg &rm) const
template<typename DataT >
void preRequest (const std::string &rm) const

Detailed Description

Classes that handles and distrubutes requests. This has two types of users. Those that register callbacks to handle the requests, and those that make requests.

This class is passive-aggressive. It calls required data a "request", however it actually requires a handler to satisfy the request.

Note:
The implemntation is based on the listener pattern.

Definition at line 69 of file Teko_RequestHandler.hpp.


Member Function Documentation

void Teko::RequestHandler::addRequestCallback ( const Teuchos::RCP< RequestCallbackBase > &  callback)

Add a call back object to handle requests

Parameters:
[in]callbackRef-count-pointer to a call back object.

Definition at line 54 of file Teko_RequestHandler.cpp.

template<typename DataT >
DataT Teko::RequestHandler::request ( const RequestMesg &  rm) const

Get the data for a particular request.

Parameters:
[in]rmThe message describing the request.

Definition at line 52 of file Teko_RequestHandler.hpp.

template<typename DataT >
DataT Teko::RequestHandler::request ( const std::string &  rm) const [inline]

Get the data for a particular request. Short hand version.

Parameters:
[in]rmThe message describing the request.

Definition at line 91 of file Teko_RequestHandler.hpp.

template<typename DataT >
void Teko::RequestHandler::preRequest ( const RequestMesg &  rm) const

Send a pre-request message to the callback allowing them to do some work up front and ahead of time. This is meant to be called at construction/initialization.

Parameters:
[in]rmThe message describing the request.

Definition at line 79 of file Teko_RequestHandler.hpp.

template<typename DataT >
void Teko::RequestHandler::preRequest ( const std::string &  rm) const [inline]

Send a pre-request message to the callback allowing them to do some work up front and ahead of time. This is meant to be called at construction/initialization. Short hand version.

Parameters:
[in]rmThe message describing the request.

Definition at line 112 of file Teko_RequestHandler.hpp.


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables