Zephyr API Documentation 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
net_context.h
Go to the documentation of this file.
1
6
7/*
8 * Copyright (c) 2016 Intel Corporation
9 * Copyright (c) 2021 Nordic Semiconductor
10 * Copyright (c) 2025 Aerlync Labs Inc.
11 * Copyright 2025 NXP
12 *
13 * SPDX-License-Identifier: Apache-2.0
14 */
15
16#ifndef ZEPHYR_INCLUDE_NET_NET_CONTEXT_H_
17#define ZEPHYR_INCLUDE_NET_NET_CONTEXT_H_
18
27
28#include <zephyr/kernel.h>
29#include <zephyr/sys/atomic.h>
30
31#include <zephyr/net/net_ip.h>
32#include <zephyr/net/net_if.h>
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
40#define NET_CONTEXT_IN_USE BIT(0)
41
43
45enum net_context_state {
46 NET_CONTEXT_IDLE = 0,
47 NET_CONTEXT_UNCONNECTED = 0,
48 NET_CONTEXT_CONFIGURING = 1,
49 NET_CONTEXT_CONNECTING = 1,
50 NET_CONTEXT_READY = 2,
51 NET_CONTEXT_CONNECTED = 2,
52 NET_CONTEXT_LISTENING = 3,
53};
54
56
62#define NET_CONTEXT_FAMILY (BIT(3) | BIT(4) | BIT(5))
63
65#define NET_CONTEXT_TYPE (BIT(6) | BIT(7))
66
68#define NET_CONTEXT_REMOTE_ADDR_SET BIT(8)
69
71#define NET_CONTEXT_ACCEPTING_SOCK BIT(9)
72
74#define NET_CONTEXT_CLOSING_SOCK BIT(10)
75
77#define NET_CONTEXT_BOUND_TO_IFACE BIT(11)
78
79struct net_context;
80
101typedef void (*net_context_recv_cb_t)(struct net_context *context,
102 struct net_pkt *pkt,
103 union net_ip_header *ip_hdr,
104 union net_proto_header *proto_hdr,
105 int status,
106 void *user_data);
107
122typedef void (*net_context_send_cb_t)(struct net_context *context,
123 int status,
124 void *user_data);
125
142typedef void (*net_tcp_accept_cb_t)(struct net_context *new_context,
143 struct sockaddr *addr,
144 socklen_t addrlen,
145 int status,
146 void *user_data);
147
169typedef void (*net_context_connect_cb_t)(struct net_context *context,
170 int status,
171 void *user_data);
172
173/* The net_pkt_get_slab_func_t is here in order to avoid circular
174 * dependency between net_pkt.h and net_context.h
175 */
184typedef struct k_mem_slab *(*net_pkt_get_slab_func_t)(void);
185
186/* The net_pkt_get_pool_func_t is here in order to avoid circular
187 * dependency between net_pkt.h and net_context.h
188 */
197typedef struct net_buf_pool *(*net_pkt_get_pool_func_t)(void);
198
199struct net_tcp;
200
201struct net_conn_handle;
202
209__net_socket struct net_context {
213
217
221
224 struct k_mutex lock;
225
229 struct sockaddr_ptr local;
230
235
237 struct net_conn_handle *conn_handler;
238
243
248
253
254#if defined(CONFIG_NET_CONTEXT_NET_PKT_POOL)
258
261 net_pkt_get_pool_func_t data_pool;
262#endif /* CONFIG_NET_CONTEXT_NET_PKT_POOL */
263
264#if defined(CONFIG_NET_TCP)
266 void *tcp;
267#endif /* CONFIG_NET_TCP */
268
269#if defined(CONFIG_NET_CONTEXT_SYNC_RECV)
273 struct k_sem recv_data_wait;
274#endif /* CONFIG_NET_CONTEXT_SYNC_RECV */
275
276#if defined(CONFIG_NET_SOCKETS)
278 void *socket_data;
279
281 union {
282 struct k_fifo recv_q;
283 struct k_fifo accept_q;
284 };
285
286 struct {
288 struct k_condvar recv;
289
291 struct k_mutex *lock;
292 } cond;
293#endif /* CONFIG_NET_SOCKETS */
294
295#if defined(CONFIG_NET_OFFLOAD)
297 void *offload_context;
298#endif /* CONFIG_NET_OFFLOAD */
299
300#if defined(CONFIG_NET_SOCKETS_CAN)
301 int can_filter_id;
302#endif /* CONFIG_NET_SOCKETS_CAN */
303
305 struct {
306#if defined(CONFIG_NET_CONTEXT_PRIORITY)
308 uint8_t priority;
309#endif
310#if defined(CONFIG_NET_CONTEXT_TXTIME)
312 bool txtime;
313#endif
314#if defined(CONFIG_SOCKS)
316 struct {
317 struct sockaddr addr;
318 socklen_t addrlen;
319 } proxy;
320#endif
321#if defined(CONFIG_NET_CONTEXT_CLAMP_PORT_RANGE)
333 uint32_t port_range;
334#endif
335#if defined(CONFIG_NET_CONTEXT_RCVTIMEO)
337 k_timeout_t rcvtimeo;
338#endif
339#if defined(CONFIG_NET_CONTEXT_SNDTIMEO)
341 k_timeout_t sndtimeo;
342#endif
343#if defined(CONFIG_NET_CONTEXT_RCVBUF)
345 uint16_t rcvbuf;
346#endif
347#if defined(CONFIG_NET_CONTEXT_SNDBUF)
349 uint16_t sndbuf;
350#endif
351#if defined(CONFIG_NET_CONTEXT_DSCP_ECN)
356 uint8_t dscp_ecn;
357#endif
358#if defined(CONFIG_NET_CONTEXT_REUSEADDR)
360 bool reuseaddr;
361#endif
362#if defined(CONFIG_NET_CONTEXT_REUSEPORT)
364 bool reuseport;
365#endif
366#if defined(CONFIG_NET_IPV4_MAPPING_TO_IPV6)
368 bool ipv6_v6only;
369#endif
370#if defined(CONFIG_NET_CONTEXT_RECV_PKTINFO)
372 bool recv_pktinfo;
373#endif
374#if defined(CONFIG_NET_CONTEXT_RECV_HOPLIMIT)
376 bool recv_hoplimit;
377#endif
378#if defined(CONFIG_NET_IPV6)
383 uint16_t addr_preferences;
384#endif
385#if defined(CONFIG_NET_IPV6) || defined(CONFIG_NET_IPV4)
386 union {
391 uint8_t ipv6_mcast_ifindex;
392
397 uint8_t ipv4_mcast_ifindex;
398 };
400 union {
401 bool ipv6_mcast_loop;
402 bool ipv4_mcast_loop;
403 };
404#endif /* CONFIG_NET_IPV6 || CONFIG_NET_IPV4 */
405
406#if defined(CONFIG_NET_CONTEXT_TIMESTAMPING)
408 uint8_t timestamping;
409#endif
411
414
417
420
422 union {
423 struct {
426 };
427 struct {
430 };
431 };
432
433#if defined(CONFIG_SOCKS)
435 bool proxy_enabled;
436#endif
437
438};
439
447static inline bool net_context_is_used(struct net_context *context)
448{
449 NET_ASSERT(context);
450
451 return context->flags & NET_CONTEXT_IN_USE;
452}
453
461static inline bool net_context_is_bound_to_iface(struct net_context *context)
462{
463 NET_ASSERT(context);
464
465 return context->flags & NET_CONTEXT_BOUND_TO_IFACE;
466}
467
475static inline bool net_context_is_accepting(struct net_context *context)
476{
477 NET_ASSERT(context);
478
479 return context->flags & NET_CONTEXT_ACCEPTING_SOCK;
480}
481
488static inline void net_context_set_accepting(struct net_context *context,
489 bool accepting)
490{
491 NET_ASSERT(context);
492
493 if (accepting) {
495 } else {
497 }
498}
499
507static inline bool net_context_is_closing(struct net_context *context)
508{
509 NET_ASSERT(context);
510
511 return context->flags & NET_CONTEXT_CLOSING_SOCK;
512}
513
520static inline void net_context_set_closing(struct net_context *context,
521 bool closing)
522{
523 NET_ASSERT(context);
524
525 if (closing) {
527 } else {
529 }
530}
531
533
534#define NET_CONTEXT_STATE_SHIFT 1
535#define NET_CONTEXT_STATE_MASK 0x03
536
538
548static inline
549enum net_context_state net_context_get_state(struct net_context *context)
550{
551 NET_ASSERT(context);
552
553 return (enum net_context_state)
554 ((context->flags >> NET_CONTEXT_STATE_SHIFT) &
555 NET_CONTEXT_STATE_MASK);
556}
557
566static inline void net_context_set_state(struct net_context *context,
567 enum net_context_state state)
568{
569 NET_ASSERT(context);
570
571 context->flags &= ~(NET_CONTEXT_STATE_MASK << NET_CONTEXT_STATE_SHIFT);
572 context->flags |= ((state & NET_CONTEXT_STATE_MASK) <<
573 NET_CONTEXT_STATE_SHIFT);
574}
575
586static inline sa_family_t net_context_get_family(struct net_context *context)
587{
588 NET_ASSERT(context);
589
590 return ((context->flags & NET_CONTEXT_FAMILY) >> 3);
591}
592
602static inline void net_context_set_family(struct net_context *context,
603 sa_family_t family)
604{
605 uint8_t flag = 0U;
606
607 NET_ASSERT(context);
608
609 if (family == AF_UNSPEC || family == AF_INET || family == AF_INET6 ||
610 family == AF_PACKET || family == AF_CAN) {
611 /* Family is in BIT(4), BIT(5) and BIT(6) */
612 flag = (uint8_t)(family << 3);
613 }
614
615 context->flags |= flag;
616}
617
628static inline
630{
631 NET_ASSERT(context);
632
633 return (enum net_sock_type)((context->flags & NET_CONTEXT_TYPE) >> 6);
634}
635
645static inline void net_context_set_type(struct net_context *context,
646 enum net_sock_type type)
647{
648 uint16_t flag = 0U;
649
650 NET_ASSERT(context);
651
652 if (type == SOCK_DGRAM || type == SOCK_STREAM || type == SOCK_RAW) {
653 /* Type is in BIT(6) and BIT(7)*/
654 flag = (uint16_t)(type << 6);
655 }
656
657 context->flags |= flag;
658}
659
668#if defined(CONFIG_NET_SOCKETS_CAN)
669static inline void net_context_set_can_filter_id(struct net_context *context,
670 int filter_id)
671{
672 NET_ASSERT(context);
673
674 context->can_filter_id = filter_id;
675}
676#else
677static inline void net_context_set_can_filter_id(struct net_context *context,
678 int filter_id)
679{
680 ARG_UNUSED(context);
681 ARG_UNUSED(filter_id);
682}
683#endif
684
694#if defined(CONFIG_NET_SOCKETS_CAN)
695static inline int net_context_get_can_filter_id(struct net_context *context)
696{
697 NET_ASSERT(context);
698
699 return context->can_filter_id;
700}
701#else
702static inline int net_context_get_can_filter_id(struct net_context *context)
703{
704 ARG_UNUSED(context);
705
706 return -1;
707}
708#endif
709
720static inline uint16_t net_context_get_proto(struct net_context *context)
721{
722 return context->proto;
723}
724
735static inline void net_context_set_proto(struct net_context *context,
736 uint16_t proto)
737{
738 context->proto = proto;
739}
740
751static inline
753{
754 NET_ASSERT(context);
755
756 return net_if_get_by_index(context->iface);
757}
758
767static inline void net_context_set_iface(struct net_context *context,
768 struct net_if *iface)
769{
770 NET_ASSERT(iface);
771
772 context->iface = (uint8_t)net_if_get_by_iface(iface);
773}
774
783static inline void net_context_bind_iface(struct net_context *context,
784 struct net_if *iface)
785{
786 NET_ASSERT(iface);
787
789 net_context_set_iface(context, iface);
790}
791
802static inline uint8_t net_context_get_ipv4_ttl(struct net_context *context)
803{
804 return context->ipv4_ttl;
805}
806
816static inline void net_context_set_ipv4_ttl(struct net_context *context,
817 uint8_t ttl)
818{
819 context->ipv4_ttl = ttl;
820}
821
833{
834 return context->ipv4_mcast_ttl;
835}
836
846static inline void net_context_set_ipv4_mcast_ttl(struct net_context *context,
847 uint8_t ttl)
848{
849 context->ipv4_mcast_ttl = ttl;
850}
851
852#if defined(CONFIG_NET_IPV4)
863static inline bool net_context_get_ipv4_mcast_loop(struct net_context *context)
864{
865 return context->options.ipv4_mcast_loop;
866}
867
877static inline void net_context_set_ipv4_mcast_loop(struct net_context *context,
878 bool ipv4_mcast_loop)
879{
880 context->options.ipv4_mcast_loop = ipv4_mcast_loop;
881}
882#endif
883
895{
896 return context->ipv6_hop_limit;
897}
898
907static inline void net_context_set_ipv6_hop_limit(struct net_context *context,
908 uint8_t hop_limit)
909{
910 context->ipv6_hop_limit = hop_limit;
911}
912
924{
925 return context->ipv6_mcast_hop_limit;
926}
927
937static inline void net_context_set_ipv6_mcast_hop_limit(struct net_context *context,
938 uint8_t hop_limit)
939{
940 context->ipv6_mcast_hop_limit = hop_limit;
941}
942
943#if defined(CONFIG_NET_IPV6)
944
955static inline bool net_context_get_ipv6_mcast_loop(struct net_context *context)
956{
957 return context->options.ipv6_mcast_loop;
958}
959
969static inline void net_context_set_ipv6_mcast_loop(struct net_context *context,
970 bool ipv6_mcast_loop)
971{
972 context->options.ipv6_mcast_loop = ipv6_mcast_loop;
973}
974
975#endif
976
986#if defined(CONFIG_SOCKS)
987static inline void net_context_set_proxy_enabled(struct net_context *context,
988 bool enable)
989{
990 context->proxy_enabled = enable;
991}
992#else
993static inline void net_context_set_proxy_enabled(struct net_context *context,
994 bool enable)
995{
996 ARG_UNUSED(context);
997 ARG_UNUSED(enable);
998}
999#endif
1000
1011#if defined(CONFIG_SOCKS)
1012static inline bool net_context_is_proxy_enabled(struct net_context *context)
1013{
1014 return context->proxy_enabled;
1015}
1016#else
1017static inline bool net_context_is_proxy_enabled(struct net_context *context)
1018{
1019 ARG_UNUSED(context);
1020 return false;
1021}
1022#endif
1023
1042 enum net_sock_type type,
1043 uint16_t ip_proto,
1044 struct net_context **context);
1045
1059int net_context_put(struct net_context *context);
1060
1073int net_context_ref(struct net_context *context);
1074
1088int net_context_unref(struct net_context *context);
1089
1100#if defined(CONFIG_NET_IPV4)
1101int net_context_create_ipv4_new(struct net_context *context,
1102 struct net_pkt *pkt,
1103 const struct in_addr *src,
1104 const struct in_addr *dst);
1105#else
1106static inline int net_context_create_ipv4_new(struct net_context *context,
1107 struct net_pkt *pkt,
1108 const struct in_addr *src,
1109 const struct in_addr *dst)
1110{
1111 return -1;
1112}
1113#endif /* CONFIG_NET_IPV4 */
1114
1125#if defined(CONFIG_NET_IPV6)
1126int net_context_create_ipv6_new(struct net_context *context,
1127 struct net_pkt *pkt,
1128 const struct in6_addr *src,
1129 const struct in6_addr *dst);
1130#else
1131static inline int net_context_create_ipv6_new(struct net_context *context,
1132 struct net_pkt *pkt,
1133 const struct in6_addr *src,
1134 const struct in6_addr *dst)
1135{
1136 ARG_UNUSED(context);
1137 ARG_UNUSED(pkt);
1138 ARG_UNUSED(src);
1139 ARG_UNUSED(dst);
1140 return -1;
1141}
1142#endif /* CONFIG_NET_IPV6 */
1143
1155int net_context_bind(struct net_context *context,
1156 const struct sockaddr *addr,
1157 socklen_t addrlen);
1158
1170 int backlog);
1171
1201 const struct sockaddr *addr,
1202 socklen_t addrlen,
1204 k_timeout_t timeout,
1205 void *user_data);
1206
1234 k_timeout_t timeout,
1235 void *user_data);
1236
1256int net_context_send(struct net_context *context,
1257 const void *buf,
1258 size_t len,
1260 k_timeout_t timeout,
1261 void *user_data);
1262
1285 const void *buf,
1286 size_t len,
1287 const struct sockaddr *dst_addr,
1288 socklen_t addrlen,
1290 k_timeout_t timeout,
1291 void *user_data);
1292
1312 const struct msghdr *msghdr,
1313 int flags,
1315 k_timeout_t timeout,
1316 void *user_data);
1317
1354int net_context_recv(struct net_context *context,
1356 k_timeout_t timeout,
1357 void *user_data);
1358
1380 int32_t delta);
1381
1409
1421 enum net_context_option option,
1422 const void *value, size_t len);
1423
1435 enum net_context_option option,
1436 void *value, size_t *len);
1437
1445typedef void (*net_context_cb_t)(struct net_context *context, void *user_data);
1446
1455
1476#if defined(CONFIG_NET_CONTEXT_NET_PKT_POOL)
1477static inline void net_context_setup_pools(struct net_context *context,
1479 net_pkt_get_pool_func_t data_pool)
1480{
1481 NET_ASSERT(context);
1482
1483 context->tx_slab = tx_slab;
1484 context->data_pool = data_pool;
1485}
1486#else
1487#define net_context_setup_pools(context, tx_pool, data_pool)
1488#endif
1489
1504 uint16_t local_port, const struct sockaddr *local_addr);
1505
1506#ifdef __cplusplus
1507}
1508#endif
1509
1513
1514#endif /* ZEPHYR_INCLUDE_NET_NET_CONTEXT_H_ */
long atomic_t
Definition atomic_types.h:15
unsigned short int sa_family_t
Socket address family type.
Definition net_ip.h:168
#define AF_CAN
Controller Area Network.
Definition net_ip.h:58
#define AF_INET
IP protocol family version 4.
Definition net_ip.h:55
#define AF_INET6
IP protocol family version 6.
Definition net_ip.h:56
#define AF_PACKET
Packet family.
Definition net_ip.h:57
net_sock_type
Socket type.
Definition net_ip.h:88
size_t socklen_t
Length of a socket address.
Definition net_ip.h:172
#define AF_UNSPEC
Unspecified address family.
Definition net_ip.h:54
net_ip_protocol
Protocol numbers from IANA/BSD.
Definition net_ip.h:64
@ SOCK_DGRAM
Datagram socket type.
Definition net_ip.h:90
@ SOCK_RAW
RAW socket type.
Definition net_ip.h:91
@ SOCK_STREAM
Stream socket type.
Definition net_ip.h:89
static void net_context_set_type(struct net_context *context, enum net_sock_type type)
Set context type for this network context.
Definition net_context.h:645
static void net_context_set_ipv6_hop_limit(struct net_context *context, uint8_t hop_limit)
Set IPv6 hop limit value for this context.
Definition net_context.h:907
int net_context_unref(struct net_context *context)
Decrement the reference count to a network context.
int net_context_bind(struct net_context *context, const struct sockaddr *addr, socklen_t addrlen)
Assign a socket a local address.
static void net_context_set_iface(struct net_context *context, struct net_if *iface)
Set network interface for this context.
Definition net_context.h:767
static void net_context_set_ipv4_ttl(struct net_context *context, uint8_t ttl)
Set IPv4 TTL (time-to-live) value for this context.
Definition net_context.h:816
void(* net_context_connect_cb_t)(struct net_context *context, int status, void *user_data)
Connection callback.
Definition net_context.h:169
int net_context_accept(struct net_context *context, net_tcp_accept_cb_t cb, k_timeout_t timeout, void *user_data)
Accept a network connection attempt.
int net_context_put(struct net_context *context)
Close and unref a network context.
static enum net_sock_type net_context_get_type(struct net_context *context)
Get context type for this network context.
Definition net_context.h:629
static bool net_context_is_accepting(struct net_context *context)
Is this context is accepting data now.
Definition net_context.h:475
static sa_family_t net_context_get_family(struct net_context *context)
Get address family for this network context.
Definition net_context.h:586
static bool net_context_is_bound_to_iface(struct net_context *context)
Is this context bound to a network interface.
Definition net_context.h:461
static void net_context_bind_iface(struct net_context *context, struct net_if *iface)
Bind network interface to this context.
Definition net_context.h:783
int net_context_listen(struct net_context *context, int backlog)
Mark the context as a listening one.
struct k_mem_slab *(* net_pkt_get_slab_func_t)(void)
Function that is called to get the slab that is used for net_pkt allocations.
Definition net_context.h:184
static uint8_t net_context_get_ipv4_mcast_ttl(struct net_context *context)
Get IPv4 multicast TTL (time-to-live) value for this context.
Definition net_context.h:832
static bool net_context_is_used(struct net_context *context)
Is this context used or not.
Definition net_context.h:447
int net_context_sendmsg(struct net_context *context, const struct msghdr *msghdr, int flags, net_context_send_cb_t cb, k_timeout_t timeout, void *user_data)
Send data in iovec to a peer specified in msghdr struct.
int net_context_ref(struct net_context *context)
Take a reference count to a net_context, preventing destruction.
static enum net_context_state net_context_get_state(struct net_context *context)
Get state for this network context.
Definition net_context.h:549
int net_context_connect(struct net_context *context, const struct sockaddr *addr, socklen_t addrlen, net_context_connect_cb_t cb, k_timeout_t timeout, void *user_data)
Create a network connection.
static void net_context_set_can_filter_id(struct net_context *context, int filter_id)
Set CAN filter id for this network context.
Definition net_context.h:677
static bool net_context_is_proxy_enabled(struct net_context *context)
Is socks proxy support enabled or disabled for this context.
Definition net_context.h:1017
#define NET_CONTEXT_IN_USE
Is this context used or not.
Definition net_context.h:40
static void net_context_set_accepting(struct net_context *context, bool accepting)
Set this context to accept data now.
Definition net_context.h:488
bool net_context_port_in_use(enum net_ip_protocol ip_proto, uint16_t local_port, const struct sockaddr *local_addr)
Check if a port is in use (bound)
static void net_context_set_family(struct net_context *context, sa_family_t family)
Set address family for this network context.
Definition net_context.h:602
static int net_context_create_ipv6_new(struct net_context *context, struct net_pkt *pkt, const struct in6_addr *src, const struct in6_addr *dst)
Create IPv6 packet in provided net_pkt from context.
Definition net_context.h:1131
static int net_context_create_ipv4_new(struct net_context *context, struct net_pkt *pkt, const struct in_addr *src, const struct in_addr *dst)
Create IPv4 packet in provided net_pkt from context.
Definition net_context.h:1106
int net_context_recv(struct net_context *context, net_context_recv_cb_t cb, k_timeout_t timeout, void *user_data)
Receive network data from a peer specified by context.
static int net_context_get_can_filter_id(struct net_context *context)
Get CAN filter id for this network context.
Definition net_context.h:702
#define NET_CONTEXT_CLOSING_SOCK
Is the socket closing / closed.
Definition net_context.h:74
static uint8_t net_context_get_ipv6_hop_limit(struct net_context *context)
Get IPv6 hop limit value for this context.
Definition net_context.h:894
static void net_context_set_closing(struct net_context *context, bool closing)
Set this context to closing.
Definition net_context.h:520
static uint8_t net_context_get_ipv6_mcast_hop_limit(struct net_context *context)
Get IPv6 multicast hop limit value for this context.
Definition net_context.h:923
static void net_context_set_proxy_enabled(struct net_context *context, bool enable)
Enable or disable socks proxy support for this context.
Definition net_context.h:993
static uint8_t net_context_get_ipv4_ttl(struct net_context *context)
Get IPv4 TTL (time-to-live) value for this context.
Definition net_context.h:802
#define NET_CONTEXT_BOUND_TO_IFACE
Context is bound to a specific interface.
Definition net_context.h:77
void(* net_context_cb_t)(struct net_context *context, void *user_data)
Callback used while iterating over network contexts.
Definition net_context.h:1445
static void net_context_set_state(struct net_context *context, enum net_context_state state)
Set state for this network context.
Definition net_context.h:566
net_context_option
Network context options.
Definition net_context.h:1383
static void net_context_set_ipv4_mcast_ttl(struct net_context *context, uint8_t ttl)
Set IPv4 multicast TTL (time-to-live) value for this context.
Definition net_context.h:846
void(* net_context_send_cb_t)(struct net_context *context, int status, void *user_data)
Network data send callback.
Definition net_context.h:122
int net_context_update_recv_wnd(struct net_context *context, int32_t delta)
Update TCP receive window for context.
void net_context_foreach(net_context_cb_t cb, void *user_data)
Go through all the network connections and call callback for each network context.
int net_context_set_option(struct net_context *context, enum net_context_option option, const void *value, size_t len)
Set an connection option for this context.
void(* net_tcp_accept_cb_t)(struct net_context *new_context, struct sockaddr *addr, socklen_t addrlen, int status, void *user_data)
Accept callback.
Definition net_context.h:142
int net_context_send(struct net_context *context, const void *buf, size_t len, net_context_send_cb_t cb, k_timeout_t timeout, void *user_data)
Send data to a peer.
static bool net_context_is_closing(struct net_context *context)
Is this context closing.
Definition net_context.h:507
#define NET_CONTEXT_FAMILY
The address family, connection type and IP protocol are stored into a bit field to save space.
Definition net_context.h:62
#define NET_CONTEXT_TYPE
Type of the connection (datagram / stream / raw)
Definition net_context.h:65
static void net_context_set_proto(struct net_context *context, uint16_t proto)
Set context IP protocol for this network context.
Definition net_context.h:735
#define net_context_setup_pools(context, tx_pool, data_pool)
Set custom network buffer pools for context send operations.
Definition net_context.h:1487
static uint16_t net_context_get_proto(struct net_context *context)
Get context IP protocol for this network context.
Definition net_context.h:720
int net_context_get(sa_family_t family, enum net_sock_type type, uint16_t ip_proto, struct net_context **context)
Get network context.
struct net_buf_pool *(* net_pkt_get_pool_func_t)(void)
Function that is called to get the pool that is used for net_buf allocations.
Definition net_context.h:197
#define NET_CONTEXT_ACCEPTING_SOCK
Is the socket accepting connections.
Definition net_context.h:71
int net_context_get_option(struct net_context *context, enum net_context_option option, void *value, size_t *len)
Get connection option value for this context.
static void net_context_set_ipv6_mcast_hop_limit(struct net_context *context, uint8_t hop_limit)
Set IPv6 multicast hop limit value for this context.
Definition net_context.h:937
void(* net_context_recv_cb_t)(struct net_context *context, struct net_pkt *pkt, union net_ip_header *ip_hdr, union net_proto_header *proto_hdr, int status, void *user_data)
Network data receive callback.
Definition net_context.h:101
int net_context_sendto(struct net_context *context, const void *buf, size_t len, const struct sockaddr *dst_addr, socklen_t addrlen, net_context_send_cb_t cb, k_timeout_t timeout, void *user_data)
Send data to a peer specified by address.
static struct net_if * net_context_get_iface(struct net_context *context)
Get network interface for this context.
Definition net_context.h:752
@ NET_OPT_ADDR_PREFERENCES
IPv6 address preference.
Definition net_context.h:1400
@ NET_OPT_MCAST_TTL
IPv4 multicast TTL.
Definition net_context.h:1396
@ NET_OPT_REUSEADDR
Re-use address.
Definition net_context.h:1392
@ NET_OPT_SNDBUF
Send buffer.
Definition net_context.h:1390
@ NET_OPT_IPV4_MCAST_LOOP
IPV4 multicast loop.
Definition net_context.h:1406
@ NET_OPT_RECV_PKTINFO
Receive packet information.
Definition net_context.h:1395
@ NET_OPT_RECV_HOPLIMIT
Receive hop limit information.
Definition net_context.h:1407
@ NET_OPT_LOCAL_PORT_RANGE
Clamp local port range.
Definition net_context.h:1404
@ NET_OPT_PRIORITY
Context priority.
Definition net_context.h:1384
@ NET_OPT_REUSEPORT
Re-use port.
Definition net_context.h:1393
@ NET_OPT_MCAST_HOP_LIMIT
IPv6 multicast hop limit.
Definition net_context.h:1397
@ NET_OPT_RCVTIMEO
Receive timeout.
Definition net_context.h:1387
@ NET_OPT_TXTIME
TX time.
Definition net_context.h:1385
@ NET_OPT_SNDTIMEO
Send timeout.
Definition net_context.h:1388
@ NET_OPT_MCAST_IFINDEX
IPv6 multicast output network interface index.
Definition net_context.h:1402
@ NET_OPT_SOCKS5
SOCKS5.
Definition net_context.h:1386
@ NET_OPT_IPV6_MCAST_LOOP
IPV6 multicast loop.
Definition net_context.h:1405
@ NET_OPT_TTL
IPv4 unicast TTL.
Definition net_context.h:1399
@ NET_OPT_RCVBUF
Receive buffer.
Definition net_context.h:1389
@ NET_OPT_MTU
IPv4 socket path MTU.
Definition net_context.h:1403
@ NET_OPT_UNICAST_HOP_LIMIT
IPv6 unicast hop limit.
Definition net_context.h:1398
@ NET_OPT_DSCP_ECN
DSCP ECN.
Definition net_context.h:1391
@ NET_OPT_TIMESTAMPING
Packet timestamping.
Definition net_context.h:1401
@ NET_OPT_IPV6_V6ONLY
Share IPv4 and IPv6 port space.
Definition net_context.h:1394
int net_if_get_by_iface(struct net_if *iface)
Get interface index according to pointer.
struct net_if * net_if_get_by_index(int index)
Get interface according to index.
Public kernel APIs.
Public API for network interface.
IPv6 and IPv4 definitions.
Network statistics.
flags
Definition parser.h:97
state
Definition parser_state.h:29
ssize_t recv(int sock, void *buf, size_t max_len, int flags)
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__INT32_TYPE__ int32_t
Definition stdint.h:74
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
__INT8_TYPE__ int8_t
Definition stdint.h:72
IPv6 address struct.
Definition net_ip.h:143
IPv4 address struct.
Definition net_ip.h:155
Definition kernel.h:3182
Definition kernel.h:2540
Mutex Structure.
Definition kernel.h:3070
Semaphore structure.
Definition kernel.h:3275
Kernel timeout type.
Definition clock.h:65
Message struct.
Definition net_ip.h:257
Network buffer pool representation.
Definition net_buf.h:1079
Note that we do not store the actual source IP address in the context because the address is already ...
Definition net_context.h:209
atomic_t refcount
Reference count.
Definition net_context.h:220
void * user_data
User data associated with a context.
Definition net_context.h:216
void * fifo_reserved
First member of the structure to allow to put contexts into a FIFO.
Definition net_context.h:212
uint16_t flags
Flags for the context.
Definition net_context.h:416
uint8_t ipv4_mcast_ttl
IPv4 multicast TTL.
Definition net_context.h:429
net_context_send_cb_t send_cb
Send callback to be called when the packet has been sent successfully.
Definition net_context.h:247
struct sockaddr remote
Remote endpoint address.
Definition net_context.h:234
struct k_mutex lock
Internal lock for protecting this context from multiple access.
Definition net_context.h:224
struct sockaddr_ptr local
Local endpoint address.
Definition net_context.h:229
uint8_t ipv4_ttl
IPv4 TTL.
Definition net_context.h:428
uint8_t ipv6_mcast_hop_limit
IPv6 multicast hop limit.
Definition net_context.h:425
net_context_connect_cb_t connect_cb
Connect callback to be called when a connection has been established.
Definition net_context.h:252
struct net_conn_handle * conn_handler
Connection handle.
Definition net_context.h:237
uint16_t proto
Protocol (UDP, TCP or IEEE 802.3 protocol value)
Definition net_context.h:413
int8_t iface
Network interface assigned to this context.
Definition net_context.h:419
void * tcp
TCP connection information.
Definition net_context.h:266
struct net_context::@301222043044136136127251054270033130365030331345 options
Option values.
net_context_recv_cb_t recv_cb
Receive callback to be called when desired packet has been received.
Definition net_context.h:242
uint8_t ipv6_hop_limit
IPv6 hop limit.
Definition net_context.h:424
Network Interface structure.
Definition net_if.h:726
Network packet.
Definition net_pkt.h:91
Generic sockaddr struct.
Definition net_ip.h:410