NetSock_CfgTimeoutTxQ_Get_ms

Get socket’s transmit queue timeout value.

Files

net_sock.h/net_sock.c

Prototype

          CPU_INT32U NetSock_CfgTimeoutTxQ_Get_ms(NET_SOCK_ID  sock_id,
                                                  NET_ERR     *p_err);

Arguments

sock_id

This is the socket ID returned by NetSock_Open()/socket() when the socket was created or by NetSock_Accept()/accept() when a connection was accepted.

p_err

Pointer to variable that will receive the return error code from this function:

NET_SOCK_ERR_NONE
NET_SOCK_ERR_NOT_USED
NET_SOCK_ERR_INVALID_SOCK
NET_SOCK_ERR_INVALID_TYPE
NET_SOCK_ERR_INVALID_PROTOCOL
NET_TCP_ERR_CONN_NOT_USED
NET_TCP_ERR_INVALID_CONN
NET_CONN_ERR_NOT_USED
NET_CONN_ERR_INVALID_CONN
NET_INIT_ERR_NOT_COMPLETED
NET_ERR_FAULT_LOCK_ACQUIRE

Returned Value

0,

on any errors;

NET_TMR_TIME_INFINITE,

if infinite (i.e., no timeout) value configured;

Timeout in number of milliseconds, otherwise.

Required Configuration

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

Notes / Warnings

None.