NAME
Oorb::StatusMgrTask - Status-manager task for the oorb library
SYNOPSIS
-loorb $(ORBLIBS)
#include "oorb.h"
namespace Oorb
class StatusMgrTask
DESCRIPTION
The
StatusMgrTask class is used internally by the
Oorb(3)
library. The
Oorb::Master(3) class within an
Oorb(3)-library
based program automatically instantiates and calls the
run method
on an object of the
StatusMgrTask class.
The
StatusMgrTask's main job is to monitor the status of orb
connections within programs based on the
Oorb(3) library,
emitting status packets of the sort readable by the Antelope
dlmon(1) program.
CONSTRUCTORS
-
StatusMgrTask( void )
The StatusMgrTask constructor is invoked automatically from
within the Oorb::Master(3) run method and should not
need to be called by application programmers.
METHODS
-
void run( void );
The StatusMgrTask's run method is invoked automatically from
within the Oorb::Master(3) run method and should not
need to be called by application programmers.
-
void forceWrite( void );
The StatusMgrTask's forceWrite causes an immediate write
of known status information as a dlmon(1) orbserver(1)
packet. This may be used in instances such as OrbConnectionTask(3)
state changes, which should be announced without waiting for the
next regularly-scheduled status-packet announcement by the StatusMgrTask.
OBJECT CONFIGURATION PARAMETERS
The
StatusMgrTask object contains a public member
struct of name
m_statusParams which is defined as follows:
typedef struct statusParamsStruct {
char* write_to_queue;
double pfstatusreport_sec;
} stateParamsStruct;
-
write_to_queue
The char* write_to_queue parameter contains the string name of
the Oorb::Queue(3) into which to write generated status packets.
If this is null or empty, no status packets are written.
-
pfstatusreport_sec
The double-precision pfstatusreport_sec parameter
gives the length of time between successive status report issuances.
LIBRARY
-loorb $(ORBLIBS)
ATTRIBUTES
MT-Safe
SEE ALSO
Oorb(3), Oorb::Task(3), Oorb::Master(3)
AUTHOR
Kent Lindquist