LBM .Net API Documentation
LBMSDMessage Class
Namespacescom.latencybusters.lbm.sdmLBMSDMessage
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.
Declaration Syntax
C#
public class LBMSDMessage : LBMSDM, 
	ICloneable
Members
All MembersConstructorsMethodsFields



IconMemberDescription
LBMSDMessage()()()
Create an empty SDM message

LBMSDMessage(LBMSDMFieldsAttribute)
Create an empty SDM message using a field set attribute

LBMSDMessage(LBMSDMFields)
Create an SDM message with a predefined set of fields

add(LBMSDMField)
Add a field to a message - the field set will be automatically created if needed

Clone()()()
Clone an SDM message

count()()()
Count the number of fields in a message

data()()()
Get a byte buffer (array) to a raw SDM message in network order. This buffer can be transmitted, for example via a socket

debug_level
Debug mask for SDM implementation.
(Inherited from LBMSDM.)
get(Int32)
Get a field by the index

get_attr()()()
Get the field set attributes are associated with this message A copy is returned

get_fset()()()
Get the field set that is associated with this message

length()()()
Get the raw length of the message. This API will rebuild the message. It is more efficient to call data() and get the length of the returned array instead of calling data() and length()

locate(String)
Locate a field by name

log(String)
Log an event. If debug level is set greater than 0, output to stderr
(Inherited from LBMSDM.)
parse(array<Byte>[]()[], Int32)
Parse a byte buffer containing a raw SDM message (as received on a socket) to fill the SDM message object. The byte buffer must be in network order
for example if the message has bad data

parse(array<Byte>[]()[])
Parse a byte buffer containing a raw SDM message (as received on a socket) to fill the SDM message object. The byte buffer must be in network order
for example if the message has bad data

remove(Int32)
Remove a field by specifying the index

remove(String)
Remove a field by specifying the name

set(LBMSDMFields)
Add to the SDM message a set of fields. This copies the reference, so the caller must retain the field set until the message no longer needs the field set.

set(LBMSDMField)
Set an SDM message field. The field name must exist already.

set(LBMSDMField, Int32)
Set an SDM message field based on the message element index. The field must exist already.

set(LBMSDMField, Int32, Int32)
Set an SDM message field based on the message element index and the array index.

set_debug_level(Int32)
Set the debug level for processing this SDM message. Currently all debugs go to standard out.
(Inherited from LBMSDM.)
test_clone(LBMSDMessage)
An api that is used during testing to ensure that cloned objects are truly cloned. This API is not for general use.

toDbgString()()()
Dump an internal (ascii) representation of this message

ToString()()()
Dump a string (ascii) representation of this message
(Overrides Object.ToString()()().)
Inheritance Hierarchy
Object
LBMSDM
 LBMSDMessage

Assembly: lbmcssdm (Module: lbmcssdm) Version: 6.7.1.0