Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Configure TCP connection's transmit keep-alive retry timeout.

Files

net_tcp.h/net_tcp.c

Prototype

Arguments

conn_id_tcp

Handle identifier of TCP connection to configure transmit keep-alive retry timeout.

...

NET_TCP_ERR_NONE
NET_TCP_ERR_INVALID_ARG
NET_TCP_ERR_INVALID_CONN
NET_TCP_ERR_CONN_NOT_USED
NET_ERR_INIT_INCOMPLETE
NET_OS_ERR_LOCK

Returned Value

DEF_OK,

TCP connection’s transmit keep-alive retry timeout successfully configured;

DEF_FAIL,

otherwise.

Required Configuration

Available only if TCP is enabled (see TCP Layer Configuration).

Notes / Warnings

The conn_id_tcp argument represents the TCP connection handle – not the socket handle. The following code may be used to get the TCP connection handle and configure TCP connection parameters (see also NetSock_GetConnTransportID):

...