pkg_2lwip_2include_2sock__types_8h_source.html

/*

 * Copyright (C) 2016 Freie Universität Berlin

 *

 * This file is subject to the terms and conditions of the GNU Lesser

 * General Public License v2.1. See the file LICENSE in the top level

 * directory for more details.

 */


#ifndef SOCK_TYPES_H

#define SOCK_TYPES_H


#include "net/af.h"

#include "lwip/api.h"

#ifdef SOCK_HAS_ASYNC

#include "net/sock/async/types.h"

#endif


#ifdef __cplusplus

extern "C" {

#endif


typedef struct lwip_sock_base lwip_sock_base_t;


#ifdef SOCK_HAS_ASYNC

typedef void (*lwip_sock_cb_t)(lwip_sock_base_t *sock,

                               sock_async_flags_t flags,

                               void *arg);

#endif  /* SOCK_HAS_ASYNC */


struct lwip_sock_base {

    struct netconn *conn;

#ifdef SOCK_HAS_ASYNC

    union {

        lwip_sock_cb_t gen;

#ifdef MODULE_SOCK_IP

        sock_ip_cb_t ip;

#endif

#ifdef MODULE_SOCK_TCP

        sock_tcp_cb_t tcp;

        sock_tcp_queue_cb_t tcp_queue;

#endif

#ifdef MODULE_SOCK_UDP

        sock_udp_cb_t udp;

#endif

    } async_cb;

    void *async_cb_arg;

#ifdef SOCK_HAS_ASYNC_CTX

    sock_async_ctx_t async_ctx;

#endif  /* SOCK_HAS_ASYNC_CTX */

#endif  /* SOCK_HAS_ASYNC */

};


struct sock_ip {

    lwip_sock_base_t base;

};


struct sock_tcp {

    lwip_sock_base_t base;

    struct sock_tcp_queue *queue;

    mutex_t mutex;

    struct pbuf *last_buf;

    ssize_t last_offset;

};


struct sock_tcp_queue {

    lwip_sock_base_t base;

    struct sock_tcp *array;

    mutex_t mutex;

    unsigned short len;

    unsigned short used;

};


struct sock_udp {

    lwip_sock_base_t base;

};


#ifdef __cplusplus

}

#endif


#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.