Zephyr API Documentation 3.7.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
net_context.h
Go to the documentation of this file.
1
7/*
8 * Copyright (c) 2016 Intel Corporation
9 * Copyright (c) 2021 Nordic Semiconductor
10 *
11 * SPDX-License-Identifier: Apache-2.0
12 */
13
14#ifndef ZEPHYR_INCLUDE_NET_NET_CONTEXT_H_
15#define ZEPHYR_INCLUDE_NET_NET_CONTEXT_H_
16
26#include <zephyr/kernel.h>
27#include <zephyr/sys/atomic.h>
28
29#include <zephyr/net/net_ip.h>
30#include <zephyr/net/net_if.h>
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
38#define NET_CONTEXT_IN_USE BIT(0)
39
43enum net_context_state {
44 NET_CONTEXT_IDLE = 0,
45 NET_CONTEXT_UNCONNECTED = 0,
46 NET_CONTEXT_CONFIGURING = 1,
47 NET_CONTEXT_CONNECTING = 1,
48 NET_CONTEXT_READY = 2,
49 NET_CONTEXT_CONNECTED = 2,
50 NET_CONTEXT_LISTENING = 3,
51};
52
60#define NET_CONTEXT_FAMILY (BIT(3) | BIT(4) | BIT(5))
61
63#define NET_CONTEXT_TYPE (BIT(6) | BIT(7))
64
66#define NET_CONTEXT_REMOTE_ADDR_SET BIT(8)
67
69#define NET_CONTEXT_ACCEPTING_SOCK BIT(9)
70
72#define NET_CONTEXT_CLOSING_SOCK BIT(10)
73
75#define NET_CONTEXT_BOUND_TO_IFACE BIT(11)
76
77struct net_context;
78
99typedef void (*net_context_recv_cb_t)(struct net_context *context,
100 struct net_pkt *pkt,
101 union net_ip_header *ip_hdr,
102 union net_proto_header *proto_hdr,
103 int status,
104 void *user_data);
105
120typedef void (*net_context_send_cb_t)(struct net_context *context,
121 int status,
122 void *user_data);
123
140typedef void (*net_tcp_accept_cb_t)(struct net_context *new_context,
141 struct sockaddr *addr,
142 socklen_t addrlen,
143 int status,
144 void *user_data);
145
167typedef void (*net_context_connect_cb_t)(struct net_context *context,
168 int status,
169 void *user_data);
170
171/* The net_pkt_get_slab_func_t is here in order to avoid circular
172 * dependency between net_pkt.h and net_context.h
173 */
182typedef struct k_mem_slab *(*net_pkt_get_slab_func_t)(void);
183
184/* The net_pkt_get_pool_func_t is here in order to avoid circular
185 * dependency between net_pkt.h and net_context.h
186 */
195typedef struct net_buf_pool *(*net_pkt_get_pool_func_t)(void);
196
197struct net_tcp;
198
199struct net_conn_handle;
200
207__net_socket struct net_context {
211
215
219
222 struct k_mutex lock;
223
227 struct sockaddr_ptr local;
228
233
235 struct net_conn_handle *conn_handler;
236
241
246
251
252#if defined(CONFIG_NET_CONTEXT_NET_PKT_POOL)
256
259 net_pkt_get_pool_func_t data_pool;
260#endif /* CONFIG_NET_CONTEXT_NET_PKT_POOL */
261
262#if defined(CONFIG_NET_TCP)
264 void *tcp;
265#endif /* CONFIG_NET_TCP */
266
267#if defined(CONFIG_NET_CONTEXT_SYNC_RECV)
271 struct k_sem recv_data_wait;
272#endif /* CONFIG_NET_CONTEXT_SYNC_RECV */
273
274#if defined(CONFIG_NET_SOCKETS)
276 void *socket_data;
277
279 union {
280 struct k_fifo recv_q;
281 struct k_fifo accept_q;
282 };
283
284 struct {
286 struct k_condvar recv;
287
289 struct k_mutex *lock;
290 } cond;
291#endif /* CONFIG_NET_SOCKETS */
292
293#if defined(CONFIG_NET_OFFLOAD)
295 void *offload_context;
296#endif /* CONFIG_NET_OFFLOAD */
297
298#if defined(CONFIG_NET_SOCKETS_CAN)
299 int can_filter_id;
300#endif /* CONFIG_NET_SOCKETS_CAN */
301
303 struct {
304#if defined(CONFIG_NET_CONTEXT_PRIORITY)
306 uint8_t priority;
307#endif
308#if defined(CONFIG_NET_CONTEXT_TXTIME)
310 bool txtime;
311#endif
312#if defined(CONFIG_SOCKS)
314 struct {
315 struct sockaddr addr;
316 socklen_t addrlen;
317 } proxy;
318#endif
319#if defined(CONFIG_NET_CONTEXT_RCVTIMEO)
321 k_timeout_t rcvtimeo;
322#endif
323#if defined(CONFIG_NET_CONTEXT_SNDTIMEO)
325 k_timeout_t sndtimeo;
326#endif
327#if defined(CONFIG_NET_CONTEXT_RCVBUF)
329 uint16_t rcvbuf;
330#endif
331#if defined(CONFIG_NET_CONTEXT_SNDBUF)
333 uint16_t sndbuf;
334#endif
335#if defined(CONFIG_NET_CONTEXT_DSCP_ECN)
340 uint8_t dscp_ecn;
341#endif
342#if defined(CONFIG_NET_CONTEXT_REUSEADDR)
344 bool reuseaddr;
345#endif
346#if defined(CONFIG_NET_CONTEXT_REUSEPORT)
348 bool reuseport;
349#endif
350#if defined(CONFIG_NET_IPV4_MAPPING_TO_IPV6)
352 bool ipv6_v6only;
353#endif
354#if defined(CONFIG_NET_CONTEXT_RECV_PKTINFO)
356 bool recv_pktinfo;
357#endif
358#if defined(CONFIG_NET_IPV6)
363 uint16_t addr_preferences;
364#endif
365#if defined(CONFIG_NET_CONTEXT_TIMESTAMPING)
367 uint8_t timestamping;
368#endif
370
373
376
379
381 union {
382 struct {
385 };
386 struct {
389 };
390 };
391
392#if defined(CONFIG_SOCKS)
394 bool proxy_enabled;
395#endif
396
397};
398
406static inline bool net_context_is_used(struct net_context *context)
407{
408 NET_ASSERT(context);
409
410 return context->flags & NET_CONTEXT_IN_USE;
411}
412
420static inline bool net_context_is_bound_to_iface(struct net_context *context)
421{
422 NET_ASSERT(context);
423
424 return context->flags & NET_CONTEXT_BOUND_TO_IFACE;
425}
426
434static inline bool net_context_is_accepting(struct net_context *context)
435{
436 NET_ASSERT(context);
437
438 return context->flags & NET_CONTEXT_ACCEPTING_SOCK;
439}
440
447static inline void net_context_set_accepting(struct net_context *context,
448 bool accepting)
449{
450 NET_ASSERT(context);
451
452 if (accepting) {
454 } else {
456 }
457}
458
466static inline bool net_context_is_closing(struct net_context *context)
467{
468 NET_ASSERT(context);
469
470 return context->flags & NET_CONTEXT_CLOSING_SOCK;
471}
472
479static inline void net_context_set_closing(struct net_context *context,
480 bool closing)
481{
482 NET_ASSERT(context);
483
484 if (closing) {
486 } else {
488 }
489}
490
493#define NET_CONTEXT_STATE_SHIFT 1
494#define NET_CONTEXT_STATE_MASK 0x03
495
507static inline
508enum net_context_state net_context_get_state(struct net_context *context)
509{
510 NET_ASSERT(context);
511
512 return (enum net_context_state)
513 ((context->flags >> NET_CONTEXT_STATE_SHIFT) &
514 NET_CONTEXT_STATE_MASK);
515}
516
525static inline void net_context_set_state(struct net_context *context,
526 enum net_context_state state)
527{
528 NET_ASSERT(context);
529
530 context->flags &= ~(NET_CONTEXT_STATE_MASK << NET_CONTEXT_STATE_SHIFT);
531 context->flags |= ((state & NET_CONTEXT_STATE_MASK) <<
532 NET_CONTEXT_STATE_SHIFT);
533}
534
545static inline sa_family_t net_context_get_family(struct net_context *context)
546{
547 NET_ASSERT(context);
548
549 return ((context->flags & NET_CONTEXT_FAMILY) >> 3);
550}
551
561static inline void net_context_set_family(struct net_context *context,
562 sa_family_t family)
563{
564 uint8_t flag = 0U;
565
566 NET_ASSERT(context);
567
568 if (family == AF_UNSPEC || family == AF_INET || family == AF_INET6 ||
569 family == AF_PACKET || family == AF_CAN) {
570 /* Family is in BIT(4), BIT(5) and BIT(6) */
571 flag = (uint8_t)(family << 3);
572 }
573
574 context->flags |= flag;
575}
576
587static inline
589{
590 NET_ASSERT(context);
591
592 return (enum net_sock_type)((context->flags & NET_CONTEXT_TYPE) >> 6);
593}
594
604static inline void net_context_set_type(struct net_context *context,
605 enum net_sock_type type)
606{
607 uint16_t flag = 0U;
608
609 NET_ASSERT(context);
610
611 if (type == SOCK_DGRAM || type == SOCK_STREAM || type == SOCK_RAW) {
612 /* Type is in BIT(6) and BIT(7)*/
613 flag = (uint16_t)(type << 6);
614 }
615
616 context->flags |= flag;
617}
618
627#if defined(CONFIG_NET_SOCKETS_CAN)
628static inline void net_context_set_can_filter_id(struct net_context *context,
629 int filter_id)
630{
631 NET_ASSERT(context);
632
633 context->can_filter_id = filter_id;
634}
635#else
636static inline void net_context_set_can_filter_id(struct net_context *context,
637 int filter_id)
638{
639 ARG_UNUSED(context);
640 ARG_UNUSED(filter_id);
641}
642#endif
643
653#if defined(CONFIG_NET_SOCKETS_CAN)
654static inline int net_context_get_can_filter_id(struct net_context *context)
655{
656 NET_ASSERT(context);
657
658 return context->can_filter_id;
659}
660#else
661static inline int net_context_get_can_filter_id(struct net_context *context)
662{
663 ARG_UNUSED(context);
664
665 return -1;
666}
667#endif
668
679static inline uint16_t net_context_get_proto(struct net_context *context)
680{
681 return context->proto;
682}
683
694static inline void net_context_set_proto(struct net_context *context,
695 uint16_t proto)
696{
697 context->proto = proto;
698}
699
710static inline
712{
713 NET_ASSERT(context);
714
715 return net_if_get_by_index(context->iface);
716}
717
726static inline void net_context_set_iface(struct net_context *context,
727 struct net_if *iface)
728{
729 NET_ASSERT(iface);
730
731 context->iface = (uint8_t)net_if_get_by_iface(iface);
732}
733
742static inline void net_context_bind_iface(struct net_context *context,
743 struct net_if *iface)
744{
745 NET_ASSERT(iface);
746
748 net_context_set_iface(context, iface);
749}
750
761static inline uint8_t net_context_get_ipv4_ttl(struct net_context *context)
762{
763 return context->ipv4_ttl;
764}
765
775static inline void net_context_set_ipv4_ttl(struct net_context *context,
776 uint8_t ttl)
777{
778 context->ipv4_ttl = ttl;
779}
780
792{
793 return context->ipv4_mcast_ttl;
794}
795
805static inline void net_context_set_ipv4_mcast_ttl(struct net_context *context,
806 uint8_t ttl)
807{
808 context->ipv4_mcast_ttl = ttl;
809}
810
822{
823 return context->ipv6_hop_limit;
824}
825
834static inline void net_context_set_ipv6_hop_limit(struct net_context *context,
835 uint8_t hop_limit)
836{
837 context->ipv6_hop_limit = hop_limit;
838}
839
851{
852 return context->ipv6_mcast_hop_limit;
853}
854
864static inline void net_context_set_ipv6_mcast_hop_limit(struct net_context *context,
865 uint8_t hop_limit)
866{
867 context->ipv6_mcast_hop_limit = hop_limit;
868}
869
879#if defined(CONFIG_SOCKS)
880static inline void net_context_set_proxy_enabled(struct net_context *context,
881 bool enable)
882{
883 context->proxy_enabled = enable;
884}
885#else
886static inline void net_context_set_proxy_enabled(struct net_context *context,
887 bool enable)
888{
889 ARG_UNUSED(context);
890 ARG_UNUSED(enable);
891}
892#endif
893
904#if defined(CONFIG_SOCKS)
905static inline bool net_context_is_proxy_enabled(struct net_context *context)
906{
907 return context->proxy_enabled;
908}
909#else
910static inline bool net_context_is_proxy_enabled(struct net_context *context)
911{
912 ARG_UNUSED(context);
913 return false;
914}
915#endif
916
935 enum net_sock_type type,
936 uint16_t ip_proto,
937 struct net_context **context);
938
952int net_context_put(struct net_context *context);
953
966int net_context_ref(struct net_context *context);
967
981int net_context_unref(struct net_context *context);
982
993#if defined(CONFIG_NET_IPV4)
994int net_context_create_ipv4_new(struct net_context *context,
995 struct net_pkt *pkt,
996 const struct in_addr *src,
997 const struct in_addr *dst);
998#else
999static inline int net_context_create_ipv4_new(struct net_context *context,
1000 struct net_pkt *pkt,
1001 const struct in_addr *src,
1002 const struct in_addr *dst)
1003{
1004 return -1;
1005}
1006#endif /* CONFIG_NET_IPV4 */
1007
1018#if defined(CONFIG_NET_IPV6)
1019int net_context_create_ipv6_new(struct net_context *context,
1020 struct net_pkt *pkt,
1021 const struct in6_addr *src,
1022 const struct in6_addr *dst);
1023#else
1024static inline int net_context_create_ipv6_new(struct net_context *context,
1025 struct net_pkt *pkt,
1026 const struct in6_addr *src,
1027 const struct in6_addr *dst)
1028{
1029 ARG_UNUSED(context);
1030 ARG_UNUSED(pkt);
1031 ARG_UNUSED(src);
1032 ARG_UNUSED(dst);
1033 return -1;
1034}
1035#endif /* CONFIG_NET_IPV6 */
1036
1048int net_context_bind(struct net_context *context,
1049 const struct sockaddr *addr,
1050 socklen_t addrlen);
1051
1063 int backlog);
1064
1094 const struct sockaddr *addr,
1095 socklen_t addrlen,
1097 k_timeout_t timeout,
1098 void *user_data);
1099
1127 k_timeout_t timeout,
1128 void *user_data);
1129
1149int net_context_send(struct net_context *context,
1150 const void *buf,
1151 size_t len,
1153 k_timeout_t timeout,
1154 void *user_data);
1155
1178 const void *buf,
1179 size_t len,
1180 const struct sockaddr *dst_addr,
1181 socklen_t addrlen,
1183 k_timeout_t timeout,
1184 void *user_data);
1185
1205 const struct msghdr *msghdr,
1206 int flags,
1208 k_timeout_t timeout,
1209 void *user_data);
1210
1247int net_context_recv(struct net_context *context,
1249 k_timeout_t timeout,
1250 void *user_data);
1251
1273 int32_t delta);
1274
1296
1308 enum net_context_option option,
1309 const void *value, size_t len);
1310
1322 enum net_context_option option,
1323 void *value, size_t *len);
1324
1332typedef void (*net_context_cb_t)(struct net_context *context, void *user_data);
1333
1342
1363#if defined(CONFIG_NET_CONTEXT_NET_PKT_POOL)
1364static inline void net_context_setup_pools(struct net_context *context,
1366 net_pkt_get_pool_func_t data_pool)
1367{
1368 NET_ASSERT(context);
1369
1370 context->tx_slab = tx_slab;
1371 context->data_pool = data_pool;
1372}
1373#else
1374#define net_context_setup_pools(context, tx_pool, data_pool)
1375#endif
1376
1391 uint16_t local_port, const struct sockaddr *local_addr);
1392
1393#ifdef __cplusplus
1394}
1395#endif
1396
1401#endif /* ZEPHYR_INCLUDE_NET_NET_CONTEXT_H_ */
long atomic_t
Definition atomic_types.h:15
static ssize_t recv(int sock, void *buf, size_t max_len, int flags)
POSIX wrapper for zsock_recv.
Definition socket.h:926
unsigned short int sa_family_t
Socket address family type.
Definition net_ip.h:167
#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:87
size_t socklen_t
Length of a socket address.
Definition net_ip.h:171
#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:89
@ SOCK_RAW
RAW socket type
Definition net_ip.h:90
@ SOCK_STREAM
Stream socket type
Definition net_ip.h:88
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:604
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:834
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:726
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:775
void(* net_context_connect_cb_t)(struct net_context *context, int status, void *user_data)
Connection callback.
Definition net_context.h:167
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:588
static bool net_context_is_accepting(struct net_context *context)
Is this context is accepting data now.
Definition net_context.h:434
static sa_family_t net_context_get_family(struct net_context *context)
Get address family for this network context.
Definition net_context.h:545
static bool net_context_is_bound_to_iface(struct net_context *context)
Is this context bound to a network interface.
Definition net_context.h:420
static void net_context_bind_iface(struct net_context *context, struct net_if *iface)
Bind network interface to this context.
Definition net_context.h:742
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:182
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:791
static bool net_context_is_used(struct net_context *context)
Is this context used or not.
Definition net_context.h:406
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:508
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:636
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:910
#define NET_CONTEXT_IN_USE
Is this context used or not.
Definition net_context.h:38
static void net_context_set_accepting(struct net_context *context, bool accepting)
Set this context to accept data now.
Definition net_context.h:447
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:561
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:1024
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:999
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:661
#define NET_CONTEXT_CLOSING_SOCK
Is the socket closing / closed.
Definition net_context.h:72
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:821
static void net_context_set_closing(struct net_context *context, bool closing)
Set this context to closing.
Definition net_context.h:479
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:850
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:886
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:761
#define NET_CONTEXT_BOUND_TO_IFACE
Context is bound to a specific interface.
Definition net_context.h:75
void(* net_context_cb_t)(struct net_context *context, void *user_data)
Callback used while iterating over network contexts.
Definition net_context.h:1332
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:525
net_context_option
Network context options.
Definition net_context.h:1276
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:805
void(* net_context_send_cb_t)(struct net_context *context, int status, void *user_data)
Network data send callback.
Definition net_context.h:120
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:140
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:466
#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:60
#define NET_CONTEXT_TYPE
Type of the connection (datagram / stream / raw)
Definition net_context.h:63
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:694
#define net_context_setup_pools(context, tx_pool, data_pool)
Set custom network buffer pools for context send operations.
Definition net_context.h:1374
static uint16_t net_context_get_proto(struct net_context *context)
Get context IP protocol for this network context.
Definition net_context.h:679
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:195
#define NET_CONTEXT_ACCEPTING_SOCK
Is the socket accepting connections.
Definition net_context.h:69
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:864
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:99
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:711
@ NET_OPT_ADDR_PREFERENCES
IPv6 address preference.
Definition net_context.h:1293
@ NET_OPT_MCAST_TTL
IPv4 multicast TTL.
Definition net_context.h:1289
@ NET_OPT_REUSEADDR
Re-use address.
Definition net_context.h:1285
@ NET_OPT_SNDBUF
Send buffer.
Definition net_context.h:1283
@ NET_OPT_RECV_PKTINFO
Receive packet information.
Definition net_context.h:1288
@ NET_OPT_PRIORITY
Context priority.
Definition net_context.h:1277
@ NET_OPT_REUSEPORT
Re-use port.
Definition net_context.h:1286
@ NET_OPT_MCAST_HOP_LIMIT
IPv6 multicast hop limit.
Definition net_context.h:1290
@ NET_OPT_RCVTIMEO
Receive timeout.
Definition net_context.h:1280
@ NET_OPT_TXTIME
TX time.
Definition net_context.h:1278
@ NET_OPT_SNDTIMEO
Send timeout.
Definition net_context.h:1281
@ NET_OPT_SOCKS5
SOCKS5.
Definition net_context.h:1279
@ NET_OPT_TTL
IPv4 unicast TTL.
Definition net_context.h:1292
@ NET_OPT_RCVBUF
Receive buffer.
Definition net_context.h:1282
@ NET_OPT_UNICAST_HOP_LIMIT
IPv6 unicast hop limit.
Definition net_context.h:1291
@ NET_OPT_DSCP_ECN
DSCP ECN.
Definition net_context.h:1284
@ NET_OPT_TIMESTAMPING
Packet timestamping.
Definition net_context.h:1294
@ NET_OPT_IPV6_V6ONLY
Share IPv4 and IPv6 port space.
Definition net_context.h:1287
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:96
state
Definition parser_state.h:29
__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:142
IPv4 address struct.
Definition net_ip.h:154
Definition kernel.h:3106
Definition kernel.h:2468
Mutex Structure.
Definition kernel.h:2994
Kernel timeout type.
Definition sys_clock.h:65
Message struct.
Definition net_ip.h:250
Network buffer pool representation.
Definition net_buf.h:1078
Note that we do not store the actual source IP address in the context because the address is already ...
Definition net_context.h:207
atomic_t refcount
Reference count.
Definition net_context.h:218
void * user_data
User data associated with a context.
Definition net_context.h:214
struct net_context::@383 options
Option values.
void * fifo_reserved
First member of the structure to allow to put contexts into a FIFO.
Definition net_context.h:210
uint16_t flags
Flags for the context.
Definition net_context.h:375
uint8_t ipv4_mcast_ttl
IPv4 multicast TTL.
Definition net_context.h:388
net_context_send_cb_t send_cb
Send callback to be called when the packet has been sent successfully.
Definition net_context.h:245
struct sockaddr remote
Remote endpoint address.
Definition net_context.h:232
struct k_mutex lock
Internal lock for protecting this context from multiple access.
Definition net_context.h:222
struct sockaddr_ptr local
Local endpoint address.
Definition net_context.h:227
uint8_t ipv4_ttl
IPv4 TTL.
Definition net_context.h:387
uint8_t ipv6_mcast_hop_limit
IPv6 multicast hop limit.
Definition net_context.h:384
net_context_connect_cb_t connect_cb
Connect callback to be called when a connection has been established.
Definition net_context.h:250
struct net_conn_handle * conn_handler
Connection handle.
Definition net_context.h:235
uint16_t proto
Protocol (UDP, TCP or IEEE 802.3 protocol value)
Definition net_context.h:372
int8_t iface
Network interface assigned to this context.
Definition net_context.h:378
void * tcp
TCP connection information.
Definition net_context.h:264
net_context_recv_cb_t recv_cb
Receive callback to be called when desired packet has been received.
Definition net_context.h:240
uint8_t ipv6_hop_limit
IPv6 hop limit.
Definition net_context.h:383
Network Interface structure.
Definition net_if.h:680
Network packet.
Definition net_pkt.h:69
Generic sockaddr struct.
Definition net_ip.h:388