Endpoint

Endpoint. More...

Data Structures
class	ILWEEndpoint
	Main object to communicate with the LWE interface. More...
class	ILWEComposer
	Main object to get a composed stream for the message. More...
class	ILWESendMessageContext
	More...
class	ILWEEndpointEvent
	Describes events that may be fired by an endpoint. More...

Typedefs
typedef SDKString	EndpointId
	Endpoint ID (SFI)
typedef SDKUInt32	LWEMsgID
	Unique id for messages being sent.

Enumerations
enum	LWESocketType { kLWESocketType_Shared, kLWESocketType_Exclusive }
	Socket type. More...
enum	LWEEndpointType { kLWEEndpointType_UDP, kLWEEndpointType_TCP_Client, kLWEEndpointType_TCP_Server }
	Endpoint type. More...
enum	LWEEndpointParameters {   kLWEEndpointParameters_Host, kLWEEndpointParameters_Port, kLWEEndpointParameters_Group, kLWEEndpointParameters_Interface,   kLWEEndpointParameters_SocketType, kLWEEndpointParameters_FilterMessagesBySourceID, kLWEEndpointParameters_AllowReceiveOwnMessages, kLWEEndpointParameters_IncomingBufferSize,   kLWEEndpointParameters_OutgoingBufferSize, kLWEEndpointParameters_Bandwidth, kLWEEndpointParameters_MTU, kLWEEndpointParameters_BinaryMessageVersion,   kLWEEndpointParameters_SuppressOwnPackets, kLWEEndpointParameters_LoopbackMode, kLWEEndpointParameters_Type, kLWEEndpointParameters_AuthenticationPresharedKey,   kLWEEndpointParameters_TransmitterInstance, kLWEEndpointParameters_AllowBinaryMessageTypes }
	Endpoint parameters. More...
enum	LWEEndpointProperties {   kLWEEndpointProperties_GetLineStatistics, kLWEEndpointProperties_ParserProperties, kLWEEndpointProperties_AddParser, kLWEEndpointProperties_RemoveParser,   kLWEEndpointProperties_ResetLineStatistics, kLWEEndpointProperties_IsConnected }
	Endpoint properties. More...
enum	ILWEEndpointSendEvent { kILWEEndpointSendEvent_Successfull, kILWEEndpointSendEvent_Error }
	Describes the send event status. More...
enum	LWESendMessageContext { kLWESendMessageContext_MessageType, kLWESendMessageContext_BinaryID }
	Describes parameters of a sent message. More...

Variables
static const LWEMsgID	kInvalidLWEMsgID = static_cast<LWEMsgID>(-1)
	Invalid id for messages being sent.

Detailed Description

Endpoint.

Enumeration Type Documentation

LWESocketType

enum LWESocketType

Socket type.

Enumerator
kLWESocketType_Shared	Share one physical multicast group connection between lwe sockets.
kLWESocketType_Exclusive	Use separated physical multicast group connection for the socket.

LWEEndpointType

enum LWEEndpointType

Endpoint type.

Enumerator
kLWEEndpointType_UDP	UDP endpoint.
kLWEEndpointType_TCP_Client	TCP client endpoint (sender)
kLWEEndpointType_TCP_Server	TCP server endpoint (receiver)

LWEEndpointParameters

enum LWEEndpointParameters

Endpoint parameters.

Enumerator
kLWEEndpointParameters_Host	Multicast group IPv4 address to join the endpoint. Use either the pair host:port or the group Supported: all
kLWEEndpointParameters_Port	Multicast group port to join the endpoint. Use either the pair host:port or the group Supported: all
kLWEEndpointParameters_Group	Predefined group that was used to join the endpoint. Use either the pair host:port or the group Supported: udp
kLWEEndpointParameters_Interface	Outgoing network interface address to bind the sending socket. Supported: udp
kLWEEndpointParameters_SocketType	Socket type (by default - shared) Supported: udp
kLWEEndpointParameters_FilterMessagesBySourceID	Allow receiving messages only from a defined ID. Supported: udp / tcp server
kLWEEndpointParameters_AllowReceiveOwnMessages	Allow receiving messages with an ID equal to the endpoint ID. By default - false Supported: udp
kLWEEndpointParameters_IncomingBufferSize	The size of the incoming buffer. For shared endpoints it's set only once - for first created endpoint Supported: udp / tcp server / tcp client
kLWEEndpointParameters_OutgoingBufferSize	The size of the outgoing buffer. For shared endpoints it's set only once - for first created endpoint Supported: tcp server / tcp client
kLWEEndpointParameters_Bandwidth	Limit outgoing rate, mbyte/sec. Supported: udp / tcp client
kLWEEndpointParameters_MTU	MTU (maximal transfer unit) For shared endpoints it's set only once - for first created endpoint Supported: udp / tcp client
kLWEEndpointParameters_BinaryMessageVersion	binary message version Set default binary message version Supported: udp
kLWEEndpointParameters_SuppressOwnPackets	Reject 'echo' own self packets. For shared endpoints it's set only once - for first created endpoint By default - false Supported: udp
kLWEEndpointParameters_LoopbackMode	Exclusive/shared access to multicast group (also known as loopback mode) For shared endpoints it's set only once - for first created endpoint By default - true Supported: udp
kLWEEndpointParameters_Type	Endpoint type (udp, tcp client, tcp server, see LWEEndpointType enum) By default - udp Supported: all
kLWEEndpointParameters_AuthenticationPresharedKey	Endpoint authentication preshared key. By default - not set Supported: udp 61162
kLWEEndpointParameters_TransmitterInstance	Endpoint SRP transmitter instance (1-9) By default - not set Supported: udp 61162
kLWEEndpointParameters_AllowBinaryMessageTypes	Support binary messages types (kLWEMessageType_Binary/kLWEMessageType_BinaryRetransmit) By default - allow all types Supported: udp

LWEEndpointProperties

enum LWEEndpointProperties

Endpoint properties.

Enumerator
kLWEEndpointProperties_GetLineStatistics	Get line statistics (statistic counts and parsers error counts)
kLWEEndpointProperties_ParserProperties	Set/get parsers properties.
kLWEEndpointProperties_AddParser	Add a custom parser into parsers chains (see ILWEParserWrapper)
kLWEEndpointProperties_RemoveParser	Remove a custom parser from parsers chains (see ILWEParserWrapper)
kLWEEndpointProperties_ResetLineStatistics	Reset line statistics (statistic counts and parsers error counts)
kLWEEndpointProperties_IsConnected	Get connection status. Supported: tcp client

ILWEEndpointSendEvent

enum ILWEEndpointSendEvent

Describes the send event status.

Enumerator
kILWEEndpointSendEvent_Successfull	Message is sent successfully.
kILWEEndpointSendEvent_Error	Message is not sent.

LWESendMessageContext

enum LWESendMessageContext

Describes parameters of a sent message.

Enumerator
kLWESendMessageContext_MessageType	Message type (see LWEMessageType enum)
kLWESendMessageContext_BinaryID	Binary ID for binary messages.