Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

lwip_api_lib.c File Reference
Functions

lwip_api_lib.c File Reference

Sequential API External module. More...

Go to the source code of this file.

Functions

static err_t netconn_close_shutdown (struct netconn *conn, u8_t how)
 Close or shutdown a TCP netconn (doesn't delete it).
static err_t netconn_apimsg (tcpip_callback_fn fn, struct api_msg *apimsg)
 Call the lower part of a netconn_* function This function is then running in the thread context of tcpip_thread and has exclusive access to lwIP core code.
struct netconn * netconn_new_with_proto_and_callback (enum netconn_type t, u8_t proto, netconn_callback callback)
 Create a new netconn (of a specific type) that has a callback function.
err_t netconn_prepare_delete (struct netconn *conn)
 Close a netconn 'connection' and free all its resources but not the netconn itself.
err_t netconn_delete (struct netconn *conn)
 Close a netconn 'connection' and free its resources.
err_t netconn_getaddr (struct netconn *conn, ip_addr_t *addr, u16_t *port, u8_t local)
 Get the local or remote IP address and port of a netconn.
err_t netconn_bind (struct netconn *conn, const ip_addr_t *addr, u16_t port)
 Bind a netconn to a specific local IP address and port.
err_t netconn_bind_if (struct netconn *conn, u8_t if_idx)
 Bind a netconn to a specific interface and port.
err_t netconn_connect (struct netconn *conn, const ip_addr_t *addr, u16_t port)
 Connect a netconn to a specific remote IP address and port.
err_t netconn_disconnect (struct netconn *conn)
 Disconnect a netconn from its current peer (only valid for UDP netconns).
err_t netconn_listen_with_backlog (struct netconn *conn, u8_t backlog)
 Set a TCP netconn into listen mode.
err_t netconn_accept (struct netconn *conn, struct netconn **new_conn)
 Accept a new connection on a TCP listening netconn.
static err_t netconn_recv_data (struct netconn *conn, void **new_buf, u8_t apiflags)
 Receive data: actual implementation that doesn't care whether pbuf or netbuf is received (this is internal, it's just here for describing common errors)
err_t netconn_recv_tcp_pbuf (struct netconn *conn, struct pbuf **new_buf)
 Receive data (in form of a pbuf) from a TCP netconn.
err_t netconn_recv_tcp_pbuf_flags (struct netconn *conn, struct pbuf **new_buf, u8_t apiflags)
 Receive data (in form of a pbuf) from a TCP netconn.
err_t netconn_recv_udp_raw_netbuf (struct netconn *conn, struct netbuf **new_buf)
 Receive data (in form of a netbuf) from a UDP or RAW netconn.
err_t netconn_recv_udp_raw_netbuf_flags (struct netconn *conn, struct netbuf **new_buf, u8_t apiflags)
 Receive data (in form of a netbuf) from a UDP or RAW netconn.
err_t netconn_recv (struct netconn *conn, struct netbuf **new_buf)
 Receive data (in form of a netbuf containing a packet buffer) from a netconn.
err_t netconn_sendto (struct netconn *conn, struct netbuf *buf, const ip_addr_t *addr, u16_t port)
 Send data (in form of a netbuf) to a specific remote IP address and port.
err_t netconn_send (struct netconn *conn, struct netbuf *buf)
 Send data over a UDP or RAW netconn (that is already connected).
err_t netconn_write_partly (struct netconn *conn, const void *dataptr, size_t size, u8_t apiflags, size_t *bytes_written)
 Send data over a TCP netconn.
err_t netconn_write_vectors_partly (struct netconn *conn, struct netvector *vectors, u16_t vectorcnt, u8_t apiflags, size_t *bytes_written)
 Send vectorized data atomically over a TCP netconn.
err_t netconn_close (struct netconn *conn)
 Close a TCP netconn (doesn't delete it).
err_t netconn_err (struct netconn *conn)
 Get and reset pending error on a netconn.
err_t netconn_shutdown (struct netconn *conn, u8_t shut_rx, u8_t shut_tx)
 Shut down one or both sides of a TCP netconn (doesn't delete it).
err_t netconn_join_leave_group (struct netconn *conn, const ip_addr_t *multiaddr, const ip_addr_t *netif_addr, enum netconn_igmp join_or_leave)
 Join multicast groups for UDP netconns.
err_t netconn_join_leave_group_netif (struct netconn *conn, const ip_addr_t *multiaddr, u8_t if_idx, enum netconn_igmp join_or_leave)
 Join multicast groups for UDP netconns.
err_t netconn_gethostbyname_addrtype (const char *name, ip_addr_t *addr, u8_t dns_addrtype) err_t netconn_gethostbyname(const char *name
 Execute a DNS query, only one IP address is returned.

Detailed Description

Sequential API External module.

Definition in file lwip_api_lib.c.

Function Documentation

static err_t netconn_apimsg ( tcpip_callback_fn  fn,
struct api_msg *  apimsg 
) [static]

Call the lower part of a netconn_* function This function is then running in the thread context of tcpip_thread and has exclusive access to lwIP core code.

Parameters:
fnfunction to call
apimsga struct containing the function to call and its parameters
Returns:
ERR_OK if the function was called, another err_t if not

Definition at line 118 of file lwip_api_lib.c.

err_t netconn_getaddr ( struct netconn *  conn,
ip_addr_t *  addr,
u16_t *  port,
u8_t  local 
)

Get the local or remote IP address and port of a netconn.

For RAW netconns, this returns the protocol instead of a port!

Parameters:
connthe netconn to query
addra pointer to which to save the IP address
porta pointer to which to save the port (or protocol for RAW)
local1 to get the local IP address, 0 to get the remote one
Returns:
ERR_CONN for invalid connections ERR_OK if the information was retrieved

Definition at line 276 of file lwip_api_lib.c.

struct netconn* netconn_new_with_proto_and_callback ( enum netconn_type  t,
u8_t  proto,
netconn_callback  callback 
) [read]

Create a new netconn (of a specific type) that has a callback function.

The corresponding pcb is also created.

Parameters:
tthe type of 'connection' to create (
See also:
enum netconn_type)
Parameters:
protothe IP protocol for RAW IP pcbs
callbacka function to call on status changes (RX available, TX'ed)
Returns:
a newly allocated struct netconn or NULL on memory error

Definition at line 156 of file lwip_api_lib.c.

err_t netconn_recv_udp_raw_netbuf ( struct netconn *  conn,
struct netbuf **  new_buf 
)

Receive data (in form of a netbuf) from a UDP or RAW netconn.

Parameters:
connthe netconn from which to receive data
new_bufpointer where a new netbuf is stored when received data
Returns:
ERR_OK if data has been received, an error code otherwise (timeout, memory error or another error) ERR_ARG if conn is not a UDP/RAW netconn

Definition at line 829 of file lwip_api_lib.c.

err_t netconn_recv_udp_raw_netbuf_flags ( struct netconn *  conn,
struct netbuf **  new_buf,
u8_t  apiflags 
)

Receive data (in form of a netbuf) from a UDP or RAW netconn.

Parameters:
connthe netconn from which to receive data
new_bufpointer where a new netbuf is stored when received data
apiflagsflags that control function behaviour. For now only:

  • NETCONN_DONTBLOCK: only read data that is available now, don't wait for more data
Returns:
ERR_OK if data has been received, an error code otherwise (timeout, memory error or another error) ERR_ARG if conn is not a UDP/RAW netconn

Definition at line 849 of file lwip_api_lib.c.

err_t netconn_write_vectors_partly ( struct netconn *  conn,
struct netvector *  vectors,
u16_t  vectorcnt,
u8_t  apiflags,
size_t *  bytes_written 
)

Send vectorized data atomically over a TCP netconn.

Parameters:
connthe TCP netconn over which to send data
vectorsarray of vectors containing data to send
vectorcntnumber of vectors in the array
apiflagscombination of following flags :

  • NETCONN_COPY: data will be copied into memory belonging to the stack
  • NETCONN_MORE: for TCP connection, PSH flag will be set on last segment sent
  • NETCONN_DONTBLOCK: only write the data if all data can be written at once
bytes_writtenpointer to a location that receives the number of written bytes
Returns:
ERR_OK if data was sent, any other err_t on error

Definition at line 1004 of file lwip_api_lib.c.

Generated on Tue Jul 12 2022 13:55:13 by  doxygen 1.7.2