UM .NET API  6.16.1
Public Member Functions | Static Public Attributes | List of all members
com.latencybusters.lbm.LBMTransportSourceInfo Class Reference

Class that is passed to the source cost callback with source transport information. More...

Public Member Functions

int getType ()
 Type of transport. More...
 
uint getSrcIp ()
 Source IP address. Applicable only to LBT-RM, LBT-RU, TCP, and LBT-RDMA. Stored in network order. More...
 
ushort getSrcPort ()
 Source port. Applicable only to LBT-RM, LBT-RU, TCP, and LBT-RDMA. Stored in host order. More...
 
ushort getDestPort ()
 Destination port. Applicable only to LBT-RM. Stored in host order. More...
 
uint getMCGroup ()
 Multicast group. Applicable only to LBT-RM. Stored in network order. More...
 
uint getTransportId ()
 Transport ID. Applicable only to LBT-IPC. Stored in host order. More...
 
uint getSessionId ()
 Session ID. Applicable only to LBT-RM, LBT-RU, and LBT-IPC. Stored in host order. More...
 
uint getTopicIdx ()
 Topic index. Applicable to all transports. Stored in host order. More...
 

Static Public Attributes

static readonly int TRANSPORT_TYPE_TCP = 0x00
 Transport type: TCP transport.
 
static readonly int TRANSPORT_TYPE_LBTRM = 0x10
 Transport type: LBT-RM transport.
 
static readonly int TRANSPORT_TYPE_LBTRU = 0x01
 Transport type: LBT-RU transport.
 
static readonly int TRANSPORT_TYPE_LBTIPC = 0x40
 Transport type: LBT-IPC transport.
 
static readonly int TRANSPORT_TYPE_LBTRDMA = 0x20
 Transport type: LBT-RDMA transport.
 
static readonly int TRANSPORT_TYPE_LBTSMX = 0x4
 Transport type: LBT-SMX transport.
 
static readonly int TRANSPORT_TYPE_BROKER = 0x80
 Transport type: BROKER transport.
 

Detailed Description

Class that is passed to the source cost callback with source transport information.

These members are used to format and/or parse transport source strings. The format of these strings depends mainly on the transport type, as shown below.

  • TCP:src_ip:src_port[topic_idx]

    example: TCP:192.168.0.4:45789[1539853954]

LBTRM:src_ip:src_port:session_id:mc_group:dest_port[topic_idx]

example: LBTRM:10.29.3.88:14390:e0679abb:231.13.13.13:14400[1539853954]

LBT-RU:src_ip:src_port:session_id[topic_idx] (session_id optional, per configuration

example: LBT-RU:192.168.3.189:34678[1539853954]

LBT-IPC:session_id:transport_id[topic_idx]

example: LBT-IPC:6481f8d4:20000[1539853954]

LBT-RDMA:src_ip:src_port:session_id[topic_idx]

example: LBT-RDMA:192.168.3.189:34678:6471e9c4[1539853954]

Please note that the topic index field (topic_idx) may or may not be present depending on your version of UM and/or the setting for configuration option source_includes_topic_index.

Member Function Documentation

ushort com.latencybusters.lbm.LBMTransportSourceInfo.getDestPort ( )

Destination port. Applicable only to LBT-RM. Stored in host order.

Returns
the destination port
uint com.latencybusters.lbm.LBMTransportSourceInfo.getMCGroup ( )

Multicast group. Applicable only to LBT-RM. Stored in network order.

Returns
the multicast group
uint com.latencybusters.lbm.LBMTransportSourceInfo.getSessionId ( )

Session ID. Applicable only to LBT-RM, LBT-RU, and LBT-IPC. Stored in host order.

Returns
the session id
uint com.latencybusters.lbm.LBMTransportSourceInfo.getSrcIp ( )

Source IP address. Applicable only to LBT-RM, LBT-RU, TCP, and LBT-RDMA. Stored in network order.

Returns
the source ip address
ushort com.latencybusters.lbm.LBMTransportSourceInfo.getSrcPort ( )

Source port. Applicable only to LBT-RM, LBT-RU, TCP, and LBT-RDMA. Stored in host order.

Returns
the source port
uint com.latencybusters.lbm.LBMTransportSourceInfo.getTopicIdx ( )

Topic index. Applicable to all transports. Stored in host order.

Returns
the topic index
uint com.latencybusters.lbm.LBMTransportSourceInfo.getTransportId ( )

Transport ID. Applicable only to LBT-IPC. Stored in host order.

Returns
the transport id
int com.latencybusters.lbm.LBMTransportSourceInfo.getType ( )

Type of transport.

Returns
the type of transport
The documentation for this class was generated from the following file: