OSB_LIB::RecordStream Class Reference

List of all members.

---

Detailed Description

Enumerations for record streams.

This purely static class defines enumerations used in record streams and conversions to database datatypes.

Definition at line 69 of file recordstreamdef.h.

Public Types

• rsUnknown = -1

  Unknown record stream status.
  

• rsReady = 0

  Record stream is ready to process.
  

• rsProcessing = 1

  Record stream is currently processing.
  

• rsReserved = 2

  Record stream is reserved, record are being generated.
  

• rsProcessed = 3

  Record stream is processed.
  

• rsManual = 4

  Record stream that requires manual intervention to correct error cdrs.
  

• rsAppError = 5

  Processing of the whole record stream failed due to an application error.
  

• rsExcluded = 6

  Record stream is manually excluded from processing.
  

• stUnknown = '\0'

  Unknown record stream type.
  

• stIncoming = 'i'

  Record stream generated from the external source.
  

• stRegular = 'r'

  Record stream generated by the OSB for processed records.
  

• stError = 'e'

  Record stream contains error records.
  

• stFilter = 'f'

  Record stream contains filtered records.
  

• smUnknown = '\0'

  Unknown record stream media.
  

• smFile = 'f'

  Record stream is obtained by file.
  

• smSocket = 't'

  Record stream is obtained through socket.
  

• smDatabase = 'd'

  The records of this stream are stored in the database.
  

• enum Status {
    rsUnknown = -1, rsReady = 0, rsProcessing = 1, rsReserved = 2,
    rsProcessed = 3, rsManual = 4, rsAppError = 5, rsExcluded = 6
  }

  Status of a record stream. More...
  

• enum Type {
    stUnknown = '\0', stIncoming = 'i', stRegular = 'r', stError = 'e',
    stFilter = 'f'
  }

  Type of a record stream. More...
  

• enum Media { smUnknown = '\0', smFile = 'f', smSocket = 't', smDatabase = 'd' }

  Media of a record stream. More...
  

Static Public Member Functions

• static Status toStatus (long s)

  Convert a long into Status.
  

• static long toLong (Status s)

  Convert Status into long.
  

• static Type toType (char c)

  Convert a char into Type.
  

• static char toChar (Type t)

  Convert Type into char.
  

• static Media toMedia (char c)

  Convert a char into Media.
  

• static char toChar (Media m)

  Convert Media into char.
  

Private Member Functions

• RecordStream ()

  Prevent construction: not implemented.
  

---

Member Enumeration Documentation

enum OSB_LIB::RecordStream::Media

Media of a record stream.

Enumerator:

smUnknown	Unknown record stream media.
smFile	Record stream is obtained by file.
smSocket	Record stream is obtained through socket.
smDatabase	The records of this stream are stored in the database.

Definition at line 112 of file recordstreamdef.h.

enum OSB_LIB::RecordStream::Status

Status of a record stream.

Enumerator:

rsUnknown	Unknown record stream status.
rsReady	Record stream is ready to process.
rsProcessing	Record stream is currently processing.
rsReserved	Record stream is reserved, record are being generated.
rsProcessed	Record stream is processed.
rsManual	Record stream that requires manual intervention to correct error cdrs.
rsAppError	Processing of the whole record stream failed due to an application error.
rsExcluded	Record stream is manually excluded from processing.

Definition at line 72 of file recordstreamdef.h.

enum OSB_LIB::RecordStream::Type

Type of a record stream.

Enumerator:

stUnknown	Unknown record stream type.
stIncoming	Record stream generated from the external source.
stRegular	Record stream generated by the OSB for processed records.
stError	Record stream contains error records.
stFilter	Record stream contains filtered records.

Definition at line 98 of file recordstreamdef.h.

---

Constructor & Destructor Documentation

OSB_LIB::RecordStream::RecordStream

(

)

[private]

Prevent construction: not implemented.

---

Member Function Documentation

static char OSB_LIB::RecordStream::toChar

(

Media

m

)

[static]

Convert Media into char.

Parameters:

m

Media to convert.

Returns:

The character that corresponds to m, (char)smUnknown if m is not valid.

static char OSB_LIB::RecordStream::toChar

(

Type

t

)

[static]

Convert Type into char.

Parameters:

t

Type to convert.

Returns:

The character that corresponds to t, (char)stUnknown if t is not valid.

static long OSB_LIB::RecordStream::toLong

(

Status

s

)

[inline, static]

Convert Status into long.

Parameters:

s

Status to convert.

Returns:

The long that corresponds to s, (long)rsUnknown if s is not valid.

Definition at line 139 of file recordstreamdef.h.

References toStatus().

static Media OSB_LIB::RecordStream::toMedia

(

char

c

)

[static]

Convert a char into Media.

Parameters:

c

Character to convert.

Returns:

The Media that corresponds to c, smUnknown if c is not valid.

static Status OSB_LIB::RecordStream::toStatus

(

long

s

)

[static]

Convert a long into Status.

Parameters:

s

Value to convert.

Returns:

The Status that corresponds to s, rsUnknown if s is not valid.

Referenced by toLong().

static Type OSB_LIB::RecordStream::toType

(

char

c

)

[static]

Convert a char into Type.

Parameters:

c

Character to convert.

Returns:

The Type that corresponds to c, stUnknown if c is not valid.

---

The documentation for this class was generated from the following file:

• recordstreamdef.h

---