Versions Compared

Key

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

Configure TCP connection’s idle timeout.

Files

net_tcp.h/net_tcp.c

Prototype

Arguments

conn_id_tcp

TCP connection handle ID to configure connection handle 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 idle timeout successfully configured.

DEF_FAIL,

otherwise.

Required Configuration

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

Notes / Warnings

Configured timeout does not reschedule any current idle timeout in progress but becomes effective the next time a TCP connection sets its idle timeout.

...