NAME
Oorb::OrbReaderTask - Task to read packets from orb connections in the oorb library
SYNOPSIS
-loorb $(ORBLIBS)
#include "oorb.h"
namespace Oorb
class OrbReaderTask
DESCRIPTION
This page describes the
OrbReaderTask which is used within the
Oorb(3) library to read data from
orbserver(1) connections.
The
OrbReaderTask is generally not intended to be launched
directly by application programmers. Rather, the program author should
call the
addConnection method of
Oorb::Master(3) to register
the intended connection, handing that method a parameter-file to be given
via the
BUConfigure(3) configure method to the
OrbReaderTask constructor. The configuration parameters for
OrbReaderTask are listed and explained below.
CONSTRUCTORS
-
OrbReaderTask( std::string taskName, Pf* pf )
This class
METHODS
-
void run( void );
The OrbReaderTask's run method is invoked automatically from
within the Oorb::Master(3) run method and should not
need to be called by application programmers.
OBJECT CONFIGURATION PARAMETERS
The
OrbReaderTask object contains a public member
struct of name
m_readerParams which is defined as follows:
typedef struct readerParamsStruct {
char* read_from_orbname;
char* read_from_orbtag;
char* write_to_queue;
bool check_unstuff;
bool suppress_unstuff_errors;
double acq_starttime_task;
double acq_endtime_task;
double too_old;
double too_new;
} readerParamsStruct;
-
read_from_orbname
The read_from_orbname parameter gives the orbserver(1) name
from which to acquire packets. If read_from_orbtag is specified,
read_from_orbname is ignored.
-
read_from_orbtag
The read_from_orbtag parameter gives the tag name (for example
dataorb, inputorb, outputorb etc.)
from which to acquire packets. If read_from_orbtag is specified,
read_from_orbname is ignored.
-
write_to_queue
The write_to_queue parameter gives the name of the internal
Oorb::Queue(3) to which to write acquired orb packets. If the named
Oorb::Queue(3) does not already exist, it is instantiated
automatically.
-
check_unstuff
The check_unstuff parameter checks whether packets can be unstuffed
via the Antelope unstuffPkt(3) function. If check_unstuff is
true and a packet does not successfully unstuff, it will be rejected.
-
suppress_unstuff_errors
Normally when packets do not unstuff they generate a complaint message at
most verbosity levels. For a continually misbehaving data stream, however,
these messages can become voluminous and of diminishing use. If the
check_unstuff_errors boolean is set to true, these
messages are not emitted.
-
acq_starttime_task
The ack_starttime_task parameter determines the earliest data time
at which to acquire packet data. In the input parameter file to the
constructor and in subsequent calls to the BUConfigure(3)
configure method, this parameter should be referred to as
acq_starttime. The _task suffix is kept in the internal C++
representation to assist application programmers to distinguish
Oorb::Task(3)-specific settings from program-wide defaults.
-
acq_endtime_task
The ack_endtime_task parameter determines the latest data time
at which to acquire packet data. In the input parameter file to the
constructor and in subsequent calls to the BUConfigure(3)
configure method, this parameter should be referred to as
acq_endtime. The _task suffix is kept in the internal C++
representation to assist application programmers to distinguish
Oorb::Task(3)-specific settings from program-wide defaults.
If acq_endtime_task is null, data acquisition proceeds indefinitely.
If acq_endtime_task is set to last, data acquisition
proceeds until the latest packet that was present on the orbserver(1)
at the time of program launch.
-
too_old
The too_old parameter gives the number of seconds difference
from system-clock time allowed before an input packet is considered too old
to acquire. Usually this parameter is used to exclude packets that may
come from data sources with malfunctioning or ill-configured clocks.
-
too_new
The too_new parameter gives the number of seconds difference
from system-clock time allowed before an input packet is considered too old
to acquire. Usually this parameter is used to exclude packets that may
come from data sources with malfunctioning or ill-configured clocks.
LIBRARY
-loorb $(ORBLIBS)
ATTRIBUTES
MT-Safe
SEE ALSO
Oorb(3), Oorb::Task(3), Oorb::Master(3), Oorb::OrbConnectionTask(3),
Oorb::OrbWriterTask(3)
AUTHOR
Kent Lindquist