sock_types.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2016 Freie Universität Berlin
3  *
4  * This file is subject to the terms and conditions of the GNU Lesser
5  * General Public License v2.1. See the file LICENSE in the top level
6  * directory for more details.
7  */
8 
18 #ifndef SOCK_TYPES_H
19 #define SOCK_TYPES_H
20 
21 #include "net/af.h"
22 #include "lwip/api.h"
23 #ifdef SOCK_HAS_ASYNC
24 #include "net/sock/async/types.h"
25 #endif
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
35 typedef struct lwip_sock_base lwip_sock_base_t;
36 
37 #ifdef SOCK_HAS_ASYNC
42 typedef void (*lwip_sock_cb_t)(lwip_sock_base_t *sock,
43  sock_async_flags_t flags,
44  void *arg);
45 #endif /* SOCK_HAS_ASYNC */
46 
53 struct lwip_sock_base {
54  struct netconn *conn;
55 #ifdef SOCK_HAS_ASYNC
62  union {
63  lwip_sock_cb_t gen;
64 #ifdef MODULE_SOCK_IP
65  sock_ip_cb_t ip;
66 #endif
67 #ifdef MODULE_SOCK_TCP
68  sock_tcp_cb_t tcp;
72  sock_tcp_queue_cb_t tcp_queue;
73 #endif
74 #ifdef MODULE_SOCK_UDP
75  sock_udp_cb_t udp;
76 #endif
77  } async_cb;
78  void *async_cb_arg;
79 #ifdef SOCK_HAS_ASYNC_CTX
80  sock_async_ctx_t async_ctx;
81 #endif /* SOCK_HAS_ASYNC_CTX */
82 #endif /* SOCK_HAS_ASYNC */
83 };
84 
91 struct sock_ip {
92  lwip_sock_base_t base;
93 };
94 
101 struct sock_tcp {
102  lwip_sock_base_t base;
103  struct sock_tcp_queue *queue;
104  mutex_t mutex;
105  struct pbuf *last_buf;
106  ssize_t last_offset;
107 };
108 
114 struct sock_tcp_queue {
115  lwip_sock_base_t base;
116  struct sock_tcp *array;
117  mutex_t mutex;
118  unsigned short len;
119  unsigned short used;
120 };
121 
128 struct sock_udp {
129  lwip_sock_base_t base;
130 };
131 
132 #ifdef __cplusplus
133 }
134 #endif
135 
136 #endif /* SOCK_TYPES_H */
af.h
Global UNIX address family definitions.
sock_tcp_queue_cb_t
void(* sock_tcp_queue_cb_t)(sock_tcp_queue_t *queue, sock_async_flags_t flags, void *arg)
Event callback for sock_tcp_queue_t.
Definition: types.h:133
sock_udp_cb_t
void(* sock_udp_cb_t)(sock_udp_t *sock, sock_async_flags_t flags, void *arg)
Event callback for sock_udp_t.
Definition: types.h:157
sock_async_flags_t
sock_async_flags_t
Flag types to signify asynchronous sock events.
Definition: types.h:37
sock_tcp_cb_t
void(* sock_tcp_cb_t)(sock_tcp_t *sock, sock_async_flags_t flags, void *arg)
Event callback for sock_tcp_t.
Definition: types.h:117
sock_ip_cb_t
void(* sock_ip_cb_t)(sock_ip_t *sock, sock_async_flags_t flags, void *arg)
Event callback for sock_ip_t.
Definition: types.h:91
lwip_sock_base
Sock base type.
Definition: sock_types.h:53
lwip_sock_base::conn
struct netconn * conn
lwIP network connection object
Definition: sock_types.h:54
mutex_t
Mutex structure.
Definition: mutex.h:146
sock_async_ctx_t
Asynchronous context for Asynchronous sock with event API.
Definition: sock_async_ctx.h:64
sock_ip
Raw IP sock type.
Definition: sock_types.h:91
sock_ip::base
lwip_sock_base_t base
parent class
Definition: sock_types.h:92
sock_tcp_queue
TCP queue type.
Definition: sock_types.h:114
sock_tcp_queue::base
lwip_sock_base_t base
parent class
Definition: sock_types.h:115
sock_tcp_queue::len
unsigned short len
Length of the struct sock_tcp_queue::array.
Definition: sock_types.h:118
sock_tcp_queue::array
struct sock_tcp * array
Allocation array for sock objects to generate.
Definition: sock_types.h:116
sock_tcp_queue::used
unsigned short used
Used entries in struct sock_tcp_queue::array.
Definition: sock_types.h:119
sock_tcp_queue::mutex
mutex_t mutex
Mutex to protect the queue.
Definition: sock_types.h:117
sock_tcp
TCP sock type.
Definition: sock_types.h:101
sock_tcp::mutex
mutex_t mutex
Mutex to protect the sock.
Definition: sock_types.h:104
sock_tcp::base
lwip_sock_base_t base
parent class
Definition: sock_types.h:102
sock_tcp::last_offset
ssize_t last_offset
Offset in struct sock_tcp::last_buf since last read.
Definition: sock_types.h:106
sock_tcp::queue
struct sock_tcp_queue * queue
Queue the sock might have been generated from.
Definition: sock_types.h:103
sock_tcp::last_buf
struct pbuf * last_buf
Last received data.
Definition: sock_types.h:105
sock_udp
UDP sock type.
Definition: sock_types.h:128
sock_udp::base
lwip_sock_base_t base
parent class
Definition: sock_types.h:129
types.h
Definitions for sock extension for asynchronous access.