NAME
Oorb::OrbWriterTask - Task to read packets from orb connections in the oorb library
SYNOPSIS
-loorb $(ORBLIBS)
#include "oorb.h"
namespace Oorb
class OrbWriterTask
DESCRIPTION
This page describes the
OrbWriterTask which is used within the
Oorb(3) library to write data to
orbserver(1) connections.
The
OrbWriterTask 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
OrbWriterTask constructor. The configuration parameters for
OrbWriterTask are listed and explained below.
CONSTRUCTORS
-
OrbWriterTask( std::string taskName, Pf* pf )
This class
METHODS
-
void run( void );
The OrbWriterTask'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
OrbWriterTask object contains a public member
struct of name
m_writerParams which is defined as follows:
typedef struct writerParamsStruct {
char* read_from_queue;
char* write_to_orbname;
char* write_to_orbtag;
int max_queue;
bool acknowledge;
} writerParamsStruct;
-
read_from_queue
The read_from_queue parameter gives the name of the internal
Oorb::Queue(3) from which to read orb packets acquired by an
Oorb::OrbReaderTask(3) object. If the named
Oorb::Queue(3) does not already exist, it is instantiated
automatically.
-
write_to_orbname
The write_to_orbname parameter gives the orbserver(1) name
to which to write acquired packets. If write_to_orbtag is specified,
write_to_orbname is ignored.
-
write_to_orbtag
The write_to_orbtag parameter gives the tag name (for example
dataorb, inputorb, outputorb etc.)
to which to write acquired packets. If write_to_orbtag is specified,
write_to_orbname is ignored.
-
max_queue
The max_queue parameter specifies how many packets can build up
in the associated Oorb::Queue(3) before writes to that
Oorb::Queue(3) are forced to pause. See the Oorb::Queue(3)
man-page for further details.
-
acknowledge
The boolean parameter acknowledge specifies whether
the receiving orbserver(1) should be forced to acknowledge
each received packet. The default, false, indicates
no acknowledgement (a setting of true forces use of
orbputx(3) instead of orbput(3) in the underlying orb(3)
writes).
LIBRARY
-loorb $(ORBLIBS)
ATTRIBUTES
MT-Safe
SEE ALSO
Oorb(3), Oorb::Task(3), Oorb::Master(3), Oorb::OrbConnectionTask(3), Oorb::OrbReaderTask(3)
AUTHOR
Kent Lindquist