Kenji Arai / mbed-os_TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

Application layered TCP Functions

Application layered TCP Functions
[Application layered TCP Introduction]

This file contains the common functions for altcp to work. More...

Modules

 TLS layer
 

This file contains function prototypes for a TLS layer.


Functions

struct altcp_pcb * altcp_new_ip6 (altcp_allocator_t *allocator)
 altcp_new_ip6: altcp_new for IPv6
struct altcp_pcb * altcp_new (altcp_allocator_t *allocator)
 altcp_new: altcp_new for IPv4
struct altcp_pcb * altcp_new_ip_type (altcp_allocator_t *allocator, u8_t ip_type)
 altcp_new_ip_type: called by applications to allocate a new pcb with the help of an allocator function.
void altcp_arg (struct altcp_pcb *conn, void *arg)
void altcp_accept (struct altcp_pcb *conn, altcp_accept_fn accept)
void altcp_recv (struct altcp_pcb *conn, altcp_recv_fn recv)
void altcp_sent (struct altcp_pcb *conn, altcp_sent_fn sent)
void altcp_poll (struct altcp_pcb *conn, altcp_poll_fn poll, u8_t interval)
void altcp_err (struct altcp_pcb *conn, altcp_err_fn err)
void altcp_recved (struct altcp_pcb *conn, u16_t len)
err_t altcp_bind (struct altcp_pcb *conn, const ip_addr_t *ipaddr, u16_t port)
err_t altcp_connect (struct altcp_pcb *conn, const ip_addr_t *ipaddr, u16_t port, altcp_connected_fn connected)
struct altcp_pcb * altcp_listen_with_backlog_and_err (struct altcp_pcb *conn, u8_t backlog, err_t *err)
void altcp_abort (struct altcp_pcb *conn)
err_t altcp_close (struct altcp_pcb *conn)
err_t altcp_shutdown (struct altcp_pcb *conn, int shut_rx, int shut_tx)
err_t altcp_write (struct altcp_pcb *conn, const void *dataptr, u16_t len, u8_t apiflags)
err_t altcp_output (struct altcp_pcb *conn)
u16_t altcp_mss (struct altcp_pcb *conn)
u16_t altcp_sndbuf (struct altcp_pcb *conn)
u16_t altcp_sndqueuelen (struct altcp_pcb *conn)
void altcp_setprio (struct altcp_pcb *conn, u8_t prio)

Detailed Description

This file contains the common functions for altcp to work.

For more details see Application layered TCP Introduction.


Function Documentation

void altcp_abort ( struct altcp_pcb *  conn )
See also:
tcp_abort()

Definition at line 342 of file lwip_altcp.c.

void altcp_accept ( struct altcp_pcb *  conn,
altcp_accept_fn  accept 
)
See also:
tcp_accept()

Definition at line 225 of file lwip_altcp.c.

void altcp_arg ( struct altcp_pcb *  conn,
void *  arg 
)
See also:
tcp_arg()

Definition at line 213 of file lwip_altcp.c.

err_t altcp_bind ( struct altcp_pcb *  conn,
const ip_addr_t ipaddr,
u16_t  port 
)
See also:
tcp_bind()

Definition at line 303 of file lwip_altcp.c.

err_t altcp_close ( struct altcp_pcb *  conn )
See also:
tcp_close()

Definition at line 354 of file lwip_altcp.c.

err_t altcp_connect ( struct altcp_pcb *  conn,
const ip_addr_t ipaddr,
u16_t  port,
altcp_connected_fn  connected 
)
See also:
tcp_connect()

Definition at line 316 of file lwip_altcp.c.

void altcp_err ( struct altcp_pcb *  conn,
altcp_err_fn  err 
)
See also:
tcp_err()

Definition at line 277 of file lwip_altcp.c.

struct altcp_pcb* altcp_listen_with_backlog_and_err ( struct altcp_pcb *  conn,
u8_t  backlog,
err_t err 
) [read]
See also:
tcp_listen_with_backlog_and_err()

Definition at line 329 of file lwip_altcp.c.

u16_t altcp_mss ( struct altcp_pcb *  conn )
See also:
tcp_mss()

Definition at line 406 of file lwip_altcp.c.

struct altcp_pcb* altcp_new ( altcp_allocator_t *  allocator ) [read]

altcp_new: altcp_new for IPv4

Definition at line 174 of file lwip_altcp.c.

struct altcp_pcb* altcp_new_ip6 ( altcp_allocator_t *  allocator ) [read]

altcp_new_ip6: altcp_new for IPv6

Definition at line 164 of file lwip_altcp.c.

struct altcp_pcb* altcp_new_ip_type ( altcp_allocator_t *  allocator,
u8_t  ip_type 
) [read]

altcp_new_ip_type: called by applications to allocate a new pcb with the help of an allocator function.

Parameters:
allocatorallocator function and argument
ip_typeIP version of the pcb (lwip_ip_addr_type)
Returns:
a new altcp_pcb or NULL on error

Definition at line 189 of file lwip_altcp.c.

err_t altcp_output ( struct altcp_pcb *  conn )
See also:
tcp_output()

Definition at line 393 of file lwip_altcp.c.

void altcp_poll ( struct altcp_pcb *  conn,
altcp_poll_fn  poll,
u8_t  interval 
)
See also:
tcp_poll()

Definition at line 261 of file lwip_altcp.c.

void altcp_recv ( struct altcp_pcb *  conn,
altcp_recv_fn  recv 
)
See also:
tcp_recv()

Definition at line 237 of file lwip_altcp.c.

void altcp_recved ( struct altcp_pcb *  conn,
u16_t  len 
)
See also:
tcp_recved()

Definition at line 291 of file lwip_altcp.c.

void altcp_sent ( struct altcp_pcb *  conn,
altcp_sent_fn  sent 
)
See also:
tcp_sent()

Definition at line 249 of file lwip_altcp.c.

void altcp_setprio ( struct altcp_pcb *  conn,
u8_t  prio 
)
See also:
tcp_setprio()

Definition at line 470 of file lwip_altcp.c.

err_t altcp_shutdown ( struct altcp_pcb *  conn,
int  shut_rx,
int  shut_tx 
)
See also:
tcp_shutdown()

Definition at line 367 of file lwip_altcp.c.

u16_t altcp_sndbuf ( struct altcp_pcb *  conn )
See also:
tcp_sndbuf()

Definition at line 419 of file lwip_altcp.c.

u16_t altcp_sndqueuelen ( struct altcp_pcb *  conn )
See also:
tcp_sndqueuelen()

Definition at line 432 of file lwip_altcp.c.

err_t altcp_write ( struct altcp_pcb *  conn,
const void *  dataptr,
u16_t  len,
u8_t  apiflags 
)
See also:
tcp_write()

Definition at line 380 of file lwip_altcp.c.