socket.h
Go to the documentation of this file.
1 /**
2  * @file socket.h
3  * @brief Socket API
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2022 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.1.6
29  **/
30 
31 #ifndef _SOCKET_H
32 #define _SOCKET_H
33 
34 //Forward declaration of Socket structure
35 struct _Socket;
36 #define Socket struct _Socket
37 
38 //Dependencies
39 #include "core/net.h"
40 #include "core/ethernet.h"
41 #include "core/ip.h"
42 #include "core/tcp.h"
43 
44 //Number of sockets that can be opened simultaneously
45 #ifndef SOCKET_MAX_COUNT
46  #define SOCKET_MAX_COUNT 16
47 #elif (SOCKET_MAX_COUNT < 1)
48  #error SOCKET_MAX_COUNT parameter is not valid
49 #endif
50 
51 //Dynamic port range (lower limit)
52 #ifndef SOCKET_EPHEMERAL_PORT_MIN
53  #define SOCKET_EPHEMERAL_PORT_MIN 49152
54 #elif (SOCKET_EPHEMERAL_PORT_MIN < 1024)
55  #error SOCKET_EPHEMERAL_PORT_MIN parameter is not valid
56 #endif
57 
58 //Dynamic port range (upper limit)
59 #ifndef SOCKET_EPHEMERAL_PORT_MAX
60  #define SOCKET_EPHEMERAL_PORT_MAX 65535
61 #elif (SOCKET_EPHEMERAL_PORT_MAX <= SOCKET_EPHEMERAL_PORT_MIN || SOCKET_EPHEMERAL_PORT_MAX > 65535)
62  #error SOCKET_EPHEMERAL_PORT_MAX parameter is not valid
63 #endif
64 
65 //C++ guard
66 #ifdef __cplusplus
67 extern "C" {
68 #endif
69 
70 
71 /**
72  * @brief Socket types
73  **/
74 
75 typedef enum
76 {
83 
84 
85 /**
86  * @brief IP protocols
87  **/
88 
89 typedef enum
90 {
97 
98 
99 /**
100  * @brief Ethernet protocols
101  **/
102 
103 typedef enum
104 {
109  SOCKET_ETH_PROTO_IPV6 = 0x86DD
111 
112 
113 /**
114  * @brief Flags used by I/O functions
115  **/
116 
117 typedef enum
118 {
127  SOCKET_FLAG_DELAY = 0x8000
129 
130 
131 //The SOCKET_FLAG_BREAK macro causes the I/O functions to stop reading
132 //data whenever the specified break character is encountered
133 #define SOCKET_FLAG_BREAK(c) (SOCKET_FLAG_BREAK_CHAR | LSB(c))
134 
135 
136 /**
137  * @brief Flags used by shutdown function
138  **/
139 
140 typedef enum
141 {
144  SOCKET_SD_BOTH = 2
146 
147 
148 /**
149  * @brief Socket events
150  **/
151 
152 typedef enum
153 {
165  SOCKET_EVENT_LINK_DOWN = 0x0400
167 
168 
169 /**
170  * @brief Host types
171  **/
172 
173 typedef enum
174 {
177  HOST_TYPE_IPV6 = 32
179 
180 
181 /**
182  * @brief Name resolution protocols
183  **/
184 
185 typedef enum
186 {
193 
194 
195 /**
196  * @brief Message and ancillary data
197  **/
198 
199 typedef struct
200 {
201  void *data; ///<Pointer to the payload
202  size_t size; ///<Size of the payload, in bytes
203  size_t length; ///<Actual length of the payload, in bytes
204  uint8_t ttl; ///<Time-to-live value
205  NetInterface *interface; ///<Underlying network interface
206  IpAddr srcIpAddr; ///<Source IP address
207  uint16_t srcPort; ///<Source port
208  IpAddr destIpAddr; ///<Destination IP address
209  uint16_t destPort; ///<Destination port
210 #if (ETH_SUPPORT == ENABLED)
211  MacAddr srcMacAddr; ///<Source MAC address
212  MacAddr destMacAddr; ///<Destination MAC address
213  uint16_t ethType; ///<Ethernet type field
214 #endif
215 #if (ETH_PORT_TAGGING_SUPPORT == ENABLED)
216  uint8_t switchPort; ///<Switch port identifier
217 #endif
218 #if (ETH_TIMESTAMP_SUPPORT == ENABLED)
219  int32_t timestampId; ///<Unique identifier for hardware time stamping
220  NetTimestamp timestamp; ///<Captured time stamp
221 #endif
222 } SocketMsg;
223 
224 
225 /**
226  * @brief Receive queue item
227  **/
228 
229 typedef struct _SocketQueueItem
230 {
234  uint16_t srcPort;
237  size_t offset;
240 
241 
242 /**
243  * @brief Structure describing a socket
244  **/
245 
246 struct _Socket
247 {
253  uint16_t localPort;
255  uint16_t remotePort;
257  uint8_t ttl; ///<Time-to-live value for unicast datagrams
258  uint8_t multicastTtl; ///<Time-to-live value for multicast datagrams
259 #if (IP_DIFF_SERV_SUPPORT == ENABLED)
260  uint8_t dscp; ///<Differentiated services codepoint
261 #endif
262 #if (ETH_VLAN_SUPPORT == ENABLED)
263  int8_t vlanPcp; ///<VLAN priority (802.1Q)
264  int8_t vlanDei; ///<Drop eligible indicator
265 #endif
266 #if (ETH_VMAN_SUPPORT == ENABLED)
267  int8_t vmanPcp; ///<VMAN priority (802.1ad)
268  int8_t vmanDei; ///<Drop eligible indicator
269 #endif
275 
276 //TCP specific variables
277 #if (TCP_SUPPORT == ENABLED)
278  TcpState state; ///<Current state of the TCP finite state machine
279  bool_t ownedFlag; ///<The user is the owner of the TCP socket
280  bool_t closedFlag; ///<The connection has been closed properly
281  bool_t resetFlag; ///<The connection has been reset
282 
283  uint16_t smss; ///<Sender maximum segment size
284  uint16_t rmss; ///<Receiver maximum segment size
285  uint32_t iss; ///<Initial send sequence number
286  uint32_t irs; ///<Initial receive sequence number
287 
288  uint32_t sndUna; ///<Data that have been sent but not yet acknowledged
289  uint32_t sndNxt; ///<Sequence number of the next byte to be sent
290  uint16_t sndUser; ///<Amount of data buffered but not yet sent
291  uint16_t sndWnd; ///<Size of the send window
292  uint16_t maxSndWnd; ///<Maximum send window it has seen so far on the connection
293  uint32_t sndWl1; ///<Segment sequence number used for last window update
294  uint32_t sndWl2; ///<Segment acknowledgment number used for last window update
295 
296  uint32_t rcvNxt; ///<Receive next sequence number
297  uint16_t rcvUser; ///<Number of data received but not yet consumed
298  uint16_t rcvWnd; ///<Receive window
299 
300  bool_t rttBusy; ///<RTT measurement is being performed
301  uint32_t rttSeqNum; ///<Sequence number identifying a TCP segment
302  systime_t rttStartTime; ///<Round-trip start time
303  systime_t srtt; ///<Smoothed round-trip time
304  systime_t rttvar; ///<Round-trip time variation
305  systime_t rto; ///<Retransmission timeout
306 
307 #if (TCP_CONGEST_CONTROL_SUPPORT == ENABLED)
308  TcpCongestState congestState; ///<Congestion state
309  uint16_t cwnd; ///<Congestion window
310  uint16_t ssthresh; ///<Slow start threshold
311  uint_t dupAckCount; ///<Number of consecutive duplicate ACKs
312  uint_t n; ///<Number of bytes acknowledged during the whole round-trip
313  uint32_t recover; ///<NewReno modification to TCP's fast recovery algorithm
314 #endif
315 
316 #if (TCP_KEEP_ALIVE_SUPPORT == ENABLED)
317  bool_t keepAliveEnabled; ///<Specifies whether TCP keep-alive mechanism is enabled
318  systime_t keepAliveIdle; ///<Keep-alive idle time
319  systime_t keepAliveInterval; ///<Time interval between subsequent keep-alive probes
320  uint_t keepAliveMaxProbes; ///<Number of keep-alive probes
321  uint_t keepAliveProbeCount; ///<Keep-alive probe counter
322  systime_t keepAliveTimestamp; ///<Keep-alive timestamp
323 #endif
324 
325 #if (TCP_SACK_SUPPORT == ENABLED)
326  bool_t sackPermitted; ///<SACK Permitted option received
327 #endif
328 
329  TcpSackBlock sackBlock[TCP_MAX_SACK_BLOCKS]; ///<List of non-contiguous blocks that have been received
330  uint_t sackBlockCount; ///<Number of non-contiguous blocks that have been received
331 
332  TcpTxBuffer txBuffer; ///<Send buffer
333  size_t txBufferSize; ///<Size of the send buffer
334  TcpRxBuffer rxBuffer; ///<Receive buffer
335  size_t rxBufferSize; ///<Size of the receive buffer
336 
337  TcpQueueItem *retransmitQueue; ///<Retransmission queue
338  NetTimer retransmitTimer; ///<Retransmission timer
339  uint_t retransmitCount; ///<Number of retransmissions
340 
341  TcpSynQueueItem *synQueue; ///<SYN queue for listening sockets
342  uint_t synQueueSize; ///<Maximum number of pending connections for listening sockets
343 
344  uint_t wndProbeCount; ///<Zero window probe counter
345  systime_t wndProbeInterval; ///<Interval between successive probes
346 
347  NetTimer persistTimer; ///<Persist timer
348  NetTimer overrideTimer; ///<Override timer
349  NetTimer finWait2Timer; ///<FIN-WAIT-2 timer
350  NetTimer timeWaitTimer; ///<2MSL timer
351 #endif
352 
353 //UDP specific variables
354 #if (UDP_SUPPORT == ENABLED || RAW_SOCKET_SUPPORT == ENABLED)
356 #endif
357 };
358 
359 
360 /**
361  * @brief Structure describing socket events
362  **/
363 
364 typedef struct
365 {
366  Socket *socket; ///<Handle to a socket to monitor
367  uint_t eventMask; ///<Requested events
368  uint_t eventFlags; ///<Returned events
370 
371 
372 //Global constants
373 extern const SocketMsg SOCKET_DEFAULT_MSG;
374 
375 //Global variables
377 
378 //Socket related functions
379 error_t socketInit(void);
380 
382 
384 
387 
388 error_t socketSetDscp(Socket *socket, uint8_t dscp);
389 
390 error_t socketSetVlanPcp(Socket *socket, uint8_t pcp);
392 error_t socketSetVmanPcp(Socket *socket, uint8_t pcp);
394 
396 
398  systime_t interval, uint_t maxProbes);
399 
402 
405 
406 error_t socketBind(Socket *socket, const IpAddr *localIpAddr,
407  uint16_t localPort);
408 
409 error_t socketConnect(Socket *socket, const IpAddr *remoteIpAddr,
410  uint16_t remotePort);
411 
413 
414 Socket *socketAccept(Socket *socket, IpAddr *clientIpAddr,
415  uint16_t *clientPort);
416 
417 error_t socketSend(Socket *socket, const void *data, size_t length,
418  size_t *written, uint_t flags);
419 
421  const void *data, size_t length, size_t *written, uint_t flags);
422 
424 
426  size_t size, size_t *received, uint_t flags);
427 
429  void *data, size_t size, size_t *received, uint_t flags);
430 
432  IpAddr *destIpAddr, void *data, size_t size, size_t *received, uint_t flags);
433 
435 
437  uint16_t *localPort);
438 
440  uint16_t *remotePort);
441 
443 void socketClose(Socket *socket);
444 
445 error_t socketPoll(SocketEventDesc *eventDesc, uint_t size, OsEvent *extEvent,
446  systime_t timeout);
447 
449  const char_t *name, IpAddr *ipAddr, uint_t flags);
450 
451 //C++ guard
452 #ifdef __cplusplus
453 }
454 #endif
455 
456 #endif
SocketQueueItem * receiveQueue
Definition: socket.h:355
uint8_t length
Definition: coap_common.h:191
error_t socketConnect(Socket *socket, const IpAddr *remoteIpAddr, uint16_t remotePort)
Establish a connection to a specified socket.
Definition: socket.c:625
uint16_t maxSndWnd
Maximum send window it has seen so far on the connection.
Definition: socket.h:292
@ SOCKET_IP_PROTO_UDP
Definition: socket.h:94
HostType
Host types.
Definition: socket.h:174
Retransmission queue item.
Definition: tcp.h:382
@ SOCKET_ETH_PROTO_LLC
Definition: socket.h:106
uint32_t sndNxt
Sequence number of the next byte to be sent.
Definition: socket.h:289
HostnameResolver
Name resolution protocols.
Definition: socket.h:186
int bool_t
Definition: compiler_port.h:48
error_t socketListen(Socket *socket, uint_t backlog)
Place a socket in the listening state.
Definition: socket.c:689
int8_t vmanPcp
VMAN priority (802.1ad)
Definition: socket.h:267
@ SOCKET_FLAG_WAIT_ALL
Definition: socket.h:121
uint32_t rcvNxt
Receive next sequence number.
Definition: socket.h:296
struct _SocketQueueItem SocketQueueItem
Receive queue item.
@ HOST_NAME_RESOLVER_DNS
Definition: socket.h:188
uint8_t data[]
Definition: ethernet.h:220
signed int int_t
Definition: compiler_port.h:44
IP network address.
Definition: ip.h:79
systime_t keepAliveIdle
Keep-alive idle time.
Definition: socket.h:318
uint16_t cwnd
Congestion window.
Definition: socket.h:309
TcpCongestState
TCP congestion states.
Definition: tcp.h:287
IpAddr remoteIpAddr
Definition: socket.h:254
uint8_t ttl
Time-to-live value for unicast datagrams.
Definition: socket.h:257
OsEvent * userEvent
Definition: socket.h:274
@ SOCKET_FLAG_WAIT_ACK
Definition: socket.h:125
@ HOST_TYPE_ANY
Definition: socket.h:175
uint_t keepAliveProbeCount
Keep-alive probe counter.
Definition: socket.h:321
@ SOCKET_FLAG_DONT_ROUTE
Definition: socket.h:120
Structure describing a buffer that spans multiple chunks.
Definition: net_mem.h:89
@ SOCKET_IP_PROTO_ICMPV6
Definition: socket.h:95
uint_t wndProbeCount
Zero window probe counter.
Definition: socket.h:344
Message and ancillary data.
Definition: socket.h:200
SocketIpProtocol
IP protocols.
Definition: socket.h:90
Event object.
uint16_t sndUser
Amount of data buffered but not yet sent.
Definition: socket.h:290
uint16_t srcPort
Definition: socket.h:234
error_t socketBind(Socket *socket, const IpAddr *localIpAddr, uint16_t localPort)
Associate a local address with a socket.
Definition: socket.c:596
@ HOST_NAME_RESOLVER_LLMNR
Definition: socket.h:191
uint32_t irs
Initial receive sequence number.
Definition: socket.h:286
OsEvent event
Definition: socket.h:271
@ SOCKET_TYPE_DGRAM
Definition: socket.h:79
uint_t type
Definition: socket.h:249
uint32_t sndWl2
Segment acknowledgment number used for last window update.
Definition: socket.h:294
void * data
Pointer to the payload.
Definition: socket.h:201
size_t txBufferSize
Size of the send buffer.
Definition: socket.h:333
IpAddr srcIpAddr
Definition: socket.h:233
uint_t eventFlags
Definition: socket.h:273
uint8_t multicastTtl
Time-to-live value for multicast datagrams.
Definition: socket.h:258
error_t socketSendMsg(Socket *socket, const SocketMsg *message, uint_t flags)
Send a message to a connectionless socket.
Definition: socket.c:908
uint16_t rmss
Receiver maximum segment size.
Definition: socket.h:284
char_t name[]
bool_t resetFlag
The connection has been reset.
Definition: socket.h:281
uint16_t destPort
Definition: tcp.h:338
NetTimestamp timestamp
Captured time stamp.
Definition: socket.h:220
uint32_t recover
NewReno modification to TCP's fast recovery algorithm.
Definition: socket.h:313
Ipv4Addr srcIpAddr
Definition: ipcp.h:77
struct _SocketQueueItem * next
Definition: socket.h:231
error_t socketSetTimeout(Socket *socket, systime_t timeout)
Set timeout value for blocking operations.
Definition: socket.c:145
systime_t srtt
Smoothed round-trip time.
Definition: socket.h:303
@ SOCKET_TYPE_STREAM
Definition: socket.h:78
SocketType
Socket types.
Definition: socket.h:76
uint_t descriptor
Definition: socket.h:248
Structure describing socket events.
Definition: socket.h:365
void socketClose(Socket *socket)
Close an existing socket.
Definition: socket.c:1331
int8_t vlanPcp
VLAN priority (802.1Q)
Definition: socket.h:263
Ethernet.
@ SOCKET_FLAG_PEEK
Definition: socket.h:119
NetTimer finWait2Timer
FIN-WAIT-2 timer.
Definition: socket.h:349
@ SOCKET_FLAG_DELAY
Definition: socket.h:127
uint8_t dscp
Differentiated services codepoint.
Definition: socket.h:260
error_t socketSetMulticastTtl(Socket *socket, uint8_t ttl)
Set TTL value for multicast datagrams.
Definition: socket.c:195
uint16_t ethType
Ethernet type field.
Definition: socket.h:213
@ HOST_TYPE_IPV6
Definition: socket.h:177
error_t socketSend(Socket *socket, const void *data, size_t length, size_t *written, uint_t flags)
Send data to a connected socket.
Definition: socket.c:760
TcpRxBuffer rxBuffer
Receive buffer.
Definition: socket.h:334
TcpCongestState congestState
Congestion state.
Definition: socket.h:308
uint16_t destPort
Destination port.
Definition: socket.h:209
#define TCP_MAX_SACK_BLOCKS
Definition: tcp.h:243
@ SOCKET_SD_SEND
Definition: socket.h:143
systime_t rto
Retransmission timeout.
Definition: socket.h:305
NetRxAncillary ancillary
Definition: socket.h:238
NetInterface * interface
Underlying network interface.
Definition: socket.h:205
TcpState
TCP FSM states.
Definition: tcp.h:267
__start_packed struct @0 MacAddr
MAC address.
size_t length
Actual length of the payload, in bytes.
Definition: socket.h:203
error_t socketReceiveFrom(Socket *socket, IpAddr *srcIpAddr, uint16_t *srcPort, void *data, size_t size, size_t *received, uint_t flags)
Receive a datagram from a connectionless socket.
Definition: socket.c:988
char_t type
systime_t keepAliveInterval
Time interval between subsequent keep-alive probes.
Definition: socket.h:319
Timestamp.
Definition: net_misc.h:105
error_t
Error codes.
Definition: error.h:43
const SocketMsg SOCKET_DEFAULT_MSG
Definition: socket.c:53
IpAddr localIpAddr
Definition: socket.h:252
uint8_t protocol
uint16_t rcvWnd
Receive window.
Definition: socket.h:298
uint16_t rcvUser
Number of data received but not yet consumed.
Definition: socket.h:297
error_t socketEnableKeepAlive(Socket *socket, bool_t enabled)
Enable TCP keep-alive.
Definition: socket.c:394
int_t socket(int_t family, int_t type, int_t protocol)
Create a socket that is bound to a specific transport service provider.
Definition: bsd_socket.c:63
@ HOST_NAME_RESOLVER_MDNS
Definition: socket.h:189
@ SOCKET_EVENT_TX_READY
Definition: socket.h:158
uint16_t remotePort
Definition: socket.h:255
uint16_t smss
Sender maximum segment size.
Definition: socket.h:283
@ SOCKET_EVENT_LINK_DOWN
Definition: socket.h:165
Timer.
Definition: net_misc.h:172
NetInterface * socketGetInterface(Socket *socket)
Retrieve the underlying interface.
Definition: socket.c:573
SocketShutdownFlags
Flags used by shutdown function.
Definition: socket.h:141
#define NetRxAncillary
Definition: net_misc.h:40
#define NetInterface
Definition: net.h:36
IpAddr srcIpAddr
Source IP address.
Definition: socket.h:206
TcpTxBuffer txBuffer
Send buffer.
Definition: socket.h:332
@ SOCKET_EVENT_ACCEPT
Definition: socket.h:155
NetTimer persistTimer
Persist timer.
Definition: socket.h:347
Socket * socketAccept(Socket *socket, IpAddr *clientIpAddr, uint16_t *clientPort)
Permit an incoming connection attempt on a socket.
Definition: socket.c:726
@ SOCKET_EVENT_RX_SHUTDOWN
Definition: socket.h:163
bool_t keepAliveEnabled
Specifies whether TCP keep-alive mechanism is enabled.
Definition: socket.h:317
uint16_t localPort
Definition: socket.h:253
uint8_t switchPort
Switch port identifier.
Definition: socket.h:216
error_t socketSetVmanPcp(Socket *socket, uint8_t pcp)
Set VMAN priority.
Definition: socket.c:324
int32_t timestampId
Unique identifier for hardware time stamping.
Definition: socket.h:219
@ SOCKET_TYPE_RAW_IP
Definition: socket.h:80
IpAddr destIpAddr
Definition: socket.h:235
uint_t keepAliveMaxProbes
Number of keep-alive probes.
Definition: socket.h:320
uint_t eventMask
Definition: socket.h:272
bool_t closedFlag
The connection has been closed properly.
Definition: socket.h:280
TcpSynQueueItem * synQueue
SYN queue for listening sockets.
Definition: socket.h:341
uint16_t ssthresh
Slow start threshold.
Definition: socket.h:310
systime_t keepAliveTimestamp
Keep-alive timestamp.
Definition: socket.h:322
NetTimer timeWaitTimer
2MSL timer
Definition: socket.h:350
@ HOST_TYPE_IPV4
Definition: socket.h:176
@ SOCKET_EVENT_TX_DONE
Definition: socket.h:159
uint_t eventFlags
Returned events.
Definition: socket.h:368
@ SOCKET_IP_PROTO_IGMP
Definition: socket.h:92
size_t rxBufferSize
Size of the receive buffer.
Definition: socket.h:335
uint_t retransmitCount
Number of retransmissions.
Definition: socket.h:339
error_t socketSetVmanDei(Socket *socket, bool_t dei)
Set VMAN DEI flag.
Definition: socket.c:361
@ SOCKET_EVENT_LINK_UP
Definition: socket.h:164
MacAddr srcMacAddr
Source MAC address.
Definition: socket.h:211
error_t socketSetTxBufferSize(Socket *socket, size_t size)
Specify the size of the send buffer.
Definition: socket.c:485
uint_t dupAckCount
Number of consecutive duplicate ACKs.
Definition: socket.h:311
bool_t sackPermitted
SACK Permitted option received.
Definition: socket.h:326
@ SOCKET_FLAG_BREAK_CHAR
Definition: socket.h:123
uint32_t systime_t
System time.
Socket socketTable[SOCKET_MAX_COUNT]
Definition: socket.c:50
Receive queue item.
Definition: socket.h:230
uint32_t iss
Initial send sequence number.
Definition: socket.h:285
NetInterface * interface
Definition: socket.h:251
IpAddr destIpAddr
Destination IP address.
Definition: socket.h:208
uint8_t flags
Definition: tcp.h:349
SocketFlags
Flags used by I/O functions.
Definition: socket.h:118
error_t socketSetTtl(Socket *socket, uint8_t ttl)
Set TTL value for unicast datagrams.
Definition: socket.c:170
MacAddr destMacAddr
Destination MAC address.
Definition: socket.h:212
char char_t
Definition: compiler_port.h:43
error_t socketSetVlanDei(Socket *socket, bool_t dei)
Set VLAN DEI flag.
Definition: socket.c:291
error_t socketSendTo(Socket *socket, const IpAddr *destIpAddr, uint16_t destPort, const void *data, size_t length, size_t *written, uint_t flags)
Send a datagram to a specific destination.
Definition: socket.c:781
SACK block.
Definition: tcp.h:415
@ SOCKET_EVENT_TX_ACKED
Definition: socket.h:160
uint_t synQueueSize
Maximum number of pending connections for listening sockets.
Definition: socket.h:342
@ SOCKET_EVENT_NONE
Definition: socket.h:154
error_t socketSetVlanPcp(Socket *socket, uint8_t pcp)
Set VLAN priority.
Definition: socket.c:254
uint32_t sndWl1
Segment sequence number used for last window update.
Definition: socket.h:293
Socket * socketOpen(uint_t type, uint_t protocol)
Create a socket (UDP or TCP)
Definition: socket.c:122
bool_t rttBusy
RTT measurement is being performed.
Definition: socket.h:300
IPv4 and IPv6 common routines.
@ SOCKET_FLAG_NO_DELAY
Definition: socket.h:126
@ SOCKET_EVENT_RX_READY
Definition: socket.h:162
systime_t wndProbeInterval
Interval between successive probes.
Definition: socket.h:345
@ HOST_NAME_RESOLVER_ANY
Definition: socket.h:187
@ SOCKET_ETH_PROTO_IPV4
Definition: socket.h:107
int8_t vlanDei
Drop eligible indicator.
Definition: socket.h:264
@ SOCKET_IP_PROTO_ICMP
Definition: socket.h:91
TCP (Transmission Control Protocol)
@ SOCKET_EVENT_TX_SHUTDOWN
Definition: socket.h:161
error_t socketReceive(Socket *socket, void *data, size_t size, size_t *received, uint_t flags)
Receive data from a connected socket.
Definition: socket.c:966
@ SOCKET_TYPE_UNUSED
Definition: socket.h:77
@ SOCKET_ETH_PROTO_IPV6
Definition: socket.h:109
error_t socketPoll(SocketEventDesc *eventDesc, uint_t size, OsEvent *extEvent, systime_t timeout)
Wait for one of a set of sockets to become ready to perform I/O.
Definition: socket.c:1391
@ SOCKET_SD_RECEIVE
Definition: socket.h:142
#define Socket
Definition: socket.h:36
@ SOCKET_ETH_PROTO_ARP
Definition: socket.h:108
@ HOST_NAME_RESOLVER_NBNS
Definition: socket.h:190
error_t socketGetRemoteAddr(Socket *socket, IpAddr *remoteIpAddr, uint16_t *remotePort)
Retrieve the address of the peer to which a socket is connected.
Definition: socket.c:1259
uint8_t message[]
Definition: chap.h:152
int8_t vmanDei
Drop eligible indicator.
Definition: socket.h:268
size_t size
Size of the payload, in bytes.
Definition: socket.h:202
uint16_t sndWnd
Size of the send window.
Definition: socket.h:291
@ SOCKET_TYPE_RAW_ETH
Definition: socket.h:81
error_t socketReceiveMsg(Socket *socket, SocketMsg *message, uint_t flags)
Receive a message from a connectionless socket.
Definition: socket.c:1168
SYN queue item.
Definition: tcp.h:396
error_t socketSetInterface(Socket *socket, NetInterface *interface)
Bind a socket to a particular network interface.
Definition: socket.c:553
uint32_t sndUna
Data that have been sent but not yet acknowledged.
Definition: socket.h:288
error_t socketInit(void)
Socket related initialization.
Definition: socket.c:84
NetInterface * interface
Definition: socket.h:232
TcpSackBlock sackBlock[TCP_MAX_SACK_BLOCKS]
List of non-contiguous blocks that have been received.
Definition: socket.h:329
uint_t protocol
Definition: socket.h:250
error_t socketShutdown(Socket *socket, uint_t how)
Disable reception, transmission, or both.
Definition: socket.c:1294
systime_t timeout
Definition: socket.h:256
NetTimer retransmitTimer
Retransmission timer.
Definition: socket.h:338
error_t socketSetRxBufferSize(Socket *socket, size_t size)
Specify the size of the receive buffer.
Definition: socket.c:519
bool_t ownedFlag
The user is the owner of the TCP socket.
Definition: socket.h:279
error_t socketGetLocalAddr(Socket *socket, IpAddr *localIpAddr, uint16_t *localPort)
Retrieve the local address for a given socket.
Definition: socket.c:1227
uint32_t ttl
Definition: dns_common.h:205
Structure describing a socket.
Definition: socket.h:247
uint16_t srcPort
Definition: tcp.h:337
Socket * socket
Handle to a socket to monitor.
Definition: socket.h:366
@ SOCKET_EVENT_CONNECTED
Definition: socket.h:156
SocketEthProtocol
Ethernet protocols.
Definition: socket.h:104
Receive buffer.
Definition: tcp.h:438
TcpQueueItem * retransmitQueue
Retransmission queue.
Definition: socket.h:337
Transmit buffer.
Definition: tcp.h:426
unsigned int uint_t
Definition: compiler_port.h:45
systime_t rttvar
Round-trip time variation.
Definition: socket.h:304
@ SOCKET_FLAG_DONT_WAIT
Definition: socket.h:122
TCP/IP stack core.
@ SOCKET_EVENT_CLOSED
Definition: socket.h:157
TcpState state
Current state of the TCP finite state machine.
Definition: socket.h:278
uint_t sackBlockCount
Number of non-contiguous blocks that have been received.
Definition: socket.h:330
uint8_t ttl
Time-to-live value.
Definition: socket.h:204
#define SOCKET_MAX_COUNT
Definition: socket.h:46
systime_t rttStartTime
Round-trip start time.
Definition: socket.h:302
@ SOCKET_SD_BOTH
Definition: socket.h:144
uint32_t rttSeqNum
Sequence number identifying a TCP segment.
Definition: socket.h:301
SocketEvent
Socket events.
Definition: socket.h:153
@ SOCKET_ETH_PROTO_ALL
Definition: socket.h:105
@ SOCKET_IP_PROTO_TCP
Definition: socket.h:93
uint16_t srcPort
Source port.
Definition: socket.h:207
@ SOCKET_FLAG_BREAK_CRLF
Definition: socket.h:124
error_t socketSetKeepAliveParams(Socket *socket, systime_t idle, systime_t interval, uint_t maxProbes)
Set TCP keep-alive parameters.
Definition: socket.c:443
uint8_t ipAddr[4]
Definition: mib_common.h:187
uint_t n
Number of bytes acknowledged during the whole round-trip.
Definition: socket.h:312
NetBuffer * buffer
Definition: socket.h:236
uint_t eventMask
Requested events.
Definition: socket.h:367
error_t socketReceiveEx(Socket *socket, IpAddr *srcIpAddr, uint16_t *srcPort, IpAddr *destIpAddr, void *data, size_t size, size_t *received, uint_t flags)
Receive a datagram.
Definition: socket.c:1010
int_t errnoCode
Definition: socket.h:270
size_t offset
Definition: socket.h:237
error_t socketSetDscp(Socket *socket, uint8_t dscp)
Set DSCP field.
Definition: socket.c:220
error_t getHostByName(NetInterface *interface, const char_t *name, IpAddr *ipAddr, uint_t flags)
Resolve a host name into an IP address.
Definition: socket.c:1500
NetTimer overrideTimer
Override timer.
Definition: socket.h:348
Ipv4Addr destIpAddr
Definition: ipcp.h:78