Versions Compared

Key

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

Configure socket's transmit IP IPv4 multicast Time to live (TTL).

Files

net_sock.h/net_sock.c

Prototype

Arguments

sock_id

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

...

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

Notes / Warnings

None.