Versions Compared

Key

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

...

Anchor13513611351361 NetSock_CfgTxIP_TTL_Multicast() (TCP/UDP) Anchor13513621351362Configure socket's transmit IP IPv4 multicast Time to live (TTL). Anchor13513631351363

Files

...

net_sock.h/net_sock.c Anchor13513721351372

Prototype


                                                    NET_IP_TTL
ip_ttl NET_ERR *perr);
HTML Table
summary
classCode_Listing
Table Row (tr)
Table Cell (td)
rowspan2
Anchor
13514821351482
Code Block
          CPU_BOOLEAN NetSock_CfgTxIP_TTL_Multicast(NET_SOCK_ID  sock_id,
Anchor
13514831351483
Anchor
13513691351369
Table Row (tr)

...

   ip_ttl
                                                    NET_ERR     *p_err);

Arguments

sock_id

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

...

classWebWorks_Indent_1

...

classWebWorks_Indent_2

...

ip_ttl

Desired transmit IPv4 multicast TTL:

NET_IPv4_TTL_MIN:  Minimum TTL transmit value (1)

...


...

NET_

...

IPv4_TTL_MAX

...

classWebWorks_Indent_2

...

:  Maximum TTL transmit value (255)

...

classWebWorks_Indent_1

...


NET_

...

IPv4_TTL_DFLT

...

classWebWorks_Indent_2

...

Default TTL transmit value (1)

...

classWebWorks_Indent_1

...


NET_

...

IPv4_TTL_NONE

...

classWebWorks_Indent_2

...

Replace with default TTL

...

classWebWorks_Indent_2

...

Anchor13513871351387 perr Anchor13513881351388p_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

Anchor13514001351400DEF_OK, Anchor13514011351401

Socket transmit

...

IPv4 multicast TTL successfully configured;

...

1351402DEF_FAIL, Anchor13514031351403

otherwise.

...

Required Configuration

...

Available only if if NET_SOCKIPv4_CFG_FAMILY is configured for IPv4 sockets (see section D-15-1 “NET_SOCK_CFG_FAMILY” on page 760). Anchor13514061351406 Notes / Warnings Anchor13514371351437EN is enabled (see section IPv4 Layer Configuration).

Notes / Warnings

None.