Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members

SControlQBox Class Reference

#include <SControlQBox.h>

Inherits QBox.

Inherited by SOutputQBox, and SUnionQBox.

List of all members.


Detailed Description

Defines the generic behavior of control boxes.

Most importantly these boxes have a second output where they send control messages to the runtime engine


Public Member Functions

void setupImpl () throw (AuroraException)
void initImpl () throw (AuroraException)

Protected Member Functions

TupleDescription createControlOutputDescription ()
 Creates the schema for the output stream with control messages.
void emitTuple (const Tuple &src_tuple)
 Emit a tuple on the DATA_STREAM.
void emitTuple (const Tuple &undo_tuple, TupleType type)
 Emit a tuple of the given type.
void emitUndoRedoTuples (const Tuple &tuple)
 Emit a tuple as an UNDO and a REDO.
void emitControlTuple (int stream_id, TupleType tuple_type, Timestamp tuple_data)
 Emit a control tuple on the DATA_STREAM or CONTROL_STREAM.
void emitControlTuple (TupleType tuple_type, Timestamp tuple_data)
 Emit a control tuple on the CONTROL_STREAM.
void notifyOutputs ()
 Notify appropriate outputs about newly available tuples.
 AURORA_DECLARE_QBOX (SControlQBox,"scontrol")

Protected Attributes

bool _output [TWO_OUTPUTS]
 True/false indicates whether new tuples have been produced.
unsigned int _output_tuple_size
 The size in bytes of DATA_STREAM output tuples.
unsigned int _control_tuple_size

Static Protected Attributes

const int DATA_STREAM = 0
const int CONTROL_STREAM = 1
const int TWO_OUTPUTS = 2


Member Function Documentation

SControlQBox::AURORA_DECLARE_QBOX SControlQBox  ,
"scontrol" 
[protected]
 

TupleDescription SControlQBox::createControlOutputDescription  )  [protected]
 

Creates the schema for the output stream with control messages.

Reimplemented in SUnionQBox.

void SControlQBox::emitControlTuple TupleType  tuple_type,
Timestamp  tuple_data
[protected]
 

Emit a control tuple on the CONTROL_STREAM.

void SControlQBox::emitControlTuple int  stream_id,
TupleType  tuple_type,
Timestamp  tuple_data
[protected]
 

Emit a control tuple on the DATA_STREAM or CONTROL_STREAM.

void SControlQBox::emitTuple const Tuple &  undo_tuple,
TupleType  type
[protected]
 

Emit a tuple of the given type.

void SControlQBox::emitTuple const Tuple &  src_tuple  )  [protected]
 

Emit a tuple on the DATA_STREAM.

void SControlQBox::emitUndoRedoTuples const Tuple &  tuple  )  [protected]
 

Emit a tuple as an UNDO and a REDO.

void SControlQBox::initImpl  )  throw (AuroraException) [virtual]
 

Reimplemented from QBox.

Reimplemented in SOutputQBox, and SUnionQBox.

void SControlQBox::notifyOutputs  )  [protected]
 

Notify appropriate outputs about newly available tuples.

BOREALIS_NAMESPACE_BEGIN void SControlQBox::setupImpl  )  throw (AuroraException) [virtual]
 

Implements QBox.

Reimplemented in SOutputQBox, and SUnionQBox.


Member Data Documentation

unsigned int SControlQBox::_control_tuple_size [protected]
 

bool SControlQBox::_output[TWO_OUTPUTS] [protected]
 

True/false indicates whether new tuples have been produced.

unsigned int SControlQBox::_output_tuple_size [protected]
 

The size in bytes of DATA_STREAM output tuples.

const int SControlQBox::CONTROL_STREAM = 1 [static, protected]
 

const int SControlQBox::DATA_STREAM = 0 [static, protected]
 

const int SControlQBox::TWO_OUTPUTS = 2 [static, protected]
 


The documentation for this class was generated from the following files:
Generated on Fri Nov 12 15:15:24 2004 for Borealis by doxygen 1.3.8