...
TCP Functions
...
NetTCP_ConnCfgIdleTimeout()
...
Files
Anchor
net_tcp.h/net_tcp.c...
| rowspan | 2 |
|---|
...
Prototype
Arguments
conn_id_tcpAnchor
TCP connection handle ID to configure connection handle timeout.
Anchor
timeout_secanchorDesired value for TCP connection idle timeout (in seconds).
...
perrAnchor
Pointer to variable that will receive the return error code from this function:
...
...
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,Anchor
TCP connection’s idle timeout successfully configured.
Anchor
DEF_FAIL,otherwise.
...
Required Configuration
Anchor
NET_CFG_TRANSPORT_LAYER_SEL is configured for TCP (see section D-12-1 on page 755).anchorNotes / Warnings
...
Anchor
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 section C-13-38 “NetSock_GetConnTransportID()” on page 644):Anchor
...
| rowspan | 10 |
|---|
...
...
...
...
NetTCP_ConnCfgIdleTimeout(
...
)
...
Anchor
net.h Note #3”). This is required since an application's network protocol suite API function access is asynchronous to other network protocol tasks.