com.latencybusters.lbm
Class LBMSourceStatistics

java.lang.Object
  com.latencybusters.lbm.LBMSourceStatistics

public class LBMSourceStatistics
extends java.lang.Object

LBM Source Transport Statistics

Constructor Summary

LBMSourceStatistics()
Instantiate an empty object containing no statistics.

LBMSourceStatistics(LBMContext lbmctx, int maxStats)
Instantiate object containing the current set of source transport statistics for a given LBM context This constructor will throw LBMMonitorEInvalException if maxStats is less than the available number of transport statistical sets.

LBMSourceStatistics(LBMSource lbmsrc)
Instantiate object containing the current set of source transport statistics for a given LBM source.

Method Summary

long	bytesBuffered() Number of bytes currently in UM's TCP buffer, i.e., a snapshot (TCP only).
long	bytesBuffered(int n) Number of bytes currently in UM's TCP buffer, i.e., a snapshot (TCP only).
long	bytesSent() Number of datagram bytes sent (LBT-RM, LBT-RU, LBT-IPC, LBT-RDMA).
long	bytesSent(int n) Number of datagram bytes sent (LBT-RM, LBT-RU, LBT-IPC, LBT-RDMA).
void	dispose() Free memory associated with this set of statistics.
protected void	finalize()
java.lang.String	getApplicationSourceId() Retrieve the application source identifier associated with this set of statistics.
long	getContextId() Retrieve the sending context ID associated with this set of statistics.
long	getProcessId() Retrieve the sending process ID associated with this set of statistics.
java.net.InetAddress	getSender() Retrieve the IP sender address associated with this set of statistics.
java.util.Date	getTimestamp() Retrieve the timestamp associated with this set of statistics.
long	messagesQueued() Number of datagrams currently queued by the data rate limiter (LBT-RM only).
long	messagesQueued(int n) Number of datagrams currently queued by the data rate limiter (LBT-RM only).
long	messagesSent() Number of datagrams sent (LBT-RM, LBT-RU, LBT-IPC, LBT-RDMA).
long	messagesSent(int n) Number of datagrams sent (LBT-RM, LBT-RU, LBT-IPC, LBT-RDMA).
long	nakPacketsReceived() Number of NAK packets received by this source transport (LBT-RM, LBT-RU).
long	nakPacketsReceived(int n) Number of NAK packets received by this source transport (LBT-RM, LBT-RU).
long	naksIgnored() Number of NAKs the source ignored and sent an NCF with reason code "ignored" (LBT-RM, LBT-RU).
long	naksIgnored(int n) Number of NAKs the source ignored and sent an NCF with reason code "ignored" (LBT-RM, LBT-RU).
long	naksIgnoredRetransmitDelay() Number of NAKs this source did not process because doing so would exceed its retransmit rate limit (LBT-RM, LBT-RU).
long	naksIgnoredRetransmitDelay(int n) Number of NAKs this source did not process because doing so would exceed its retransmit rate limit (LBT-RM, LBT-RU).
long	naksReceived() Number of individual NAKs received by the source transport (LBT-RM, LBT-RU).
long	naksReceived(int n) Number of individual NAKs received by the source transport (LBT-RM, LBT-RU).
long	naksShed() Number of NAKs this source shed and sent an NCF with reason code "shed" (LBT-RM, LBT-RU).
long	naksShed(int n) Number of NAKs this source shed and sent an NCF with reason code "shed" (LBT-RM, LBT-RU).
long	numberOfClients() Number of receiver clients currently connected over this transport (TCP, LBT-RU, LBT-IPC, LBT-RDMA).
long	numberOfClients(int n) Number of receiver clients currently connected over this transport (TCP, LBT-RU, LBT-IPC, LBT-RDMA).
void	refresh(LBMContext lbmctx, int maxStats) Refresh source transport statistics for a given LBM context.
void	refresh(LBMSource lbmsrc) Refresh source transport statistics for a given LBM source
long	retransmissionBytesSent() Number of bytes retransmitted by this source transport (LBT-RM, LBT-RU).
long	retransmissionBytesSent(int n) Number of bytes retransmitted by this source transport (LBT-RM, LBT-RU).
long	retransmissionsQueued() Number of retransmission datagrams currently queued by the retransmit rate limiter (LBT-RM only).
long	retransmissionsQueued(int n) Number of retransmission datagrams currently queued by the retransmit rate limiter (LBT-RM only).
long	retransmissionsSent() Number of datagrams retransmitted by this source transport (LBT-RM, LBT-RU).
long	retransmissionsSent(int n) Number of datagrams retransmitted by this source transport (LBT-RM, LBT-RU).
protected void	setApplicationSourceId(java.lang.String appid)
protected void	setContextId(long cid)
protected void	setProcessId(long pid)
protected void	setSender(long ip)
protected void	setTimestamp(long ts)
int	size() Number of statistical sets encapsulated within this object
java.lang.String	source() Source of a transport as a string.
java.lang.String	source(int n) Source of a transport as a string.
long	transmissionWindowBytes() Number of bytes currently in the transmission window (LBT-RM only).
long	transmissionWindowBytes(int n) Number of bytes currently in the transmission window (LBT-RM only).
long	transmissionWindowMessages() Number of datagrams in the transmission window (LBT-RM only).
long	transmissionWindowMessages(int n) Number of datagrams in the transmission window (LBT-RM only).
int	type() Transport type (TCP, LBT-RM, LBT-RU, etc.).
int	type(int n) Transport type (TCP, LBT-RM, LBT-RU, etc.).
java.lang.String	typeName() Transport type name (TCP, LBT-RM, LBT-RU, etc.).
java.lang.String	typeName(int n) Transport type name (TCP, LBT-RM, LBT-RU, etc.).

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LBMSourceStatistics

public LBMSourceStatistics()

Instantiate an empty object containing no statistics.

LBMSourceStatistics

public LBMSourceStatistics(LBMContext lbmctx,
                           int maxStats)
                    throws LBMException

Instantiate object containing the current set of source transport statistics for a given LBM context This constructor will throw LBMMonitorEInvalException if maxStats is less than the available number of transport statistical sets.

Parameters:

lbmctx - LBMContext object associated with statistics to be retrieved

maxStats - Maximum number of statistical sets to retrieve

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

refresh(com.latencybusters.lbm.LBMContext, int)

LBMSourceStatistics

public LBMSourceStatistics(LBMSource lbmsrc)
                    throws LBMException

Instantiate object containing the current set of source transport statistics for a given LBM source.

Parameters:

lbmsrc - LBMSource object

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

refresh(com.latencybusters.lbm.LBMContext, int)

Method Detail

refresh

public void refresh(LBMContext lbmctx,
                    int maxStats)
             throws LBMException

Refresh source transport statistics for a given LBM context. This method will throw LBMMonitorEInvalException if maxStats is less than the available number of transport statistical sets.

Parameters:

lbmctx - LBMContext object associated with statistics to be retrieved

maxStats - Maximum number of statistical sets to retrieve

Throws:

LBMException - if any error occurred retrieving source statistics.

refresh

public void refresh(LBMSource lbmsrc)
             throws LBMException

Refresh source transport statistics for a given LBM source

Parameters:

lbmsrc - LBMSource object

Throws:

LBMException - if any error occurred retrieving source statistics.

dispose

public void dispose()

Free memory associated with this set of statistics.

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

size

public int size()

Number of statistical sets encapsulated within this object

Returns:

Statistical set size

type

public int type()
         throws LBMException

Transport type (TCP, LBT-RM, LBT-RU, etc.). This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Transport type

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMSourceStatistics(LBMSource), LBM

type

public int type(int n)
         throws LBMException

Transport type (TCP, LBT-RM, LBT-RU, etc.). This method returns a value from the nth set of statistics encapsulated within this object.

Parameters:

n - Statistics set index

Returns:

Transport type

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBM

typeName

public java.lang.String typeName()
                          throws LBMException

Transport type name (TCP, LBT-RM, LBT-RU, etc.). This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Transport type name

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMSourceStatistics(LBMSource)

typeName

public java.lang.String typeName(int n)
                          throws LBMException

Transport type name (TCP, LBT-RM, LBT-RU, etc.). This method returns a value from the nth set of statistics encapsulated within this object.

Parameters:

n - Statistics set index

Returns:

Transport type name

Throws:

LBMException - if any error occurred retrieving source statistics.

source

public java.lang.String source()
                        throws LBMException

Source of a transport as a string. The string format depends on transport type and is described under LBMTransportSourceInfo. This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Source of transport as a string

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMTransportSourceInfo, LBMSourceStatistics(LBMSource)

source

public java.lang.String source(int n)
                        throws LBMException

Source of a transport as a string. The string format depends on transport type and is described under LBMTransportSourceInfo. This method returns a value from the nth set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Parameters:

n - Statistics set index

Returns:

Source of transport as a string

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMTransportSourceInfo

numberOfClients

public long numberOfClients()
                     throws LBMException

Number of receiver clients currently connected over this transport (TCP, LBT-RU, LBT-IPC, LBT-RDMA). This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Number of receiver clients currently connected over this transport

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMSourceStatistics(LBMSource)

numberOfClients

public long numberOfClients(int n)
                     throws LBMException

Number of receiver clients currently connected over this transport (TCP, LBT-RU, LBT-IPC, LBT-RDMA). This method returns a value from the nth set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Parameters:

n - Statistics set index

Returns:

Number of receiver clients currently connected over this transport

Throws:

LBMException - if any error occurred retrieving source statistics.

bytesBuffered

public long bytesBuffered()
                   throws LBMException

Number of bytes currently in UM's TCP buffer, i.e., a snapshot (TCP only). This count is affected by the number of receivers,and configuration options transport_tcp_multiple_receiver_behavior and transport_session_maximum_buffer. This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Number of bytes currently in UM's TCP buffer

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMSourceStatistics(LBMSource)

bytesBuffered

public long bytesBuffered(int n)
                   throws LBMException

Number of bytes currently in UM's TCP buffer, i.e., a snapshot (TCP only). This count is affected by the number of receivers,and configuration options transport_tcp_multiple_receiver_behavior and transport_session_maximum_buffer. This method returns a value from the nth set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Parameters:

n - Statistics set index

Returns:

Number of bytes currently in UM's TCP buffer

Throws:

LBMException - if any error occurred retrieving source statistics.

messagesSent

public long messagesSent()
                  throws LBMException

Number of datagrams sent (LBT-RM, LBT-RU, LBT-IPC, LBT-RDMA). Depending on batching settings, a single datagram may contain one or more messages, or a fragment of a larger message. With LBT-RM, larger messages are split into fragment sizes limited by configuration option transport_lbtrm_datagram_max_size (default 8KB). This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Number of datagrams sent

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMSourceStatistics(LBMSource)

messagesSent

public long messagesSent(int n)
                  throws LBMException

Number of datagrams sent (LBT-RM, LBT-RU, LBT-IPC, LBT-RDMA). Depending on batching settings, a single datagram may contain one or more messages, or a fragment of a larger message. With LBT-RM, larger messages are split into fragment sizes limited by configuration option transport_lbtrm_datagram_max_size (default 8KB). This method returns a value from the nth set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Parameters:

n - Statistics set index

Returns:

Number of datagrams sent

Throws:

LBMException - if any error occurred retrieving source statistics.

bytesSent

public long bytesSent()
               throws LBMException

Number of datagram bytes sent (LBT-RM, LBT-RU, LBT-IPC, LBT-RDMA). This is the total of lengths of all LBT-RM packets, including UM header information. This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Number of datagram bytes sent

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMSourceStatistics(LBMSource)

bytesSent

public long bytesSent(int n)
               throws LBMException

Number of datagram bytes sent (LBT-RM, LBT-RU, LBT-IPC, LBT-RDMA). This is the total of lengths of all LBT-RM packets, including UM header information. This method returns a value from the nth set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Parameters:

n - Statistics set index

Returns:

Number of datagram bytes sent

Throws:

LBMException - if any error occurred retrieving source statistics.

transmissionWindowMessages

public long transmissionWindowMessages()
                                throws LBMException

Number of datagrams in the transmission window (LBT-RM only). Each source transport session maintains a transmission window buffer (the size of which is set by transport_lbtrm_transmission_window_size, default 24MB). When the source transport receives a NAK, the corresponding message for retransmission must be found in this transmission window. This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Number of datagrams in the transmission window

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMSourceStatistics(LBMSource)

transmissionWindowMessages

public long transmissionWindowMessages(int n)
                                throws LBMException

Number of datagrams in the transmission window (LBT-RM only). Each source transport session maintains a transmission window buffer (the size of which is set by transport_lbtrm_transmission_window_size, default 24MB). When the source transport receives a NAK, the corresponding message for retransmission must be found in this transmission window. This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Parameters:

n - Statistics set index

Returns:

Number of datagrams in the transmission window

Throws:

LBMException - if any error occurred retrieving source statistics.

transmissionWindowBytes

public long transmissionWindowBytes()
                             throws LBMException

Number of bytes currently in the transmission window (LBT-RM only). Typically, this count approaches its window size or exceeds it by a small amount. See #txw_msgs for a description of the transmission window. This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Number of bytes currently in the transmission window

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMSourceStatistics(LBMSource)

transmissionWindowBytes

public long transmissionWindowBytes(int n)
                             throws LBMException

Number of bytes currently in the transmission window (LBT-RM only). Typically, this count approaches its window size or exceeds it by a small amount. See #txw_msgs for a description of the transmission window. This method returns a value from the nth set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Parameters:

n - Statistics set index

Returns:

Number of bytes currently in the transmission window

Throws:

LBMException - if any error occurred retrieving source statistics.

nakPacketsReceived

public long nakPacketsReceived()
                        throws LBMException

Number of NAK packets received by this source transport (LBT-RM, LBT-RU). UM batches NAKs into NAK packets to save network bandwidth. This should always be less than or equal to naksReceived (below). This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Number of NAK packets received by this source transport

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMSourceStatistics(LBMSource)

nakPacketsReceived

public long nakPacketsReceived(int n)
                        throws LBMException

Number of NAK packets received by this source transport (LBT-RM, LBT-RU). UM batches NAKs into NAK packets to save network bandwidth. This should always be less than or equal to naksReceived (below). This method returns a value from the nth set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Parameters:

n - Statistics set index

Returns:

Number of NAK packets received by this source transport

Throws:

LBMException - if any error occurred retrieving source statistics.

naksReceived

public long naksReceived()
                  throws LBMException

Number of individual NAKs received by the source transport (LBT-RM, LBT-RU). When a source transport receives a NAK from a receiver transport, it may respond by re-transmitting the requested LBT-RM datagram, or it may send an NCF. The NAKing receiver transport responds to the NCF by waiting (timeout set by transport_lbtrm_nak_suppress_interval, default 1000 ms), then re-sending the NAK. This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Number of individual NAKs received by this source transport

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMSourceStatistics(LBMSource)

naksReceived

public long naksReceived(int n)
                  throws LBMException

Number of individual NAKs received by the source transport (LBT-RM, LBT-RU). When a source transport receives a NAK from a receiver transport, it may respond by re-transmitting the requested LBT-RM datagram, or it may send an NCF. The NAKing receiver transport responds to the NCF by waiting (timeout set by transport_lbtrm_nak_suppress_interval, default 1000 ms), then re-sending the NAK. This method returns a value from the nth set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Parameters:

n - Statistics set index

Returns:

Number of individual NAKs received by this source transport

Throws:

LBMException - if any error occurred retrieving source statistics.

naksIgnored

public long naksIgnored()
                 throws LBMException

Number of NAKs the source ignored and sent an NCF with reason code "ignored" (LBT-RM, LBT-RU). A source transport ignores a NAK for a datagram it has already recently retransmitted. How "recently" is determined by the configuration option source transport_lbtrm_ignore_interval (default 500ms). If this count is high, a receiver transport may be having trouble receiving retransmissions, or the ignore interval may be set too long. This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Number of NAKs the source ignored and sent an NCF with reason code "ignored" code set to "ignored".

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMSourceStatistics(LBMSource)

naksIgnored

public long naksIgnored(int n)
                 throws LBMException

Number of NAKs the source ignored and sent an NCF with reason code "ignored" (LBT-RM, LBT-RU). A source transport ignores a NAK for a datagram it has already recently retransmitted. How "recently" is determined by the configuration option source transport_lbtrm_ignore_interval (default 500ms). If this count is high, a receiver transport may be having trouble receiving retransmissions, or the ignore interval may be set too long. This method returns a value from the nth set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Parameters:

n - Statistics set index

Returns:

Number of NAKs the source ignored and sent an NCF with reason code "ignored"

Throws:

LBMException - if any error occurred retrieving source statistics.

naksShed

public long naksShed()
              throws LBMException

Number of NAKs this source shed and sent an NCF with reason code "shed" (LBT-RM, LBT-RU). When a source transport's retransmit rate limiter and retransmit queue are both at maximum, it responds to a NAK by sending an "NCF shed", and does not retransmit. The receiver transport should wait, then send another NAK. If this count is high, one or more crybaby receiver transports may be clogging the source transport's retransmit queue. This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Number of NAKs this source shed by sending an NCF with the reason code set to "shed"

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMSourceStatistics(LBMSource)

naksShed

public long naksShed(int n)
              throws LBMException

Number of NAKs this source shed and sent an NCF with reason code "shed" (LBT-RM, LBT-RU). When a source transport's retransmit rate limiter and retransmit queue are both at maximum, it responds to a NAK by sending an "NCF shed", and does not retransmit. The receiver transport should wait, then send another NAK. If this count is high, one or more crybaby receiver transports may be clogging the source transport's retransmit queue. This method returns a value from the nth set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Parameters:

n - Statistics set index

Returns:

Number of NAKs this source shed by sending an NCF with the reason code set to "shed"

Throws:

LBMException - if any error occurred retrieving source statistics.

naksIgnoredRetransmitDelay

public long naksIgnoredRetransmitDelay()
                                throws LBMException

Number of NAKs this source did not process because doing so would exceed its retransmit rate limit (LBT-RM, LBT-RU). This rate limit is set by configuration option transport_lbtrm_retransmit_rate_limit (default 5Mbps). For each of these NAKs, the source transport immediately sends an NFC rx_delay, then queues the retransmission for a later send within the rate limit. If this count is high, one or more crybaby receiver transports may be clogging the source transport's retransmit queue. This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Number of NAKs ignored due to retransmit delay

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMSourceStatistics(LBMSource)

naksIgnoredRetransmitDelay

public long naksIgnoredRetransmitDelay(int n)
                                throws LBMException

Number of NAKs this source did not process because doing so would exceed its retransmit rate limit (LBT-RM, LBT-RU). This rate limit is set by configuration option transport_lbtrm_retransmit_rate_limit (default 5Mbps). For each of these NAKs, the source transport immediately sends an NFC rx_delay, then queues the retransmission for a later send within the rate limit. If this count is high, one or more crybaby receiver transports may be clogging the source transport's retransmit queue. This method returns a value from the nth set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Parameters:

n - Statistics set index

Returns:

Number of NAKs ignored due to retransmit delay

Throws:

LBMException - if any error occurred retrieving source statistics.

retransmissionsSent

public long retransmissionsSent()
                         throws LBMException

Number of datagrams retransmitted by this source transport (LBT-RM, LBT-RU). This count is incremented under the same circumstances as retransmissionBytesSent, below. In a normal, light-loss scenario, most NAKs received induce a retransmission. When losses become heavy and/or many receiver transports begin losing the same datagrams, NCF-related no-retransmit counts (naksIgnored, naksShed and naksIgnoredRetransmitDelay) may begin to inflate, and retransmissions retransmissionsSent) may become significantly lower than NAKS received (naksReceived). This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Number of datagrams retransmitted by this source

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMSourceStatistics(LBMSource)

retransmissionsSent

public long retransmissionsSent(int n)
                         throws LBMException

Number of datagrams retransmitted by this source transport (LBT-RM, LBT-RU). This count is incremented under the same circumstances as retransmissionBytesSent, below. In a normal, light-loss scenario, most NAKs received induce a retransmission. When losses become heavy and/or many receiver transports begin losing the same datagrams, NCF-related no-retransmit counts (naksIgnored, naksShed and naksIgnoredRetransmitDelay) may begin to inflate, and retransmissions retransmissionsSent) may become significantly lower than NAKS received (naksReceived). This method returns a value from the nth set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Parameters:

n - Statistics set index

Returns:

Number of datagrams retransmitted by this source

Throws:

LBMException - if any error occurred retrieving source statistics.

retransmissionBytesSent

public long retransmissionBytesSent()
                             throws LBMException

Number of bytes retransmitted by this source transport (LBT-RM, LBT-RU). This count is triggered under the same circumstances as retransmissionsSent, above. In a normal, light-loss scenario, most NAKs received induce a retransmission. When losses become heavy and/or many receiver transports begin losing the same datagrams, NCF-related no-retransmit counts (naksIgnored, naksShed and naksIgnoredRetransmitDelay) may begin to inflate, and retransmissions retransmissionsSent) may become significantly lower than NAKs received (naksReceived). This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Number of transport bytes retransmitted by this source

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMSourceStatistics(LBMSource)

retransmissionBytesSent

public long retransmissionBytesSent(int n)
                             throws LBMException

Number of bytes retransmitted by this source transport (LBT-RM, LBT-RU). This count is triggered under the same circumstances as retransmissionsSent, above. In a normal, light-loss scenario, most NAKs received induce a retransmission. When losses become heavy and/or many receiver transports begin losing the same datagrams, NCF-related no-retransmit counts (naksIgnored, naksShed and naksIgnoredRetransmitDelay) may begin to inflate, and retransmissions retransmissionsSent) may become significantly lower than NAKs received (naksReceived). This method returns a value from the nth set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Parameters:

n - Statistics set index

Returns:

Number of transport bytes retransmitted by this source

Throws:

LBMException - if any error occurred retrieving source statistics.

messagesQueued

public long messagesQueued()
                    throws LBMException

Number of datagrams currently queued by the data rate limiter (LBT-RM only). When a source transport attempts to send messages (any type) faster than its data rate limiter allows (set by configuration option transport_lbtrm_data_rate_limit, default 10Mbps), the data rate limiter queues the messages until they can be sent within the data rate limit. This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Number of datagrams currently queued by the data rate limiter

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMSourceStatistics(LBMSource)

messagesQueued

public long messagesQueued(int n)
                    throws LBMException

Number of datagrams currently queued by the data rate limiter (LBT-RM only). When a source transport attempts to send messages (any type) faster than its data rate limiter allows (set by configuration option transport_lbtrm_data_rate_limit, default 10Mbps), the data rate limiter queues the messages until they can be sent within the data rate limit. This method returns a value from the nth set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Parameters:

n - Statistics set index

Returns:

Number of datagrams currently queued by the data rate limiter

Throws:

LBMException - if any error occurred retrieving source statistics.

retransmissionsQueued

public long retransmissionsQueued()
                           throws LBMException

Number of retransmission datagrams currently queued by the retransmit rate limiter (LBT-RM only). When a source transport attempts to send retransmissions faster that its retransmit rate limiter allows (set by configuration option transport_lbtrm_retransmit_rate_limit, default 5Mbps), the retransmit rate limiter queues retransmissions until they can be sent within the rate limit. naks_rx_delay_ignored (above) will generally also rise if this count is high This method returns a value from the first This method returns a value from the first set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Returns:

Number of datagrams currently queued by the retransmit rate limiter

Throws:

LBMException - if any error occurred retrieving source statistics.

See Also:

LBMSourceStatistics(LBMSource)

retransmissionsQueued

public long retransmissionsQueued(int n)
                           throws LBMException

Number of retransmission datagrams currently queued by the retransmit rate limiter (LBT-RM only). When a source transport attempts to send retransmissions faster that its retransmit rate limiter allows (set by configuration option transport_lbtrm_retransmit_rate_limit, default 5Mbps), the retransmit rate limiter queues retransmissions until they can be sent within the rate limit. naks_rx_delay_ignored (above) will generally also rise if this count is high This method returns a value from the first This method returns a value from the nth set of statistics encapsulated within this object and would normally be used when the object has been created using a specific source to instantiate the class.

Parameters:

n - Statistics set index

Returns:

Number of datagrams currently queued by the retransmit rate limiter

Throws:

LBMException - if any error occurred retrieving source statistics.

setSender

protected void setSender(long ip)

setTimestamp

protected void setTimestamp(long ts)

setApplicationSourceId

protected void setApplicationSourceId(java.lang.String appid)

setProcessId

protected void setProcessId(long pid)

setContextId

protected void setContextId(long cid)

getApplicationSourceId

public java.lang.String getApplicationSourceId()

Retrieve the application source identifier associated with this set of statistics. This attribute is only set for statistics returned by the UM Monitoring framework.

Returns:

Application source ID

getSender

public java.net.InetAddress getSender()
                               throws java.net.UnknownHostException

Retrieve the IP sender address associated with this set of statistics. This attribute is only set for statistics returned by the UM Monitoring framework.

Returns:

InetAddress object corresponding to the statistics' sender IP address

Throws:

java.net.UnknownHostException - if IP address is of illegal length.

getTimestamp

public java.util.Date getTimestamp()

Retrieve the timestamp associated with this set of statistics. This attribute is only set for statistics returned by the UM Monitoring framework.

Returns:

Timestamp Date object

getProcessId

public long getProcessId()

Retrieve the sending process ID associated with this set of statistics. This attribute is only set for statistics returned by the UM Monitoring framework.

Returns:

Process ID

getContextId

public long getContextId()

Retrieve the sending context ID associated with this set of statistics. This attribute is only set for statistics returned by the UM Monitoring framework.

Returns:

Context ID