Versions Compared

Key

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

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

Files

net_sock.h/net_sock.c

...

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

...

ip_ttl

Desired transmit IP IPv4 TTL:

NET_IPIPv4_TTL_MIN

Minimum TTL transmit value (1)

NET_IPIPv4_TTL_MAX

Maximum TTL transmit value (255)

NET_IPIPv4_TTL_DFLT

Default TTL transmit value (128)

NET_IPIPv4_TTL_NONE

Replace with default TTL

 

perrp_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_STATE
NET_SOCK_ERR_INVALID_OP
NET_INIT_ERR_INITNOT_INCOMPLETECOMPLETED
NET_SOCK_ERR_INVALID_SOCK
NET_CONN_ERR_INVALID_ARG
NET_CONN_ERR_INVALID_CONN
NET_CONN_ERR_NOT_USED
NET_OSERR_ERRFAULT_LOCK_ACQUIRE

Returned Value

DEF_OK,

Socket transmit IP IPv4 TTL successfully configured;

...

otherwise.

Required Configuration

NoneAvailable only if NET_IPv4_CFG_EN is enabled (see section IPv4 Layer Configuration).

Notes / Warnings

None.