Events generated by the Network - UDP Socket functions. More...

Functions
__STATIC_INLINE void	EvrNetUDP_InitSockets (uint32_t num_sockets)
	Event on UDP socket initialize (Op)

__STATIC_INLINE void	EvrNetUDP_GetSocket (int32_t socket, uint32_t num_socks)
	Event on UDP allocate a free socket (Op)

__STATIC_INLINE void	EvrNetUDP_GetSocketInvalidParameter (void)
	Event on UDP get socket failed, invalid parameter (Error)

__STATIC_INLINE void	EvrNetUDP_NoSocketAvailable (uint32_t num_socks)
	Event on UDP get socket failed, no free socket available (Error)

__STATIC_INLINE void	EvrNetUDP_ReleaseSocket (int32_t socket)
	Event on UDP release socket (Op)

__STATIC_INLINE void	EvrNetUDP_ReleaseSocketNotValid (int32_t socket)
	Event on UDP release failed, not valid socket (Error)

__STATIC_INLINE void	EvrNetUDP_ReleaseSocketWrongState (int32_t socket, uint8_t state)
	Event on UDP release failed, wrong socket state (Error)

__STATIC_INLINE void	EvrNetUDP_OpenSocket (int32_t socket, uint16_t port)
	Event on UDP open socket for communication (Op)

__STATIC_INLINE void	EvrNetUDP_OpenSocketNotValid (int32_t socket)
	Event on UDP open failed, not valid socket (Error)

__STATIC_INLINE void	EvrNetUDP_OpenSocketWrongState (int32_t socket, uint8_t state)
	Event on UDP open socket failed, wrong socket state (Error)

__STATIC_INLINE void	EvrNetUDP_AssignLocalPort (int32_t socket, uint16_t local_port)
	Event on UDP local port assigned in open socket request (Op)

__STATIC_INLINE void	EvrNetUDP_OpenLocalPortInUse (int32_t socket, uint16_t port)
	Event on UDP open socket failed, requested port already used (Error)

__STATIC_INLINE void	EvrNetUDP_CloseSocket (int32_t socket)
	Event on UDP close socket (Op)

__STATIC_INLINE void	EvrNetUDP_CloseSocketNotValid (int32_t socket)
	Event on UDP close socket failed, not valid socket (Error)

__STATIC_INLINE void	EvrNetUDP_SetOptionSocket (int32_t socket, int32_t option, uint32_t val)
	Event on UDP set socket option (Op)

__STATIC_INLINE void	EvrNetUDP_SetOptionSocketNotValid (int32_t socket)
	Event on UDP set socket option failed, not valid socket (Error)

__STATIC_INLINE void	EvrNetUDP_SetOptionSocketWrongState (int32_t socket, uint8_t state)
	Event on UDP set socket option failed, wrong socket state (Error)

__STATIC_INLINE void	EvrNetUDP_SetOptionTos (int32_t socket, uint8_t ip4_tos)
	Event on UDP set socket option Type Of Service for IPv4 (Detail)

__STATIC_INLINE void	EvrNetUDP_SetOptionTtl (int32_t socket, uint8_t ip4_ttl)
	Event on UDP set socket option Time To Live for IPv4 (Detail)

__STATIC_INLINE void	EvrNetUDP_SetOptionTclass (int32_t socket, uint8_t ip6_tclass)
	Event on UDP set socket option Traffic Class for IPv6 (Detail)

__STATIC_INLINE void	EvrNetUDP_SetOptionHopLimit (int32_t socket, uint8_t ip6_hoplimit)
	Event on UDP set socket option Hop Limit for IPv6 (Detail)

__STATIC_INLINE void	EvrNetUDP_SetOptionChecksum (int32_t socket, uint32_t checksum)
	Event on UDP set socket option checksum calculation options (Detail)

__STATIC_INLINE void	EvrNetUDP_SetOptionInterface (int32_t socket, uint16_t if_id)
	Event on UDP set socket option broadcast interface (Detail)

__STATIC_INLINE void	EvrNetUDP_SetOptionWrongOption (int32_t socket, int32_t udp_option)
	Event on UDP wrong set socket option (Error)

__STATIC_INLINE void	EvrNetUDP_SetOptionWrongValue (int32_t socket, uint32_t opt_value)
	Event on UDP wrong value for set socket option (Error)

__STATIC_INLINE void	EvrNetUDP_GetBufferFailed (uint16_t mem_size)
	Event on UDP get buffer failed, out of memory (Error)

__STATIC_INLINE void	EvrNetUDP_SendFrame (int32_t socket, uint32_t length)
	Event on UDP send frame (Op)

__STATIC_INLINE void	EvrNetUDP_SendBufferInvalid (int32_t socket)
	Event on UDP send buffer is invalid (Error)

__STATIC_INLINE void	EvrNetUDP_SendSocketNotValid (int32_t socket)
	Event on UDP send socket handle is not valid (Error)

__STATIC_INLINE void	EvrNetUDP_SendAddressUnspecified (int32_t socket)
	Event on UDP send destination address not specified (Error)

__STATIC_INLINE void	EvrNetUDP_SendPortUndefined (int32_t socket)
	Event on UDP send port undefined (Error)

__STATIC_INLINE void	EvrNetUDP_SendSocketNotOpen (int32_t socket)
	Event on UDP send socket not open, invalid socket state (Error)

__STATIC_INLINE void	EvrNetUDP_SendZeroLengthFrame (int32_t socket)
	Event on UDP send 0-length frame, frame is dumped (Op)

__STATIC_INLINE void	EvrNetUDP_SendSizeTruncated (int32_t socket, uint32_t new_length)
	Event on UDP send truncated over-size packet (Op)

__STATIC_INLINE void	EvrNetUDP_ShowFrameHeader (const void *udp_header)
	Event on UDP display send/receive frame header (Detail)

__STATIC_INLINE void	EvrNetUDP_ReceiveFrame (uint32_t length, uint8_t ip_version)
	Event on UDP receive frame (Op)

__STATIC_INLINE void	EvrNetUDP_FrameTooShort (uint32_t length, uint32_t min_length)
	Event on UDP receive frame too short (Error)

__STATIC_INLINE void	EvrNetUDP_MapFrameToSocket (int32_t socket)
	Event on UDP received frame mapped to a socket (Op)

__STATIC_INLINE void	EvrNetUDP_FrameNotMapped (uint32_t length)
	Event on UDP received frame not mapped, no open sockets found (Op)

__STATIC_INLINE void	EvrNetUDP_LinkLayerAddressed (int32_t socket)
	Event on UDP received frame link-layer addressed (Error)

__STATIC_INLINE void	EvrNetUDP_ChecksumFailed (int32_t socket)
	Event on UDP frame checksum check failed (Error)

__STATIC_INLINE void	EvrNetUDP_UninitSockets (void)
	Event on UDP de-initialize available sockets (Op)

Description

Events generated by the Network - UDP Socket functions.

The UDP socket functions generate events that make it easier to troubleshoot errors, and allow the user to understand the way UDP sockets work.

Function Documentation

◆ EvrNetUDP_AssignLocalPort()

__STATIC_INLINE void EvrNetUDP_AssignLocalPort	(	int32_t	socket,
		uint16_t	local_port
	)

Event on UDP local port assigned in open socket request (Op)

Parameters

socket	socket handle
local_port	assigned local port number

The event AssignLocalPort is created, when the internal function udp_open attempts to open the UDP socket, but the local port is undefined, which means that it has a value of 0. The system then assigns a free local port and opens it for communication. This usually happens when the netUDP_Open function is executed.

Value in the Event Recorder shows:

socket: UDP socket handle for opening.
port: auto-assigned local UDP port.

◆ EvrNetUDP_ChecksumFailed()

__STATIC_INLINE void EvrNetUDP_ChecksumFailed ( int32_t socket )

Event on UDP frame checksum check failed (Error)

Parameters

socket socket handle

The event ChecksumFailed is created when the network library has checked the checksum on the received UDP frame and the verification failed. The UDP frame is therefore discarded.

Value in the Event Recorder shows:

socket: UDP socket handle.

◆ EvrNetUDP_CloseSocket()

__STATIC_INLINE void EvrNetUDP_CloseSocket ( int32_t socket )

Event on UDP close socket (Op)

Parameters

socket socket handle

The event CloseSocket is created when the UDP socket is closed for communication, that is, when the function netUDP_Close is executed.

Value in the Event Recorder shows:

socket: UDP socket handle for closing.

◆ EvrNetUDP_CloseSocketNotValid()

__STATIC_INLINE void EvrNetUDP_CloseSocketNotValid ( int32_t socket )

Event on UDP close socket failed, not valid socket (Error)

Parameters

socket socket handle

The event CloseSocketNotValid is created, when the internal function udp_close can not close the UDP socket because the provided socket handle is invalid. This usually happens when the netUDP_Close function is executed.

Value in the Event Recorder shows:

socket: UDP socket handle for closing.

◆ EvrNetUDP_FrameNotMapped()

__STATIC_INLINE void EvrNetUDP_FrameNotMapped ( uint32_t length )

Event on UDP received frame not mapped, no open sockets found (Op)

Parameters

length frame length in bytes

The event FrameNotMapped is created when the network library receives the UDP frame and can not map the frame to any open UDP socket. The frame is therefore discarded.

Value in the Event Recorder shows:

len: length of the received frame in bytes.

◆ EvrNetUDP_FrameTooShort()

__STATIC_INLINE void EvrNetUDP_FrameTooShort	(	uint32_t	length,
		uint32_t	min_length
	)

Event on UDP receive frame too short (Error)

Parameters

length	frame length in bytes
min_length	minimum length of the frame

The event FrameTooShort is created when the network library receives the UDP frame that is too short. The UDP frame is therefore discarded.

Value in the Event Recorder shows:

len: length of the received frame in bytes.
min: minimum valid frame length in bytes.

◆ EvrNetUDP_GetBufferFailed()

__STATIC_INLINE void EvrNetUDP_GetBufferFailed ( uint16_t mem_size )

Event on UDP get buffer failed, out of memory (Error)

Parameters

mem_size requested memory size

The event GetBufferFailed is created, when the network library can not allocate the memory for the UDP socket send buffer. This happens when there is no free memory in the memory pool.

Value in the Event Recorder shows:

size: requested memory size.

◆ EvrNetUDP_GetSocket()

__STATIC_INLINE void EvrNetUDP_GetSocket	(	int32_t	socket,
		uint32_t	num_socks
	)

Event on UDP allocate a free socket (Op)

Parameters

socket	allocated socket handle
num_socks	number of available UDP sockets

The event GetSocket is created when the UDP socket is assigned, that is, when the function netUDP_GetSocket is executed.

Value in the Event Recorder shows:

socket: allocated UDP socket handle.
max: the highest possible value of the socket handle.

◆ EvrNetUDP_GetSocketInvalidParameter()

__STATIC_INLINE void EvrNetUDP_GetSocketInvalidParameter ( void )

Event on UDP get socket failed, invalid parameter (Error)

The event GetSocketInvalidParameter is created, when an invalid input parameter is provided for the udp_get_socket internal function. This usually happens when the netUDP_GetSocket function is executed.

Value in the Event Recorder shows:

error

◆ EvrNetUDP_InitSockets()

__STATIC_INLINE void EvrNetUDP_InitSockets ( uint32_t num_sockets )

Event on UDP socket initialize (Op)

Parameters

num_sockets number of available UDP sockets

The event InitSockets is created when the UDP sockets are initialized, that is, when the function netInitialize is executed.

Value in the Event Recorder shows:

sockets: number of UDP sockets available.

◆ EvrNetUDP_LinkLayerAddressed()

__STATIC_INLINE void EvrNetUDP_LinkLayerAddressed ( int32_t socket )

Event on UDP received frame link-layer addressed (Error)

Parameters

socket socket handle

The event LinkLayerAddressed is created when the network library receives the UDP frame that is link-layer addressed (by MAC address), but the socket is not set to receive the link-layer addressed frames. The UDP frame is therefore discarded.

Usually, the Link-layer addressed UDP frames are used in the DHCP protocol.

Value in the Event Recorder shows:

socket: UDP socket handle.

◆ EvrNetUDP_MapFrameToSocket()

__STATIC_INLINE void EvrNetUDP_MapFrameToSocket ( int32_t socket )

Event on UDP received frame mapped to a socket (Op)

Parameters

socket mapped socket handle

The event MapFrameToSocket is created when the network library receives the UDP frame and maps the frame to an open UDP socket.

Value in the Event Recorder shows:

socket: mapped UDP socket handle.

◆ EvrNetUDP_NoSocketAvailable()

__STATIC_INLINE void EvrNetUDP_NoSocketAvailable ( uint32_t num_socks )

Event on UDP get socket failed, no free socket available (Error)

Parameters

num_socks number of available UDP sockets

The event NoSocketAvailable is created, when the internal function udp_get_socket can not assign a free UDP socket. This usually happens when the netUDP_GetSocket function is executed.

Value in the Event Recorder shows:

used: number of already used sockets.

◆ EvrNetUDP_OpenLocalPortInUse()

__STATIC_INLINE void EvrNetUDP_OpenLocalPortInUse	(	int32_t	socket,
		uint16_t	port
	)

Event on UDP open socket failed, requested port already used (Error)

Parameters

socket	socket handle
port	local port number

The event OpenLocalPortInUse is created, when the internal function udp_open can not open the UDP socket because the local port is already used in another UDP socket. This usually happens when the netUDP_Open function is executed.

Value in the Event Recorder shows:

socket: UDP socket handle for opening.
loc_port: local UDP port that is already used.

◆ EvrNetUDP_OpenSocket()

__STATIC_INLINE void EvrNetUDP_OpenSocket	(	int32_t	socket,
		uint16_t	port
	)

Event on UDP open socket for communication (Op)

Parameters

socket	socket handle
port	local port number

The event OpenSocket is created when the UDP socket is opened for communication, that is, when the function netUDP_Open is executed.

Value in the Event Recorder shows:

socket: UDP socket handle for opening.
port: local UDP port number.

◆ EvrNetUDP_OpenSocketNotValid()

__STATIC_INLINE void EvrNetUDP_OpenSocketNotValid ( int32_t socket )

Event on UDP open failed, not valid socket (Error)

Parameters

socket socket handle

The event OpenSocketNotValid is created, when the internal function udp_open can not open the UDP socket because the provided socket handle is invalid. This usually happens when the netUDP_Open function is executed.

Value in the Event Recorder shows:

socket: UDP socket handle for opening.

◆ EvrNetUDP_OpenSocketWrongState()

__STATIC_INLINE void EvrNetUDP_OpenSocketWrongState	(	int32_t	socket,
		uint8_t	state
	)

Event on UDP open socket failed, wrong socket state (Error)

Parameters

socket	socket handle
state	socket state

The event OpenSocketWrongState is created, when the internal function udp_open can not open the UDP socket because the socket is not closed. This usually happens when the netUDP_Open function is executed. Before you open it, you must first allocate the socket. It is also not possible to open an already open socket.

Value in the Event Recorder shows:

socket: UDP socket handle for opening.
state: state of the UDP socket.

◆ EvrNetUDP_ReceiveFrame()

__STATIC_INLINE void EvrNetUDP_ReceiveFrame	(	uint32_t	length,
		uint8_t	ip_version
	)

Event on UDP receive frame (Op)

Parameters

length	frame length in bytes
ip_version	internet protocol version 0: IPv4 1: IPv6

The event ReceiveFrame is created when the network library receives the UDP frame. The frame can come from any interface.

Value in the Event Recorder shows:

len: length of the received UDP frame in bytes.
ver: IP protocol version of the received frame (IPv4, IPv6).

◆ EvrNetUDP_ReleaseSocket()

__STATIC_INLINE void EvrNetUDP_ReleaseSocket ( int32_t socket )

Event on UDP release socket (Op)

Parameters

socket socket handle

The event ReleaseSocket is created when the UDP socket is released, that is, when the function netUDP_ReleaseSocket is executed.

Value in the Event Recorder shows:

socket: UDP socket handle for release.

◆ EvrNetUDP_ReleaseSocketNotValid()

__STATIC_INLINE void EvrNetUDP_ReleaseSocketNotValid ( int32_t socket )

Event on UDP release failed, not valid socket (Error)

Parameters

socket socket handle

The event ReleaseSocketNotValid is created, when the internal function udp_release_socket can not release the UDP socket because the provided socket handle is not valid. This usually happens when the netUDP_ReleaseSocket function is executed.

Value in the Event Recorder shows:

socket: UDP socket handle for release.

◆ EvrNetUDP_ReleaseSocketWrongState()

__STATIC_INLINE void EvrNetUDP_ReleaseSocketWrongState	(	int32_t	socket,
		uint8_t	state
	)

Event on UDP release failed, wrong socket state (Error)

Parameters

socket	socket handle
state	socket state

The event ReleaseSocketWrongState is created, when the internal function udp_release_socket can not release the UDP socket because the socket is still open. This usually happens when the netUDP_ReleaseSocket function is executed. You must first close the socket before releasing it.

Value in the Event Recorder shows:

socket: UDP socket handle for release.
state: state of the UDP socket.

◆ EvrNetUDP_SendAddressUnspecified()

__STATIC_INLINE void EvrNetUDP_SendAddressUnspecified ( int32_t socket )

Event on UDP send destination address not specified (Error)

Parameters

socket socket handle

The event SendAddressUnspecified is created, when the internal function udp_send can not send the UDP frame because the provided destination IP address is unspecified. This usually happens when the netUDP_Send function is executed and the sending frame is discarded.

Value in the Event Recorder shows:

socket: UDP socket handle.

◆ EvrNetUDP_SendBufferInvalid()

__STATIC_INLINE void EvrNetUDP_SendBufferInvalid ( int32_t socket )

Event on UDP send buffer is invalid (Error)

Parameters

socket socket handle

The event SendBufferInvalid is created, when the internal function udp_send can not send the UDP frame, because the send buffer is invalid. This happens when the sending buffer is not allocated from netUDP_GetBuffer function.

Value in the Event Recorder shows:

socket: UDP socket handle.

◆ EvrNetUDP_SendFrame()

__STATIC_INLINE void EvrNetUDP_SendFrame	(	int32_t	socket,
		uint32_t	length
	)

Event on UDP send frame (Op)

Parameters

socket	socket handle
length	frame length in bytes

The event SendFrame is created when the UDP frame header is constructed and the frame is sent to IP layer for further processing and transmit.

Value in the Event Recorder shows:

socket: UDP socket handle.
len: length of the UDP frame payload.

◆ EvrNetUDP_SendPortUndefined()

__STATIC_INLINE void EvrNetUDP_SendPortUndefined ( int32_t socket )

Event on UDP send port undefined (Error)

Parameters

socket socket handle

The event SendPortUndefined is created, when the internal function udp_send can not send the UDP frame because the provided destination port is undefined. This usually happens when the netUDP_Send function is executed and the sending frame is discarded.

Value in the Event Recorder shows:

socket: UDP socket handle.

◆ EvrNetUDP_SendSizeTruncated()

__STATIC_INLINE void EvrNetUDP_SendSizeTruncated	(	int32_t	socket,
		uint32_t	new_length
	)

Event on UDP send truncated over-size packet (Op)

Parameters

socket	socket handle
new_length	truncated frame length

The event SendSizeTruncated is created, when the internal function udp_send truncates the data, because the length of the data is too large. This happens when the netUDP_Send function is executed.

Value in the Event Recorder shows:

socket: UDP socket handle.
new_len: shortened data length.

◆ EvrNetUDP_SendSocketNotOpen()

__STATIC_INLINE void EvrNetUDP_SendSocketNotOpen ( int32_t socket )

Event on UDP send socket not open, invalid socket state (Error)

Parameters

socket socket handle

The event SendSocketNotOpen is created, when the internal function udp_send can not send the UDP frame because the UDP socket is not open for communication. You should open the UDP socket first and then send the frame. This usually happens when the netUDP_Send function is executed and the sending frame is discarded.

Value in the Event Recorder shows:

socket: UDP socket handle.

◆ EvrNetUDP_SendSocketNotValid()

__STATIC_INLINE void EvrNetUDP_SendSocketNotValid ( int32_t socket )

Event on UDP send socket handle is not valid (Error)

Parameters

socket socket handle

The event SendSocketNotValid is created, when the internal function udp_send can not send the UDP frame because the provided socket handle is invalid. This usually happens when the netUDP_Send function is executed and the sending frame is discarded.

Value in the Event Recorder shows:

socket: UDP socket handle.

◆ EvrNetUDP_SendZeroLengthFrame()

__STATIC_INLINE void EvrNetUDP_SendZeroLengthFrame ( int32_t socket )

Event on UDP send 0-length frame, frame is dumped (Op)

Parameters

socket socket handle

The event SendZeroLengthFrame is created, when the internal function udp_send can not send the UDP frame because the length of the data is zero. This usually happens when the netUDP_Send function is executed and the sending frame is discarded.

Value in the Event Recorder shows:

socket: UDP socket handle.

◆ EvrNetUDP_SetOptionChecksum()

__STATIC_INLINE void EvrNetUDP_SetOptionChecksum	(	int32_t	socket,
		uint32_t	checksum
	)

Event on UDP set socket option checksum calculation options (Detail)

Parameters

socket	socket handle
checksum	checksum calculation options bitmap 0x01: calculate checksum for send frames 0x02: verify checksum for received frames

The event SetOptionChecksum is created, when the internal function udp_set_option sets the checksum generation and checksum verification options for the socket. This usually happens when the netUDP_SetOption function is executed.

Value in the Event Recorder shows:

socket: UDP socket handle for setting the option.
send: send checksum generation (On, Off).
verify: receive checksum verification (On, Off).

◆ EvrNetUDP_SetOptionHopLimit()

__STATIC_INLINE void EvrNetUDP_SetOptionHopLimit	(	int32_t	socket,
		uint8_t	ip6_hoplimit
	)

Event on UDP set socket option Hop Limit for IPv6 (Detail)

Parameters

socket	socket handle
ip6_hoplimit	hop limit value

The event SetOptionHopLimit is created, when the internal function udp_set_option sets the HopLimit option (IPv6 Hop Limit) for the socket. This usually happens when the netUDP_SetOption function is executed.

Value in the Event Recorder shows:

socket: UDP socket handle for setting the option.
hop_limit: value for HopLimit option.

◆ EvrNetUDP_SetOptionInterface()

__STATIC_INLINE void EvrNetUDP_SetOptionInterface	(	int32_t	socket,
		uint16_t	if_id
	)

Event on UDP set socket option broadcast interface (Detail)

Parameters

socket	socket handle
if_id	network interface identifier

The event SetOptionInterface is created, when the internal function udp_set_option sets the network interface for the socket that is used when the netUDP_Send sends data to a broadcast or a multicast address. This usually happens when the netUDP_SetOption function is executed.

Value in the Event Recorder shows:

socket: UDP socket handle for setting the option.
netif: network interface identifier.

◆ EvrNetUDP_SetOptionSocket()

__STATIC_INLINE void EvrNetUDP_SetOptionSocket	(	int32_t	socket,
		int32_t	option,
		uint32_t	val
	)

Event on UDP set socket option (Op)

Parameters

socket	socket handle
option	interface option as specified by netUDP_Option
val	option value

The event SetOptionSocket is created, when the internal function udp_set_option sets the operating option for the UDP socket. This usually happens when the netUDP_SetOption function is executed.

Value in the Event Recorder shows:

socket: UDP socket handle for setting the option.
opt: option to be set.
val: value for the setting option.

◆ EvrNetUDP_SetOptionSocketNotValid()

__STATIC_INLINE void EvrNetUDP_SetOptionSocketNotValid ( int32_t socket )

Event on UDP set socket option failed, not valid socket (Error)

Parameters

socket socket handle

The event SetOptionSocketNotValid is created, when the internal function udp_set_option can not set the UDP socket option because the provided socket handle is invalid. This usually happens when the netUDP_SetOption function is executed.

Value in the Event Recorder shows:

socket: UDP socket handle for setting the option.

◆ EvrNetUDP_SetOptionSocketWrongState()

__STATIC_INLINE void EvrNetUDP_SetOptionSocketWrongState	(	int32_t	socket,
		uint8_t	state
	)

Event on UDP set socket option failed, wrong socket state (Error)

Parameters

socket	socket handle
state	socket state

The event SetOptionSocketWrongState is created, when the internal function udp_set_option can not set the UDP socket option because the socket is not created. This usually happens when the netUDP_SetOption function is executed. Before you set the socket option, you must first allocate the socket.

Value in the Event Recorder shows:

socket: UDP socket handle for setting the option.
state: state of the UDP socket.

◆ EvrNetUDP_SetOptionTclass()

__STATIC_INLINE void EvrNetUDP_SetOptionTclass	(	int32_t	socket,
		uint8_t	ip6_tclass
	)

Event on UDP set socket option Traffic Class for IPv6 (Detail)

Parameters

socket	socket handle
ip6_tclass	traffic class value

The event SetOptionTclass is created, when the internal function udp_set_option sets the TClass (IPv6 Traffic Class) for the socket. This usually happens when the netUDP_SetOption function is executed.

Value in the Event Recorder shows:

socket: UDP socket handle for setting the option.
tclass: value for TClass option.

◆ EvrNetUDP_SetOptionTos()

__STATIC_INLINE void EvrNetUDP_SetOptionTos	(	int32_t	socket,
		uint8_t	ip4_tos
	)

Event on UDP set socket option Type Of Service for IPv4 (Detail)

Parameters

socket	socket handle
ip4_tos	type of service value

The event SetOptionTos is created, when the internal function udp_set_option sets the TOS (IPv4 Type of Service) for the socket. This usually happens when the netUDP_SetOption function is executed.

Value in the Event Recorder shows:

socket: UDP socket handle for setting the option.
tos: value for TOS option.

◆ EvrNetUDP_SetOptionTtl()

__STATIC_INLINE void EvrNetUDP_SetOptionTtl	(	int32_t	socket,
		uint8_t	ip4_ttl
	)

Event on UDP set socket option Time To Live for IPv4 (Detail)

Parameters

socket	socket handle
ip4_ttl	time to live value

The event SetOptionTtl is created, when the internal function udp_set_option sets the TTL option (IPv4 Time to Live) for the socket. This usually happens when the netUDP_SetOption function is executed.

Value in the Event Recorder shows:

socket: UDP socket handle for setting the option.
ttl: value for TTL option.

◆ EvrNetUDP_SetOptionWrongOption()

__STATIC_INLINE void EvrNetUDP_SetOptionWrongOption	(	int32_t	socket,
		int32_t	udp_option
	)

Event on UDP wrong set socket option (Error)

Parameters

socket	socket handle
udp_option	wrong set option value

The event SetOptionWrongOption is created, when the internal function udp_set_option can not set the UDP socket option because the requested option is not supported. This can happen when attempting to set the IPv6 option in IPv4-Only Network library.

Value in the Event Recorder shows:

socket: UDP socket handle for setting the option.
opt: requested option to set.

◆ EvrNetUDP_SetOptionWrongValue()

__STATIC_INLINE void EvrNetUDP_SetOptionWrongValue	(	int32_t	socket,
		uint32_t	opt_value
	)

Event on UDP wrong value for set socket option (Error)

Parameters

socket	socket handle
opt_value	wrong value for set option

The event SetOptionWrongValue is created, when the internal function udp_set_option can not set the UDP socket option because the option value is invalid. This usually happens when the option value is out of range.

Value in the Event Recorder shows:

socket: UDP socket handle for setting the option.
value: option value that is invalid.

◆ EvrNetUDP_ShowFrameHeader()

__STATIC_INLINE void EvrNetUDP_ShowFrameHeader ( const void * udp_header )

Event on UDP display send/receive frame header (Detail)

Parameters

udp_header

pointer to UDP frame header of 8 bytes

SrcPort (2 bytes)
DstPort (2 bytes)
Len (2 bytes)
Chksum (2 bytes)

The event ShowFrameHeader is created when the network library wants to display detailed information about the UDP header.

Value in the Event Recorder shows:

dst_port: destination UDP port.
src_port: source UDP port.
cksum: frame checksum.
len: length of the frame in bytes.

◆ EvrNetUDP_UninitSockets()

__STATIC_INLINE void EvrNetUDP_UninitSockets ( void )

Event on UDP de-initialize available sockets (Op)

The event UninitSockets is created when the function netUninitialize is executed.

Value in the Event Recorder shows:

udp

Functions

Description

Function Documentation

◆ EvrNetUDP_AssignLocalPort()

◆ EvrNetUDP_ChecksumFailed()

◆ EvrNetUDP_CloseSocket()

◆ EvrNetUDP_CloseSocketNotValid()

◆ EvrNetUDP_FrameNotMapped()

◆ EvrNetUDP_FrameTooShort()

◆ EvrNetUDP_GetBufferFailed()

◆ EvrNetUDP_GetSocket()

◆ EvrNetUDP_GetSocketInvalidParameter()

◆ EvrNetUDP_InitSockets()

◆ EvrNetUDP_LinkLayerAddressed()

◆ EvrNetUDP_MapFrameToSocket()

◆ EvrNetUDP_NoSocketAvailable()

◆ EvrNetUDP_OpenLocalPortInUse()

◆ EvrNetUDP_OpenSocket()

◆ EvrNetUDP_OpenSocketNotValid()

◆ EvrNetUDP_OpenSocketWrongState()

◆ EvrNetUDP_ReceiveFrame()

◆ EvrNetUDP_ReleaseSocket()

◆ EvrNetUDP_ReleaseSocketNotValid()

◆ EvrNetUDP_ReleaseSocketWrongState()

◆ EvrNetUDP_SendAddressUnspecified()

◆ EvrNetUDP_SendBufferInvalid()

◆ EvrNetUDP_SendFrame()

◆ EvrNetUDP_SendPortUndefined()

◆ EvrNetUDP_SendSizeTruncated()

◆ EvrNetUDP_SendSocketNotOpen()

◆ EvrNetUDP_SendSocketNotValid()

◆ EvrNetUDP_SendZeroLengthFrame()

◆ EvrNetUDP_SetOptionChecksum()

◆ EvrNetUDP_SetOptionHopLimit()

◆ EvrNetUDP_SetOptionInterface()

◆ EvrNetUDP_SetOptionSocket()

◆ EvrNetUDP_SetOptionSocketNotValid()

◆ EvrNetUDP_SetOptionSocketWrongState()

◆ EvrNetUDP_SetOptionTclass()

◆ EvrNetUDP_SetOptionTos()

◆ EvrNetUDP_SetOptionTtl()

◆ EvrNetUDP_SetOptionWrongOption()

◆ EvrNetUDP_SetOptionWrongValue()

◆ EvrNetUDP_ShowFrameHeader()

◆ EvrNetUDP_UninitSockets()