Versions Compared

Key

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

...

NetTCP_ConnCfgReTxMaxTimeout()

Anchor10996811099681Configure TCP connection’s maximum retransmission timeout. Anchor10943591094359

Files

Anchor10943601094360net_tcp.h/net_tcp.c Anchor10943611094361

Prototype

...

rowspan2

...

 

Arguments

conn_id_tcp Anchor12601711260171

TCP connection handle ID to configure maximum retransmission timeout value.

Anchor10943671094367timeout_sec Anchor12601781260178

Desired value for TCP connection maximum retransmission timeout (in seconds).

...

perr Anchor12601851260185

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

Anchor10943701094370DEF_OK, Anchor12603251260325

TCP connection’s maximum retransmission timeout successfully configured, if no errors.

Anchor10943721094372DEF_FAIL,anchor12603321260332

otherwise.

...

Required Configuration

Anchor12796861279686Available only if NET_CFG_TRANSPORT_LAYER_SEL is configured for TCP (see section D-12-1 on page 755). Anchor12796881279688

Notes / Warnings

...

1201616The 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): Anchor14530201453020

 

...

rowspan10

...

...

 

...

...

NetTCP_ConnCfgReTxMaxTimeout(

...

)

...

Anchor13544881354488 NetTCP_ConnCfgReTxMaxTimeout() is called by application function(s) and must not be called with the global network lock already acquired. It must block all other network protocol tasks by pending on and acquiring the global network lock (see “netnet.h Note #3”). This is required since an application's network protocol suite API function access is asynchronous to other network protocol tasks.