NetSock_CfgTxIP_TTL_Multicast() (TCP_2fUDP)

Unable to render {include} The included page could not be found.

NetSock_CfgTxIP_TTL_Multicast() (TCP/UDP)

Configure socket's transmit IP multicast TTL.

Files

net_sock.h/net_sock.c

Prototype

CPU_BOOLEAN NetSock_CfgTxIP_TTL_Multicast(NET_SOCK_ID sock_id,

NET_IP_TTL ip_ttl

NET_ERR *perr);

Arguments

sock_id

This is the socket ID of socket to configure transmit IP TTL.

size

Desired transmit IP multicast TTL:

NET_IP_TTL_MIN

Minimum TTL transmit value (1)

NET_IP_TTL_MAX

Maximum TTL transmit value (255)

NET_IP_TTL_DFLT

Default TTL transmit value (1)

NET_IP_TTL_NONE

Replace with default TTL

perr

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_STATE

NET_SOCK_ERR_INVALID_OP

NET_SOCK_ERR_API_DIS

NET_ERR_INIT_INCOMPLETE

NET_SOCK_ERR_INVALID_SOCK

NET_CONN_ERR_INVALID_ARG

NET_CONN_ERR_INVALID_CONN

NET_CONN_ERR_NOT_USED

NET_OS_ERR_LOCK

Returned Value

DEF_OK,

Socket transmit IP multicast TTL successfully configured;

DEF_FAIL,

otherwise.

Required Configuration

Available only if NET_SOCK_CFG_FAMILY is configured for IPv4 sockets (see section D-15-1 “NET_SOCK_CFG_FAMILY” on page 760).

Notes / Warnings

None.