Skip to end of metadata
  • Created by Former user, last modified by Former user on May 23, 2014
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

Configure socket's transmit 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.

ip_ttl

Desired transmit IPv4 multicast TTL:

NET_IPv4_TTL_MIN:  Minimum TTL transmit value (1)
NET_IPv4_TTL_MAX:  Maximum TTL transmit value (255)
NET_IPv4_TTL_DFLT: Default TTL transmit value (1)
NET_IPv4_TTL_NONE: Replace with default TTL

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_STATE
NET_SOCK_ERR_INVALID_OP
NET_SOCK_ERR_API_DIS
NET_INIT_ERR_NOT_COMPLETED
NET_SOCK_ERR_INVALID_SOCK
NET_CONN_ERR_INVALID_ARG
NET_CONN_ERR_INVALID_CONN
NET_CONN_ERR_NOT_USED
NET_ERR_FAULT_LOCK_ACQUIRE

Returned Value

DEF_OK,

Socket transmit IPv4 multicast TTL successfully configured;

DEF_FAIL,

otherwise.

Required Configuration

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

Notes / Warnings

None.

  • No labels