ON Semiconductor / mbed-os

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:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

Embed: (wiki syntax)

« Back to documentation index

TCP only
Functions

TCP only
[Netconn API]

TCP only functions. More...

Functions

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.
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_write_partly (struct netconn *conn, const void *dataptr, size_t size, u8_t apiflags, size_t *bytes_written)
 Send data over a TCP netconn.
static err_t netconn_close_shutdown (struct netconn *conn, u8_t how)
 Close or shutdown a TCP netconn (doesn't delete it).
err_t netconn_close (struct netconn *conn)
 Close a TCP netconn (doesn't delete it).
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).

Detailed Description

TCP only functions.

Function Documentation

err_t netconn_accept ( struct netconn *  conn,
struct netconn **  new_conn 
)

Accept a new connection on a TCP listening netconn.

Parameters:
connthe TCP listen netconn
new_connpointer where the new connection is stored
Returns:
ERR_OK if a new connection has been received or an error code otherwise

Definition at line 376 of file lwip_api_lib.c.

err_t netconn_close ( struct netconn *  conn )

Close a TCP netconn (doesn't delete it).

Parameters:
connthe TCP netconn to close
Returns:
ERR_OK if the netconn was closed, any other err_t on error

Definition at line 824 of file lwip_api_lib.c.

static err_t netconn_close_shutdown ( struct netconn *  conn,
u8_t  how 
) [static]

Close or shutdown a TCP netconn (doesn't delete it).

Parameters:
connthe TCP netconn to close or shutdown
howfully close or only shutdown one side?
Returns:
ERR_OK if the netconn was closed, any other err_t on error

Definition at line 788 of file lwip_api_lib.c.

err_t netconn_listen_with_backlog ( struct netconn *  conn,
u8_t  backlog 
)

Set a TCP netconn into listen mode.

Parameters:
connthe tcp netconn to set to listen mode
backlogthe listen backlog, only used if TCP_LISTEN_BACKLOG==1
Returns:
ERR_OK if the netconn was set to listen (UDP and RAW netconns don't return any error (yet?))

Definition at line 339 of file lwip_api_lib.c.

err_t netconn_recv_tcp_pbuf ( struct netconn *  conn,
struct pbuf **  new_buf 
)

Receive data (in form of a pbuf) from a TCP netconn.

Parameters:
connthe netconn from which to receive data
new_bufpointer where a new pbuf 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 TCP netconn

Definition at line 591 of file lwip_api_lib.c.

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

Parameters:
connthe TCP netconn to shut down
shut_rxshut down the RX side (no more read possible after this)
shut_txshut down the TX side (no more write possible after this)
Returns:
ERR_OK if the netconn was closed, any other err_t on error

Definition at line 840 of file lwip_api_lib.c.

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.

Parameters:
connthe TCP netconn over which to send data
dataptrpointer to the application buffer that contains the data to send
sizesize of the application data to send
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 722 of file lwip_api_lib.c.

Generated on Tue Jul 12 2022 11:03:07 by  doxygen 1.7.2