Versions Compared

Key

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

...

NetSock_CfgTxIP_TTL_Multicast() (TCP/UDP)

...

Configure socket's transmit IP multicast TTL. Anchor13513631351363

Files

...

net_sock.h/net_sock.c Anchor13513721351372

Prototype

...

rowspan2

...

 

Arguments

sock_id Anchor13513751351375

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

...

1351376size Anchor13513771351377

Desired transmit IP multicast TTL:

...

classWebWorks_Indent_1

...

NET_IP_TTL_MIN

...

classWebWorks_Indent_2

...

Minimum TTL transmit value (1)

...

classWebWorks_Indent_1

...

NET_IP_TTL_MAX

...

...

Maximum TTL transmit value (255)

...

classWebWorks_Indent_1

...

NET_IP_TTL_DFLT

...

classWebWorks_Indent_2

...

Default TTL transmit value (1)

...

classWebWorks_Indent_1

...

NET_IP_TTL_NONE

...

...

Replace with default TTL

...

...

 

...

1351387perr Anchor13513881351388

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

...

1351400DEF_OK, Anchor13514011351401

Socket transmit IP multicast TTL successfully configured;

...

DEF_FAIL, Anchor13514031351403

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). Anchor13514061351406

Notes / Warnings

...

None.