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

 

NAME

Oorb::Orb, Oorb::LogMsg::Severity, Oorb::Command - Building-block elements of the oorb library

SYNOPSIS

-loorb $(ORBLIBS)

#include "oorb.h"

namespace Oorb

class Orb

enum LogMsg::Severity

struct Command

DESCRIPTION

This page describes several basic entities which are used within the Oorb(3) library. The Orb class represents orbserver(1)s. The LogMsg struct is used internally to Oorb(3), and thus undocumented, however it is worthwhile listing the possible values of the LogMsg::Severity enum. For detail on the meanings of these verbosity levels, see Oorb::LogMgrTask(3):

enum LogMsg::Severity : int {
       QUIET = -1,
       NOTIFY = 0,
       VERBOSE,
       VERBOSE_VERY,
       VERBOSE_EXTREMELY,
       VERBOSE_DUMP,
       VERBOSE_TORRENTIALLY,
       COMPLAIN,
       DIE,
       DIE_INITIALIZING,
       DEBUG,
       SCAFFOLD,
       SCAFFOLD_FEATURE,
       }

The Command struct is used within Oorb(3)-based programs to post commands to individual Oorb::Task(3)s. The structure contains a pointer to a LogMsg structure for internal use, as well as to a generic parameter-file structure Pf (per pf(3)) for passing Antelope parameter files to commands. These parameter-files should be in freshly allocated memory that can be freed by the Command destructor when necessary. The structure is as follows:
struct 	Command {
                                Command( void );
                                ~Command( void );
    enum { NULLCOMMAND,
           LOG,
           STARTCONNECTION,
           STOPTASK,
           USERCOMMAND
           }                    command;
    LogMsg*                     logMsg;
    Pf*                         pf;
};

The last value in the Command::command enum is Command::USERCOMMAND, which can be used to index one or more user-defined commands. For example after the first, subsequent user-defined commands could be labelled Command::USERCOMMAND+1, Command::USERCOMMAND+2 etc.

CONSTRUCTORS

LIBRARY

-loorb $(ORBLIBS)

ATTRIBUTES

MT-Safe

SEE ALSO

Oorb(3)

BUGS AND CAVEATS

Not all entities in the Oorb(3) library are documented, only those which are likely be used by application programmers creating subclasses and programs.

AUTHOR

Kent Lindquist
Printer icon