NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
ecdislayer/inc/communication_line/component_ids.h
Go to the documentation of this file.
1 
9 #ifndef SDK_COMMUNICATION_LINE_COMPONENT_IDS_H
10 #define SDK_COMMUNICATION_LINE_COMPONENT_IDS_H
11 
13 
14 namespace sdk
15 {
16 namespace communication_line
17 {
18 
21 static const char kLocalHostAddress[] = "127.0.0.1";
22 
25 enum Type {
26  kType_UNK = 0,
35 };
36 
39 static const sdk::ComponentId kCommunicationLineTcpServerCID = "CommunicationLine.Tcp.Server.CID";
42 static const sdk::ComponentId kCommunicationLineTcpClientCID = "CommunicationLine.Tcp.Client.CID";
43 
46 enum Options {
50  kOption_Port,
53  kOption_LocalPort = kOption_Port,
55  kOption_Host,
70  kOption_RemoteHost = kOption_DestinationHost,
92 
97 
99  kOption_FilterAddress,
104 
113  kOption_MulticastFilterOwnData,
115 };
116 
117 namespace tcp
118 {
121 enum Options
122 {
130 
135 
138 
140 };
141 }
142 
145 static const sdk::ComponentId kCommunicationLineUdpCID = "CommunicationLine.Udp.CID";
152 
153 namespace udp
154 {
157 static const char kBroadcastAddress[] = "0.0.0.0";
160 static const char kAnyHost[] = "0.0.0.0";
163 static const SDKUInt16 kUndefinedPortnumber = 0;
164 
168 {
175  kOption_LocalPort = kOption_Port,
176  kOption_SourcePort = kOption_Port,
179  kOption_SourceHost = kOption_Host,
183  kOption_RemoteHost = kOption_DestinationHost,
196 
197  kOption_FilterAddress = communication_line::kOption_FilterAddress,
208  kOption_MulticastFilterOwnData = communication_line::kOption_MulticastFilterOwnData,
209 
211 };
212 }
213 
216 static const sdk::ComponentId kCommunicationLineCommCID = "CommunicationLine.Comm.CID";
217 
218 namespace comm
219 {
223 {
248 };
250 }
251 
254 static const sdk::ComponentId kCommunicationLineIpcServerCID = "CommunicationLine.Ipc.Server.CID";
257 static const sdk::ComponentId kCommunicationLineIpcClientCID = "CommunicationLine.Ipc.Client.CID";
258 
259 namespace ipc
260 {
264 {
271 };
274 }
275 
278 static const sdk::ComponentId kCommunicationLineUtilsCID = "CommunicationLine.Utils.CID";
279 
280 } // namespace communication_line
281 } // namespace sdk
282 
283 #endif // SDK_COMMUNICATION_LINE_COMPONENT_IDS_H
sdk::communication_line::kCommunicationLineCommCID
static const sdk::ComponentId kCommunicationLineCommCID
Communication line through COM port connection.
Definition: ecdislayer/inc/communication_line/component_ids.h:216
sdk::communication_line::kCommunicationLineUdpClientCID
static const sdk::ComponentId & kCommunicationLineUdpClientCID
Communication line through UDP connection: Client.
Definition: ecdislayer/inc/communication_line/component_ids.h:151
sdk::communication_line::kOption_PeerNameAddr
@ kOption_PeerNameAddr
[R/O] String: Peer address
Definition: ecdislayer/inc/communication_line/component_ids.h:90
sdk::communication_line::kOption_MulticastSockNameNative
@ kOption_MulticastSockNameNative
[R/O] Byte array: sockaddr struct as is.
Definition: ecdislayer/inc/communication_line/component_ids.h:112
sdk::communication_line::kCommunicationLineIpcClientCID
static const sdk::ComponentId kCommunicationLineIpcClientCID
Communication line through a named pipe connection: Client.
Definition: ecdislayer/inc/communication_line/component_ids.h:257
sdk::communication_line::udp::kAnyHost
static const char kAnyHost[]
Any host address.
Definition: ecdislayer/inc/communication_line/component_ids.h:160
sdk::communication_line::kOption_MessageRegex
@ kOption_MessageRegex
Definition: ecdislayer/inc/communication_line/component_ids.h:49
sdk::communication_line::kOption_Port
@ kOption_Port
String or integral: Data source port number.
Definition: ecdislayer/inc/communication_line/component_ids.h:52
sdk::communication_line::kOption_TimerPeriod
@ kOption_TimerPeriod
Boolean: Allow receiver to skip own packets.
Definition: ecdislayer/inc/communication_line/component_ids.h:114
sdk::communication_line::kOption_Name
@ kOption_Name
Definition: ecdislayer/inc/communication_line/component_ids.h:98
sdk::communication_line::kOption_FlowCtrl
@ kOption_FlowCtrl
Definition: ecdislayer/inc/communication_line/component_ids.h:78
sdk::communication_line::Options
Options
all possible options
Definition: ecdislayer/inc/communication_line/component_ids.h:46
sdk::communication_line::kCommunicationLineTcpClientCID
static const sdk::ComponentId kCommunicationLineTcpClientCID
Communication line through TCP/IP connection: Client.
Definition: ecdislayer/inc/communication_line/component_ids.h:42
sdk::communication_line::kOption_PeerName
@ kOption_PeerName
Definition: ecdislayer/inc/communication_line/component_ids.h:86
sdk::communication_line::kType_TCP_CLIENT
@ kType_TCP_CLIENT
TCP.
Definition: ecdislayer/inc/communication_line/component_ids.h:29
sdk::communication_line::kType_IPC_CLIENT
@ kType_IPC_CLIENT
IPC(PIPE)
Definition: ecdislayer/inc/communication_line/component_ids.h:33
sdk::communication_line::kOption_MulticastSockName
@ kOption_MulticastSockName
Integral: udp outgoing buffer size.
Definition: ecdislayer/inc/communication_line/component_ids.h:109
sdk::communication_line::udp::kBroadcastAddress
static const char kBroadcastAddress[]
Broadcast address.
Definition: ecdislayer/inc/communication_line/component_ids.h:157
sdk::communication_line::kLocalHostAddress
static const char kLocalHostAddress[]
Local host address.
Definition: ecdislayer/inc/communication_line/component_ids.h:21
sdk::communication_line::kOption_MulticastSockNameAddr
@ kOption_MulticastSockNameAddr
[R/O] String: Socket address
Definition: ecdislayer/inc/communication_line/component_ids.h:111
sdk::communication_line::kType_UDP_CLIENT
@ kType_UDP_CLIENT
UDP.
Definition: ecdislayer/inc/communication_line/component_ids.h:31
sdk::communication_line::kCommunicationLineUdpServerCID
static const sdk::ComponentId & kCommunicationLineUdpServerCID
Communication line through UDP connection: Server.
Definition: ecdislayer/inc/communication_line/component_ids.h:148
sdk::communication_line::kOption_KeepAliveIntvl
@ kOption_KeepAliveIntvl
Integral: Seconds between probes.
Definition: ecdislayer/inc/communication_line/component_ids.h:96
sdk::communication_line::kOption_KeepAliveIdle
@ kOption_KeepAliveIdle
Integral: Seconds of idle traffic before the first probe is sent.
Definition: ecdislayer/inc/communication_line/component_ids.h:94
sdk::communication_line::kOption_KeepAliveCount
@ kOption_KeepAliveCount
Integral: Number of probes to send before the connection is terminated.
Definition: ecdislayer/inc/communication_line/component_ids.h:95
sdk::communication_line::kOption_SockNamePort
@ kOption_SockNamePort
[R/O] String: Socket port number
Definition: ecdislayer/inc/communication_line/component_ids.h:83
sdk::communication_line::kOption_StopBits
@ kOption_StopBits
Definition: ecdislayer/inc/communication_line/component_ids.h:76
sdk::communication_line::kCommunicationLineUdpCID
static const sdk::ComponentId kCommunicationLineUdpCID
Communication line through UDP connection.
Definition: ecdislayer/inc/communication_line/component_ids.h:145
sdk::communication_line::kOption_SockNameNative
@ kOption_SockNameNative
[R/O] Byte array: sockaddr struct as is.
Definition: ecdislayer/inc/communication_line/component_ids.h:85
sdk::communication_line::kOption_LocalHost
@ kOption_LocalHost
For multicast - defines the communication device interface.
Definition: ecdislayer/inc/communication_line/component_ids.h:66
sdk::communication_line::kOption_SockName
@ kOption_SockName
Definition: ecdislayer/inc/communication_line/component_ids.h:80
sdk::communication_line::kOption_RemotePort
@ kOption_RemotePort
for muticast - defines the multicast group
Definition: ecdislayer/inc/communication_line/component_ids.h:68
sdk::communication_line::kOption_DestinationPort
@ kOption_DestinationPort
String or integral: Data receiver port number.
Definition: ecdislayer/inc/communication_line/component_ids.h:67
sdk::communication_line::kType_USER
@ kType_USER
User type.
Definition: ecdislayer/inc/communication_line/component_ids.h:34
sdk::communication_line::kCommunicationLineIpcServerCID
static const sdk::ComponentId kCommunicationLineIpcServerCID
Communication line through a named pipe connection: Server.
Definition: ecdislayer/inc/communication_line/component_ids.h:254
sdk::communication_line::kOption_PeerNameNative
@ kOption_PeerNameNative
[R/O] Byte array: sockaddr struct as is.
Definition: ecdislayer/inc/communication_line/component_ids.h:91
sdk_component_interface.h
Common base SDK interfaces.
sdk::communication_line::kOption_SockNameAddr
@ kOption_SockNameAddr
[R/O] String: Socket address
Definition: ecdislayer/inc/communication_line/component_ids.h:84
sdk::communication_line::kType_UNK
@ kType_UNK
Unknown type.
Definition: ecdislayer/inc/communication_line/component_ids.h:26
sdk::communication_line::kCommunicationLineTcpServerCID
static const sdk::ComponentId kCommunicationLineTcpServerCID
Communication line through TCP/IP connection: Server.
Definition: ecdislayer/inc/communication_line/component_ids.h:39
sdk::communication_line::kOption_State
@ kOption_State
Read only Bool: Running / Stopped.
Definition: ecdislayer/inc/communication_line/component_ids.h:48
sdk::communication_line::kOption_DestinationHost
@ kOption_DestinationHost
String: Data receiver host name or address.
Definition: ecdislayer/inc/communication_line/component_ids.h:69
sdk::communication_line::kOption_FilterAddressv4
@ kOption_FilterAddressv4
string
Definition: ecdislayer/inc/communication_line/component_ids.h:102
sdk::communication_line::kOption_BaudRate
@ kOption_BaudRate
Integral: Sets and returns the baud rate (1200, 4800, 9600 ...)
Definition: ecdislayer/inc/communication_line/component_ids.h:71
sdk::communication_line::kOption_Host
@ kOption_Host
String: Data source host name or address.
Definition: ecdislayer/inc/communication_line/component_ids.h:65
sdk::communication_line::kOption_FilterAddressv6
@ kOption_FilterAddressv6
array ipv4 in network format
Definition: ecdislayer/inc/communication_line/component_ids.h:103
sdk::communication_line::kOption_PeerNamePort
@ kOption_PeerNamePort
[R/O] String: Peer port number
Definition: ecdislayer/inc/communication_line/component_ids.h:89
sdk::communication_line::kOption_ReceiveBufferSize
@ kOption_ReceiveBufferSize
Boolean: Allow the sender receive the sent packets.
Definition: ecdislayer/inc/communication_line/component_ids.h:107
sdk::communication_line::kType_SERIAL
@ kType_SERIAL
Comm (Serial)
Definition: ecdislayer/inc/communication_line/component_ids.h:27
sdk::communication_line::kOption_MulticastLoop
@ kOption_MulticastLoop
time-to-live for multicast packets
Definition: ecdislayer/inc/communication_line/component_ids.h:106
sdk::communication_line::kOption_NOP
@ kOption_NOP
No operation.
Definition: ecdislayer/inc/communication_line/component_ids.h:47
sdk::communication_line::kOption_MulticastSockNamePort
@ kOption_MulticastSockNamePort
< [R/O] String: Socket port number
Definition: ecdislayer/inc/communication_line/component_ids.h:110
sdk::communication_line::kOption_ByteSize
@ kOption_ByteSize
Integral: Sets and returns the byte size (8 by default)
Definition: ecdislayer/inc/communication_line/component_ids.h:72
sdk::communication_line::kType_UDP_SERVER
@ kType_UDP_SERVER
UDP.
Definition: ecdislayer/inc/communication_line/component_ids.h:30
sdk::communication_line::kOption_SerialPort
@ kOption_SerialPort
Definition: ecdislayer/inc/communication_line/component_ids.h:54
sdk::communication_line::Type
Type
Communication line type.
Definition: ecdislayer/inc/communication_line/component_ids.h:25
sdk::communication_line::kCommunicationLineUtilsCID
static const sdk::ComponentId kCommunicationLineUtilsCID
Communication line through a named pipe connection: Client.
Definition: ecdislayer/inc/communication_line/component_ids.h:278
sdk::communication_line::udp::kUndefinedPortnumber
static const SDKUInt16 kUndefinedPortnumber
Undefined port number.
Definition: ecdislayer/inc/communication_line/component_ids.h:163
sdk::communication_line::kOption_KeepAlive
@ kOption_KeepAlive
Boolean: On/Off.
Definition: ecdislayer/inc/communication_line/component_ids.h:93
ComponentId
Uuid ComponentId
Definition of component UUID.
Definition: sdk_uuid.h:42
sdk::communication_line::kOption_SendBufferSize
@ kOption_SendBufferSize
Integral: udp incoming buffer size.
Definition: ecdislayer/inc/communication_line/component_ids.h:108
sdk::communication_line::kOption_MulticastHops
@ kOption_MulticastHops
array ipv6 in network format
Definition: ecdislayer/inc/communication_line/component_ids.h:105
sdk::communication_line::kType_IPC_SERVER
@ kType_IPC_SERVER
IPC(PIPE)
Definition: ecdislayer/inc/communication_line/component_ids.h:32
sdk::communication_line::kOption_Parity
@ kOption_Parity
Definition: ecdislayer/inc/communication_line/component_ids.h:73
sdk::communication_line::kType_TCP_SERVER
@ kType_TCP_SERVER
TCP.
Definition: ecdislayer/inc/communication_line/component_ids.h:28