DsLogAdmin Namespace Reference

CORBA Common Object Services: Logging Service. More...


Classes

exception  InvalidParam
 Exception that indicates an invalid parameter. More...
exception  InvalidThreshold
 Exception that indicates that the supplied threshold values were invalid. More...
exception  InvalidTime
 Exception that indicates that a supplied time value was invalid. More...
exception  InvalidTimeInterval
 Exception that indicates that a supplied time interval was invalid. More...
exception  InvalidMask
 Exception that indicates that a supplied week mask was invalid. More...
exception  LogIdAlreadyExists
 Exception that indicates that the desired log identification number is not available. More...
exception  InvalidGrammar
 Exception that indicates that the required grammar for a match operation is not supported by the log service. More...
exception  InvalidConstraint
 Exception that indicates that the supplied constraint could not be parsed by the grammar used for a match operation. More...
exception  LogFull
 Exception that indicates that a log is full. More...
exception  LogOffDuty
 Exception which indicates that the log's availability status is "off_duty", i.e. More...
exception  LogLocked
 Exception that indicates that a log is locked. More...
exception  LogDisabled
 Exception which indicates that the log's operational state is "disabled", i.e. More...
exception  InvalidRecordId
 Exception that indicates that a log identifier is invalid. More...
exception  InvalidAttribute
 Exception that indicates that a log attribute was invalid. More...
exception  InvalidLogFullAction
 Exception that indicates that a supplied log full action is not supported by the log service. More...
struct  NVPair
 A name/value pair used for log attributes. More...
struct  TimeInterval
 A time interval consists of an absolute start and stop time. More...
struct  LogRecord
 A log record consists of an identifier, a time stamp, the log record attributes (a sequence of name/value pairs) and the log record information. More...
interface  Iterator
 The iterator is used when a query or retrieve operation is returning a large number of log records. More...
struct  AvailabilityStatus
 The availability status contains information about whether or not the log is on duty and whether or not the log is full. More...
struct  Time24
 A time of day. More...
struct  Time24Interval
 A interval of a day. More...
struct  WeekMaskItem
 A week mask item. More...
exception  UnsupportedQoS
 Exception that indicates that some of the supplied QoS values were invalid. More...
interface  Log
 The base log interface supported by all logs in the log service. More...
interface  BasicLog
 The basic log interface is a concrete Log. More...
interface  LogMgr
 The base log maanger interface supported by all log factories. More...
interface  BasicLogFactory
 The basic log factory is a concrete LogMgr. More...

Typedefs

typedef unsigned long LogId
typedef unsigned long long RecordId
typedef sequence< RecordIdRecordIdList
typedef string Constraint
typedef TimeBase::TimeT TimeT
typedef sequence< NVPairNVList
typedef sequence< LogRecordRecordList
typedef sequence< any > Anys
typedef unsigned short LogFullActionType
typedef sequence< Time24IntervalIntervalsOfDay
typedef unsigned short DaysOfWeek
typedef sequence< WeekMaskItemWeekMask
typedef unsigned short Threshold
typedef sequence< ThresholdCapacityAlarmThresholdList
typedef unsigned short QoSType
typedef sequence< QoSTypeQoSList
typedef sequence< LogLogList
typedef sequence< LogIdLogIdList

Enumerations

enum  OperationalState { disabled, enabled }
 The operational state of a log can be either enabled or disabled. More...
enum  AdministrativeState { locked, unlocked }
 The administrative state of a log can be either locked or unlocked. More...
enum  ForwardingState { on, off }
 The forwarding state of a log can be either on or off. More...

Variables

const string default_grammar = "EXTENDED_TCL"
const LogFullActionType wrap = 0
 The wrap log full action indicates that the log should delete old records if the log is full.
const LogFullActionType halt = 1
 The halt log full action indicates that the log should stop writing any more records if the log is full.
const unsigned short Sunday = 1
const unsigned short Monday = 2
const unsigned short Tuesday = 4
const unsigned short Wednesday = 8
const unsigned short Thursday = 16
const unsigned short Friday = 32
const unsigned short Saturday = 64
const QoSType QoSNone = 0
const QoSType QoSFlush = 1
const QoSType QoSReliability = 2


Detailed Description

CORBA Common Object Services: Logging Service.

The detailed specification is available from the Object Managament Group.

Author:
OMG
Version:
Version 99-05-01


Typedef Documentation

typedef unsigned long DsLogAdmin::LogId

typedef unsigned long long DsLogAdmin::RecordId

typedef sequence<RecordId> DsLogAdmin::RecordIdList

typedef string DsLogAdmin::Constraint

typedef TimeBase::TimeT DsLogAdmin::TimeT

typedef sequence<NVPair> DsLogAdmin::NVList

typedef sequence<LogRecord> DsLogAdmin::RecordList

typedef sequence<any> DsLogAdmin::Anys

typedef unsigned short DsLogAdmin::LogFullActionType

typedef sequence<Time24Interval> DsLogAdmin::IntervalsOfDay

typedef unsigned short DsLogAdmin::DaysOfWeek

typedef sequence<WeekMaskItem> DsLogAdmin::WeekMask

typedef unsigned short DsLogAdmin::Threshold

typedef sequence<Threshold> DsLogAdmin::CapacityAlarmThresholdList

typedef unsigned short DsLogAdmin::QoSType

typedef sequence<QoSType> DsLogAdmin::QoSList

typedef sequence<Log> DsLogAdmin::LogList

typedef sequence<LogId> DsLogAdmin::LogIdList


Enumeration Type Documentation

enum DsLogAdmin::OperationalState

The operational state of a log can be either enabled or disabled.

The log is disabled if it encountered some runtime problem that prevents it from writing any more log records.

Enumerator:
disabled 
enabled 

enum DsLogAdmin::AdministrativeState

The administrative state of a log can be either locked or unlocked.

If locked, no records can be written to the log. This state can be set directly on the log.

Enumerator:
locked 
unlocked 

enum DsLogAdmin::ForwardingState

The forwarding state of a log can be either on or off.

unlocked. If set to off, this log will not forward any log records. This state can be set directly on the log.

Enumerator:
on 
off 


Variable Documentation

const string DsLogAdmin::default_grammar = "EXTENDED_TCL"

const LogFullActionType DsLogAdmin::wrap = 0

The wrap log full action indicates that the log should delete old records if the log is full.

const LogFullActionType DsLogAdmin::halt = 1

The halt log full action indicates that the log should stop writing any more records if the log is full.

const unsigned short DsLogAdmin::Sunday = 1

const unsigned short DsLogAdmin::Monday = 2

const unsigned short DsLogAdmin::Tuesday = 4

const unsigned short DsLogAdmin::Wednesday = 8

const unsigned short DsLogAdmin::Thursday = 16

const unsigned short DsLogAdmin::Friday = 32

const unsigned short DsLogAdmin::Saturday = 64

const QoSType DsLogAdmin::QoSNone = 0

const QoSType DsLogAdmin::QoSFlush = 1

const QoSType DsLogAdmin::QoSReliability = 2