sends::template_stage Class Reference
Template SEDA stage class. More...
#include <template_stage.hh>
Public Member Functions | |
| template_stage (int nThread, int nTrans) | |
| Stage template constructor. | |
| virtual | ~template_stage (void) |
| void | filter (transaction *trans) |
| Transaction filter for this stage. | |
| const char * | stage_name (void) const |
| Stage name. | |
Detailed Description
Template SEDA stage class.The template_stage class provides a minimal template for a SEDA stage thread pool. It is based on the seda_stage class and provides a stage with no filter processing. The constructor, destructor and filter methods are implemented. The filter method immediately passes the transactions to its output queue (the input queue of the next stage in the pipeline.
- Version:
- 1.0; Last modified December 28, 2007
Constructor & Destructor Documentation
| sends::template_stage::template_stage | ( | int | nThread, | |
| int | nTrans | |||
| ) |
Stage template constructor.
Construct a template_stage object. The arguments indicate the number of threads in the pool and the number of input transactions that may be queue simultaneously (note that the pipline gets indigestion only after more than (nTrans + nThread) trasactions need to execute in this stage.
- Parameters:
-
nThread Number of threads to run simultaneously in the pool. nTrans Number of transactions that may be queued.
| virtual sends::template_stage::~template_stage | ( | void | ) | [virtual] |
Stage template destructor is null by default. It is mostly useful to remove resources allocated by the stages.
Member Function Documentation
| void sends::template_stage::filter | ( | transaction * | trans | ) | [virtual] |
Transaction filter for this stage.
The filter method performs the transaction processing for a single stage. By default this is a null filter that passes the transaction on to the next
- Parameters:
-
trans Pointer to the current transaction
Implements sends::seda_stage.
| const char* sends::template_stage::stage_name | ( | void | ) | const [virtual] |
Stage name.
Return a constant pointer to a null-terminated character vector containing the name of the stage.
- Returns:
- Constant pointer to the stage name string.
Implements sends::seda_stage.
The documentation for this class was generated from the following file:
- src/stages/template_stage.hh
