LBM .Net API Documentation
com.latencybusters.lbm.sdm Namespace
Namespacescom.latencybusters.lbm.sdm
LBM Self Describing Message (SDM) Classes
Declaration Syntax
C#
namespace com.latencybusters.lbm.sdm
Types
All TypesClasses
IconTypeDescription
LBMSDM
class LBMSDM is the parent class from which the core SDM functionality derives.

LBMSDMAddingFieldException
An LBM SDM Exception indicating an error occurred adding a field. Where possible, additional field data is dumped.

LBMSDMArrayBlob
Implements an SDM Field that is an array of BLOBs (Binary Large OBjects).

LBMSDMArrayBool
Implements an SDM Field that is an array of Booleans.

LBMSDMArrayDecimal
Implements an SDM Field that is an array of Decimals.

LBMSDMArrayDouble
Implements an SDM Field that is an array of Doubles.

LBMSDMArrayFloat
Implements an SDM Field that is an array of Floats

LBMSDMArrayInt16
Implements an SDM Field that is an array of 16 bit integers.

LBMSDMArrayInt32
Implements an SDM Field that is an array of 32 bit integers.

LBMSDMArrayInt64
Implements an SDM Field that is an array of 64 bit integers.

LBMSDMArrayInt8
Implements an SDM Field that is an array of 8 bit integers.

LBMSDMArrayMessage
Implements an SDM Field that is an array of SDM messages

LBMSDMArrayString
Implements an SDM Field that is an array of Strings

LBMSDMArrayTimestamp
Implements an SDM Field that is an array of Timestamps.

LBMSDMArrayUint16
Implements an SDM Field that is an array of unsigned 16 bit integers.

LBMSDMArrayUint32
Implements an SDM Field that is an array of unsigned 32 bit integers.

LBMSDMArrayUint64
Implements an SDM Field that is an array of unsigned 64 bit integers.

LBMSDMArrayUint8
Implements an SDM Field that is an array of unsigned 8 bit integers.

LBMSDMArrayUnicode
Implements an SDM Field that is an array of unicode strings

LBMSDMBadRawObjectException
An LBM SDM Exception indicating a bad raw object was encountered Where possible, additional data about the raw object is dumped.

LBMSDMBadTypeException
SDM Exception that occurs when bad field type is encountered

LBMSDMCannotConvertException
An LBM SDM Exception indicating that conversion to or from an SDM field could not be achieved.

LBMSDMDuplicateFieldException
An LBM SDM Exception indicating a duplicate field exists - probably when adding a field. Where possible, additional field data is dumped.

LBMSDMessage
LBMSDMessage is the main class for managing an LBM SDM message. It heavily relies on class LBMSDMFields to collect LBMSDMField and LBMSDMArray classes in to a message. LBMSDMessage is the primary interface for applications.

LBMSDMException
LBMSDMException is the base exception class for LBM SDM Exceptions. It relies on LBMException and is included as a place holder for future development

LBMSDMField
LBMSDMField is the base class for all LBM SDM field types. All base LBM SDM field types use the naming convention LBMSDMField(Type). Field arrays are subclasses of the respective field class and use the naming convention LBMSDMArray(Type). LBMSDMRaw(BaseType) is used as the naming convention for raw data types where needed and support the respective LBMSDMField(Type) classes.

LBMSDMFieldBlob
Implements an SDM Field of type BLOB (Binary Large OBject)

LBMSDMFieldBool
Implements an SDM Field of type boolean

LBMSDMFieldDecimal
Implements an SDM Field of type Decimal

LBMSDMFieldDouble
Implements an SDM Field of type Double

LBMSDMFieldFloat
Implements an SDM Field of type Float

LBMSDMFieldInt16
Implements an 16 bit integer SDM Field

LBMSDMFieldInt32
Implements an 32 bit integer SDM Field

LBMSDMFieldInt64
Implements an 64 bit integer SDM Field

LBMSDMFieldInt8
Implements an 8 bit integer SDM Field

LBMSDMFieldIsNullException
An LBM SDM Exception indicating an null field is encountered

LBMSDMFieldIterator
An iterator for field sets. This allows applications to iterate over every field in an SDM message/field set

LBMSDMFieldMessage
Implements an SDM Field that encapsulates an SDM message

LBMSDMFields
LBMSDMFields is a utility class for LBMSDMessage to collect a set of fields. The intent of separating the set of fields from LBMSDMessage is to encourage reuse of the field set.

LBMSDMFieldsAttribute
LBMSDMFieldsAttribute define the attributes used by LBMSDMFields. Currently the only option is to set the number of preallocated fields on a field set (message). In the future, other options will be added.

LBMSDMFieldString
Implements an SDM Field of type String

LBMSDMFieldTimestamp
Implements an SDM Field of type Timestamp.

LBMSDMFieldUint16
Implements an unsigned 16 bit integer SDM Field

LBMSDMFieldUint32
Implements an unsigned 32 bit integer SDM Field

LBMSDMFieldUint64
Implements an unsigned 64 bit integer SDM Field

LBMSDMFieldUint8
Implements an unsigned 8 bit integer SDM Field

LBMSDMFieldUnicode
Implements an SDM Field of type unicode string

LBMSDMInsufficientSpaceException
An LBM SDM Exception indicating a buffer was provided which was too small for the operation.

LBMSDMNameTooLongException
An LBM SDM Exception indicating a name provided was too long for an SDM Field. The limit is 255 characters.

LBMSDMNotArrayException
An LBM SDM Exception indicating an array operation was requested on a non array type field.

LBMSDMOutOfRangeException
An LBM SDM Exception indicating a value was provided but is out of range. Where possible, additional data about the invalid data and the valid range is dumped.

LBMSDMRaw
LBMSDMRaw is the base class for raw data type classes. Raw data type classes are used to hide the hardware or language idiosyncrasies from the main classes. For example, Java does not natively support unsigned data types. Derived classes of LBMSDMRaw allow these idiosyncrasies to be minimised.

LBMSDMRawBlob
An LBMSDMRawBlob is a helper class to minimise the effort of formatting and parsing Binary Large OBjects (BLOBs)

LBMSDMRawDecimal
An LBMSDMRawDecimal is a helper class to minimise the effort of formatting and parsing Decimals

LBMSDMRawDouble
An LBMSDMRawDouble is a helper class to minimise the effort of formatting and parsing Doubles

LBMSDMRawFloat
An LBMSDMRawFloat is a helper class to minimise the effort of formatting and parsing Floats

LBMSDMRawInt64
An LBMSDMRawInt64 is a helper class to minimise the effort of formatting and parsing 64 bit integers

LBMSDMRawTimestamp
An LBMSDMRawTimestamp is a helper class to minimise the effort of formatting and parsing Timestamps. A Timestamp is the number of seconds and microseconds since Unix epoch

LBMSDMRawUint16
An LBMSDMRawUint16 is a helper class to minimise the effort of formatting and parsing unsigned 16 bit integers

LBMSDMRawUint32
An LBMSDMRawUint32 is a helper class to minimise the effort of formatting and parsing unsigned 32 bit integers

LBMSDMRawUint64
An LBMSDMRawUint64 is a helper class to minimise the effort of formatting and parsing unsigned 64 bit integers

LBMSDMTypeMismatchException
An LBM SDM Exception indicating there is a mismatch between field types. Where possible, additional field data is dumped.

LBMSDMTypeNotSupportedException
An LBM SDM Exception indicating that a field was encountered for an unsupported type.