Documentation

Documentation

Includes

lwip/opt.h

#include "lwip/opt.h"
#include "lwip/opt.h"

lwip/tcpbase.h

#include "lwip/tcpbase.h"
#include "lwip/tcpbase.h"

lwip/err.h

#include "lwip/err.h"
#include "lwip/err.h"

lwip/pbuf.h

#include "lwip/pbuf.h"
#include "lwip/pbuf.h"

lwip/ip_addr.h

#include "lwip/ip_addr.h"
#include "lwip/ip_addr.h"

lwip/tcp.h

#include "lwip/tcp.h"
#include "lwip/tcp.h"

Macros

Marco LWIP_HDR_ALTCP_H

#define LWIP_HDR_ALTCP_H


      

Marco altcp_listen_with_backlog(conn, backlog)

#define altcp_listen_with_backlog(conn, backlog) altcp_listen_with_backlog_and_err(conn, backlog, NULL)


      

Marco altcp_listen(conn)

#define altcp_listen(conn) altcp_listen_with_backlog_and_err(conn, TCP_DEFAULT_LISTEN_BACKLOG, NULL)
/** @ingroup altcp */

Marco altcp_accept_fn

#define altcp_accept_fn tcp_accept_fn


      

Marco altcp_connected_fn

#define altcp_connected_fn tcp_connected_fn


      

Marco altcp_recv_fn

#define altcp_recv_fn tcp_recv_fn


      

Marco altcp_sent_fn

#define altcp_sent_fn tcp_sent_fn


      

Marco altcp_poll_fn

#define altcp_poll_fn tcp_poll_fn


      

Marco altcp_err_fn

#define altcp_err_fn tcp_err_fn


      

Marco altcp_pcb

#define altcp_pcb tcp_pcb


      

Marco altcp_tcp_new_ip_type

#define altcp_tcp_new_ip_type tcp_new_ip_type


      

Marco altcp_tcp_new

#define altcp_tcp_new tcp_new


      

Marco altcp_tcp_new_ip6

#define altcp_tcp_new_ip6 tcp_new_ip6


      

Marco altcp_new(allocator)

#define altcp_new(allocator) tcp_new()


      

Marco altcp_new_ip6(allocator)

#define altcp_new_ip6(allocator) tcp_new_ip6()


      

Marco altcp_new_ip_type(allocator, ip_type)

#define altcp_new_ip_type(allocator, ip_type) tcp_new_ip_type(ip_type)


      

Marco altcp_arg

#define altcp_arg tcp_arg


      

Marco altcp_accept

#define altcp_accept tcp_accept


      

Marco altcp_recv

#define altcp_recv tcp_recv


      

Marco altcp_sent

#define altcp_sent tcp_sent


      

Marco altcp_poll

#define altcp_poll tcp_poll


      

Marco altcp_err

#define altcp_err tcp_err


      

Marco altcp_recved

#define altcp_recved tcp_recved


      

Marco altcp_bind

#define altcp_bind tcp_bind


      

Marco altcp_connect

#define altcp_connect tcp_connect


      

Marco altcp_listen_with_backlog_and_err

#define altcp_listen_with_backlog_and_err tcp_listen_with_backlog_and_err


      

Marco altcp_listen_with_backlog

#define altcp_listen_with_backlog tcp_listen_with_backlog


      

Marco altcp_listen

#define altcp_listen tcp_listen


      

Marco altcp_abort

#define altcp_abort tcp_abort


      

Marco altcp_close

#define altcp_close tcp_close


      

Marco altcp_shutdown

#define altcp_shutdown tcp_shutdown


      

Marco altcp_write

#define altcp_write tcp_write


      

Marco altcp_output

#define altcp_output tcp_output


      

Marco altcp_mss

#define altcp_mss tcp_mss


      

Marco altcp_sndbuf

#define altcp_sndbuf tcp_sndbuf


      

Marco altcp_sndqueuelen

#define altcp_sndqueuelen tcp_sndqueuelen


      

Marco altcp_nagle_disable

#define altcp_nagle_disable tcp_nagle_disable


      

Marco altcp_nagle_enable

#define altcp_nagle_enable tcp_nagle_enable


      

Marco altcp_nagle_disabled

#define altcp_nagle_disabled tcp_nagle_disabled


      

Marco altcp_setprio

#define altcp_setprio tcp_setprio


      

Marco altcp_get_tcp_addrinfo

#define altcp_get_tcp_addrinfo tcp_get_tcp_addrinfo


      

Marco altcp_get_ip(pcb, local)

#define altcp_get_ip(pcb, local) ((local) ? (&(pcb)->local_ip) : (&(pcb)->remote_ip))


      

Marco altcp_dbg_get_tcp_state

#define altcp_dbg_get_tcp_state tcp_dbg_get_tcp_state

      

Functions

Func altcp_new

struct altcp_pcb *altcp_new(altcp_allocator_t *allocator);


      

Func altcp_new_ip6

struct altcp_pcb *altcp_new_ip6(altcp_allocator_t *allocator);


      

Func altcp_new_ip_type

struct altcp_pcb *altcp_new_ip_type(altcp_allocator_t *allocator, u8_t ip_type);


      

Func altcp_arg

void altcp_arg(struct altcp_pcb *conn, void *arg);


      

Func altcp_accept

void altcp_accept(struct altcp_pcb *conn, altcp_accept_fn accept);


      

Func altcp_recv

void altcp_recv(struct altcp_pcb *conn, altcp_recv_fn recv);


      

Func altcp_sent

void altcp_sent(struct altcp_pcb *conn, altcp_sent_fn sent);


      

Func altcp_poll

void altcp_poll(struct altcp_pcb *conn, altcp_poll_fn poll, u8_t interval);


      

Func altcp_err

void altcp_err(struct altcp_pcb *conn, altcp_err_fn err);


      

Func altcp_recved

void altcp_recved(struct altcp_pcb *conn, u16_t len);


      

Func altcp_bind

err_t altcp_bind(struct altcp_pcb *conn, const ip_addr_t *ipaddr, u16_t port);


      

Func altcp_connect

err_t altcp_connect(struct altcp_pcb *conn, const ip_addr_t *ipaddr, u16_t port, altcp_connected_fn connected);


      

Func altcp_listen_with_backlog_and_err

struct altcp_pcb *altcp_listen_with_backlog_and_err(struct altcp_pcb *conn, u8_t backlog, err_t *err);
/* return conn for source code compatibility to tcp callback API only */

Func altcp_abort

void altcp_abort(struct altcp_pcb *conn);


      

Func altcp_close

err_t altcp_close(struct altcp_pcb *conn);


      

Func altcp_shutdown

err_t altcp_shutdown(struct altcp_pcb *conn, int shut_rx, int shut_tx);


      

Func altcp_write

err_t altcp_write(struct altcp_pcb *conn, const void *dataptr, u16_t len, u8_t apiflags);


      

Func altcp_output

err_t altcp_output(struct altcp_pcb *conn);


      

Func altcp_mss

u16_t altcp_mss(struct altcp_pcb *conn);


      

Func altcp_sndbuf

u16_t altcp_sndbuf(struct altcp_pcb *conn);


      

Func altcp_sndqueuelen

u16_t altcp_sndqueuelen(struct altcp_pcb *conn);


      

Func altcp_nagle_disable

void altcp_nagle_disable(struct altcp_pcb *conn);


      

Func altcp_nagle_enable

void altcp_nagle_enable(struct altcp_pcb *conn);


      

Func altcp_nagle_disabled

int  altcp_nagle_disabled(struct altcp_pcb *conn);


      

Func altcp_setprio

void altcp_setprio(struct altcp_pcb *conn, u8_t prio);


      

Func altcp_get_tcp_addrinfo

err_t altcp_get_tcp_addrinfo(struct altcp_pcb *conn, int local, ip_addr_t *addr, u16_t *port);


      

Func altcp_get_ip

ip_addr_t *altcp_get_ip(struct altcp_pcb *conn, int local);


      

Func altcp_get_port

u16_t altcp_get_port(struct altcp_pcb *conn, int local);

      

Vars

Variable

struct altcp_pcb;


      

Variable altcp_functions

struct altcp_functions;

      

Consts

Types

Type

enum tcp_state altcp_dbg_get_tcp_state(struct altcp_pcb *conn);

      

Typedefs

Typedef err_t

typedef err_t (*altcp_accept_fn)(void *arg, struct altcp_pcb *new_conn, err_t err);


      

Typedef altcp_connected_fn

typedef err_t (*altcp_connected_fn)(void *arg, struct altcp_pcb *conn, err_t err);


      

Typedef altcp_recv_fn

typedef err_t (*altcp_recv_fn)(void *arg, struct altcp_pcb *conn, struct pbuf *p, err_t err);


      

Typedef altcp_sent_fn

typedef err_t (*altcp_sent_fn)(void *arg, struct altcp_pcb *conn, u16_t len);


      

Typedef altcp_poll_fn

typedef err_t (*altcp_poll_fn)(void *arg, struct altcp_pcb *conn);


      

Typedef altcp_err_fn

typedef void (*altcp_err_fn)(void *arg, err_t err);


      

Typedef altcp_pcb

typedef struct altcp_pcb* (*altcp_new_fn)(void *arg, u8_t ip_type);


      

Typedef altcp_allocator_t;

typedef struct altcp_allocator_s {
 /** Allocator function */
 altcp_new_fn alloc;
 /** Argument to allocator function */
 void        *arg;
} altcp_allocator_t;
/** @ingroup altcp */