• Antelope Release 5.10 Linux CentOS release 7.6.1810 (Core) 3.10.0 2020-05-12

 

NAME

Oorb::StateMgrTask - State-manager task for the oorb library

SYNOPSIS

-loorb $(ORBLIBS)

#include "oorb.h"

namespace Oorb

class StateMgrTask

DESCRIPTION

The StateMgrTask 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 StateMgrTask class. The StateMgrTask's main job is to read and write information on the state of each orb connection to a statefile designated by the program. If the statefile parameter (see below) of the StateMgrTask is empty, no state information is read or written. The StateMgrTask will attempt to upgrade state files from older orb2orb(1) state-file formats to the current format. State file information not currently being used by active connections will be preserved if they are not too old. State-file entries with last_update time older than the configured retain_unused_stateinfo_sec parameter will be purged.

CONSTRUCTORS

METHODS

OBJECT CONFIGURATION PARAMETERS

The StateMgrTask object contains a public member struct of name m_stateParams which is defined as follows:

typedef struct stateParamsStruct {
    char*    statefile;
    double   retain_unused_stateinfo_sec;
} stateParamsStruct;

LIBRARY

-loorb $(ORBLIBS)

ATTRIBUTES

MT-Safe

SEE ALSO

Oorb(3), Oorb::Task(3), Oorb::Master(3)

BUGS AND CAVEATS

Note that if no statefile is specified, the StateMgrTask will shut down its run method and thereby relinquish its thread since it doesn't need to write our regular state files. That given, internally the StateMgrTask structures will still be used to track connection state, for all StateVector objects with member m_enabled set to true.

AUTHOR

Kent Lindquist
Printer icon