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

 

NAME

Oorb::LogMgrTask - Log-message manager task for the oorb library

SYNOPSIS

-loorb $(ORBLIBS)

#include "oorb.h"

namespace Oorb

class LogMgrTsk

DESCRIPTION

The LogMgrTask manages log messages for programs written with the Oorb(3) library. An instance of LogMgrTask is started automatically by the Oorb::Master(3) object, within the latter's run method. Given the availability of this object through the Om variable, as documented in Oorb::Master(3), log messages may be emitted throughout the program with calls such as

Om->log()->notify( (char*) "Message" );

CONSTRUCTORS

METHODS

Notifications

The following routines all take a msg variable containing the message to emit; a caller variable intended to contain the name of the calling method, to be used in highly verbose output for debugging purposes; and an includeSyserr boolean value indicating whether or not system error messages are to be included in the output. All of these routines are based on the elog(3) family of routines, and are thus subject to the control mechanisms (e.g. environment variables) of that family of routines. Internally, these routines examine both the task-level verbosity setting of the task that called them, and the program-level verbosity setting of the enclosing program, and then emit messages if either one of those values meets or exceeds the verbosity level of the method in question. Each verbosity level includes all of the lower verbosity levels underneath it. For example, a program in very verbose mode will also emit all the messages classified as notify or verbose.

OBJECT CONFIGURATION PARAMETERS

The LogMgrTask object contains a public member struct of name m_logParams which is defined as follows:

typedef struct logParamsStruct {
    char*    write_to_queue;
} logParamsStruct;

LIBRARY

-loorb $(ORBLIBS)

ATTRIBUTES

MT-Safe

SEE ALSO

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

BUGS AND CAVEATS

Attempts to set the run state of the LogMgrTask to false will be ignored. To avoid recursion loops, messages at extremely verbose output levels and above will not be echoed to an orbserver(1), even if the write_to_queue option is enabled.

AUTHOR

Kent Lindquist
Printer icon