LBM .Net API Documentation
LBMSource Class
Namespacescom.latencybusters.lbmLBMSource
LBM Source class.
Declaration Syntax
C#
public class LBMSource : IDisposable
Members
All MembersConstructorsMethods



IconMemberDescription
LBMSource(LBMContext, LBMTopic)
Instantiate an LBM Source object associated with a given context and topic

LBMSource(LBMContext, LBMTopic, LBMSourceEventCallback, Object)
Instantiate an LBM Source object associated with a given context and topic and initialize source event callback

LBMSource(LBMContext, LBMTopic, LBMEventQueue)
Instantiate an LBM Source object associated with a given context, topic, and event queue

LBMSource(LBMContext, LBMTopic, LBMSourceEventCallback, Object, LBMEventQueue)
Instantiate an LBM Source object associated with a given context, topic, and event queue and initialize source event callback

addSourceCallback(LBMSourceEventCallback)
Register a source event callback

addSourceCallback(LBMSourceEventCallback, Object)
Register a source event callback (and callback token)

buffAcquire(IntPtr%, UInt32, Int32)
Acquire a pointer to a buffer of the specified length, to be filled in and sent later. Warning: this API is NOT thread safe between sources on the same transport session. For thread safety, use the send(array<Byte>[]()[], Int32, Int32) api.

buffsCancel()()()
Cancels all outstanding (not yet completed) buffers previously acquired using buffAcquire(IntPtr%, UInt32, Int32) or buffsCompleteAndAcquire(IntPtr%, UInt32, Int32). All such acquired but not completed buffers for this source (only) will no longer be received by any receives.

buffsComplete()()()
Sends all buffers on a transport session that had ben previously acquired. Warning: this API is NOT thread safe between sources on the same transport session.

buffsCompleteAndAcquire(IntPtr%, UInt32, Int32)
First sends all buffers on a transport session that had ben previously acquired, and then acquires a pointer to a buffer of the specified length, to be filled in and sent later. Warning: this API is NOT thread safe between sources on the same transport session.

close()()()
Close and dispose of this source

createChannel(Int64)
Create a channel object to send messages with the given channel number.

deleteChannel(LBMSourceChannelInfo)
Deletea channel object

Dispose()()()
Same as close()()()

dumpAttributeList()()()
Dump source configuration options

Finalize()()()
LBMSource finalization
(Overrides Object.Finalize()()().)
flush()()()
Send messages from both the explicit and implicit batches ASAP.

getAttributeValue(String)
Returns the value of a source-related attribute for this source

getInflight(Int32)
Get the current inflight value for this source

getInflight(Int32, Int32%, UInt64%)
Get the current inflight values for message and bytes.

getStatistics()()()
Return the current set of source transport statistics for this source

isClosed()()()
Check if a source has been closed

removeSourceCallback(LBMSourceEventCallback)
Deregister a source event callback

removeSourceCallback(LBMSourceEventCallback, Object)
Deregister a source event callback

resetStatistics()()()
This will reset the transport statistics for this source.

send(array<Byte>[]()[], Int32, Int32)
Send a message to the topic associated with the LBM source

send(array<Byte>[]()[], Int32, Int32, Object)
Send a message to the topic associated with the LBM source

send(array<Byte>[]()[], Int32, Int32, LBMSourceSendExInfo)
Send a message to the topic associated with the LBM source

send(LBMRequest, Int32)
Send a request message to the topic associated with the LBM source

send(LBMRequest, LBMEventQueue, Int32)
Send a request message to the topic associated with the LBM source using a designated event queue for responses

send(LBMRequest, Int32, LBMSourceSendExInfo)
Send a request message to the topic associated with the LBM source using an designated event queue for responses

send(LBMRequest, LBMEventQueue, Int32, LBMSourceSendExInfo)
Send a request message to the topic associated with the LBM source using an designated event queue for responses

setAttributeValue(String, String)
Set the value of a source-related attribute for this source

setInflight(Int32, LBMSetInflightCallback, Object)
Set the current inflight value for this source

setInflight(Int32, Int32%, UInt64%, LBMSetInflightCallbackEx, Object)
Set the current inflight messages and bytes for this source. Note that increasing one value while decreasing the other is not allowed. If you need to do this, call setInflight twice using 0 as the value for the one you are not changing.

setUMEMessageStable(Int64)
Mark a specific sqn as stable, triggering an event if configured to do so, and adjusting the inflight if necessary

umederegister()()()
Deregister the UME Source

Remarks
Warning: It is not safe to instantiate this object from a context thread.
Inheritance Hierarchy

Assembly: lbmcs (Module: lbmcs) Version: 6.7.1.0