Network Component  Version 7.8.0
MDK Middleware for IPv4 and IPv6 Networking
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NetUDP: UDP Socket

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) More...
 
__STATIC_INLINE void EvrNetUDP_GetSocketInvalidParameter (void)
 Event on UDP get socket failed, invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetUDP_SocketAllocated (int32_t socket)
 Event on UDP free socket allocated (Op) More...
 
__STATIC_INLINE void EvrNetUDP_NoSocketsAvailable (void)
 Event on UDP get socket failed, no free sockets available (Error) More...
 
__STATIC_INLINE void EvrNetUDP_ReleaseSocket (int32_t socket)
 Event on UDP release socket (Op) More...
 
__STATIC_INLINE void EvrNetUDP_ReleaseSocketNotValid (int32_t socket)
 Event on UDP release failed, not valid socket (Error) More...
 
__STATIC_INLINE void EvrNetUDP_ReleaseSocketWrongState (int32_t socket)
 Event on UDP release failed, wrong socket state (Error) More...
 
__STATIC_INLINE void EvrNetUDP_OpenSocket (int32_t socket, uint16_t port)
 Event on UDP open socket for communication (Op) More...
 
__STATIC_INLINE void EvrNetUDP_OpenSocketNotValid (int32_t socket)
 Event on UDP open failed, not valid socket (Error) More...
 
__STATIC_INLINE void EvrNetUDP_OpenSocketWrongState (int32_t socket)
 Event on UDP open socket failed, wrong socket state (Error) More...
 
__STATIC_INLINE void EvrNetUDP_OpenLocalPortAssigned (uint16_t local_port)
 Event on UDP local port assigned in open socket request (Op) More...
 
__STATIC_INLINE void EvrNetUDP_OpenLocalPortInUse (int32_t socket, uint16_t port)
 Event on UDP open socket failed, requested port already used (Error) More...
 
__STATIC_INLINE void EvrNetUDP_CloseSocket (int32_t socket)
 Event on UDP close socket (Op) More...
 
__STATIC_INLINE void EvrNetUDP_CloseSocketNotValid (int32_t socket)
 Event on UDP close socket failed, not valid socket (Error) More...
 
__STATIC_INLINE void EvrNetUDP_SetOptionSocket (int32_t socket)
 Event on UDP set socket option (Op) More...
 
__STATIC_INLINE void EvrNetUDP_SetOptionSocketNotValid (int32_t socket)
 Event on UDP set socket option failed, not valid socket (Error) More...
 
__STATIC_INLINE void EvrNetUDP_SetOptionSocketWrongState (int32_t socket)
 Event on UDP set socket option failed, wrong socket state (Error) More...
 
__STATIC_INLINE void EvrNetUDP_SetOptionTos (uint8_t ip4_tos)
 Event on UDP set socket option Type Of Service for IPv4 (Op) More...
 
__STATIC_INLINE void EvrNetUDP_SetOptionTtl (uint8_t ip4_ttl)
 Event on UDP set socket option Time To Live for IPv4 (Op) More...
 
__STATIC_INLINE void EvrNetUDP_SetOptionTclass (uint8_t ip6_tclass)
 Event on UDP set socket option Traffic Class for IPv6 (Op) More...
 
__STATIC_INLINE void EvrNetUDP_SetOptionHopLimit (uint8_t ip6_hoplimit)
 Event on UDP set socket option Hop Limit for IPv6 (Op) More...
 
__STATIC_INLINE void EvrNetUDP_SetOptionChecksum (uint8_t checksum)
 Event on UDP set socket option checksum calculation options (Op) More...
 
__STATIC_INLINE void EvrNetUDP_SetOptionWrongOption (int32_t socket, uint8_t udp_option)
 Event on UDP wrong set socket option (Error) More...
 
__STATIC_INLINE void EvrNetUDP_SetOptionWrongValue (int32_t socket, uint8_t opt_value)
 Event on UDP wrong value for set socket option (Error) More...
 
__STATIC_INLINE void EvrNetUDP_GetBufferFailed (uint16_t mem_size)
 Event on UDP get buffer failed, out of memory (Error) More...
 
__STATIC_INLINE void EvrNetUDP_SendFrame (int32_t socket, uint32_t length)
 Event on UDP send frame (Op) More...
 
__STATIC_INLINE void EvrNetUDP_SendBufferInvalid (int32_t socket)
 Event on UDP send buffer is invalid (Error) More...
 
__STATIC_INLINE void EvrNetUDP_SendSocketNotValid (int32_t socket)
 Event on UDP send socket handle is not valid (Error) More...
 
__STATIC_INLINE void EvrNetUDP_SendAddressUnspecified (int32_t socket)
 Event on UDP send destination address not specified (Error) More...
 
__STATIC_INLINE void EvrNetUDP_SendPortUndefined (int32_t socket)
 Event on UDP send port undefined (Error) More...
 
__STATIC_INLINE void EvrNetUDP_SendSocketNotOpen (int32_t socket)
 Event on UDP send socket not open, invalid socket state (Error) More...
 
__STATIC_INLINE void EvrNetUDP_SendZeroLengthFrame (int32_t socket)
 Event on UDP send 0-length frame, frame is dumped (Op) More...
 
__STATIC_INLINE void EvrNetUDP_SendSizeTruncated (uint32_t new_length)
 Event on UDP send truncated over-size packet (Op) More...
 
__STATIC_INLINE void EvrNetUDP_ShowFrameHeader (const void *udp_header)
 Event on UDP display send/receive frame header (Detail) More...
 
__STATIC_INLINE void EvrNetUDP_ReceiveFrame (uint32_t length, uint8_t ip_version)
 Event on UDP receive frame (Op) More...
 
__STATIC_INLINE void EvrNetUDP_FrameTooShort (uint32_t length, uint32_t min_length)
 Event on UDP received frame too short (Error) More...
 
__STATIC_INLINE void EvrNetUDP_MappedToSocket (int32_t socket)
 Event on UDP received frame mapped to a socket (Op) More...
 
__STATIC_INLINE void EvrNetUDP_FrameNotMapped (uint32_t length)
 Event on UDP received frame not mapped, no open sockets found (Op) More...
 
__STATIC_INLINE void EvrNetUDP_ChecksumFailed (int32_t socket)
 Event on UDP frame checksum check failed (Error) More...
 
__STATIC_INLINE void EvrNetUDP_UninitSockets (void)
 Event on UDP socket de-initialize (Op) More...
 

Description

Events generated by the Network - UDP Socket functions.

Function Documentation

__STATIC_INLINE void EvrNetUDP_ChecksumFailed ( int32_t  socket)

Event on UDP frame checksum check failed (Error)

Parameters
socketsocket handle
__STATIC_INLINE void EvrNetUDP_CloseSocket ( int32_t  socket)

Event on UDP close socket (Op)

Parameters
socketsocket handle
__STATIC_INLINE void EvrNetUDP_CloseSocketNotValid ( int32_t  socket)

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

Parameters
socketsocket handle
__STATIC_INLINE void EvrNetUDP_FrameNotMapped ( uint32_t  length)

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

Parameters
lengthframe length in bytes
__STATIC_INLINE void EvrNetUDP_FrameTooShort ( uint32_t  length,
uint32_t  min_length 
)

Event on UDP received frame too short (Error)

Parameters
lengthframe length in bytes
min_lengthminimum length of the frame
__STATIC_INLINE void EvrNetUDP_GetBufferFailed ( uint16_t  mem_size)

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

Parameters
mem_sizerequested memory size
__STATIC_INLINE void EvrNetUDP_GetSocketInvalidParameter ( void  )

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

__STATIC_INLINE void EvrNetUDP_InitSockets ( uint32_t  num_sockets)

Event on UDP socket initialize (Op)

Parameters
num_socketsnumber of available UDP sockets
__STATIC_INLINE void EvrNetUDP_MappedToSocket ( int32_t  socket)

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

Parameters
socketmapped socket handle
__STATIC_INLINE void EvrNetUDP_NoSocketsAvailable ( void  )

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

__STATIC_INLINE void EvrNetUDP_OpenLocalPortAssigned ( uint16_t  local_port)

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

Parameters
local_portassigned local port number
__STATIC_INLINE void EvrNetUDP_OpenLocalPortInUse ( int32_t  socket,
uint16_t  port 
)

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

Parameters
socketsocket handle
portlocal port number
__STATIC_INLINE void EvrNetUDP_OpenSocket ( int32_t  socket,
uint16_t  port 
)

Event on UDP open socket for communication (Op)

Parameters
socketsocket handle
portlocal port number
__STATIC_INLINE void EvrNetUDP_OpenSocketNotValid ( int32_t  socket)

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

Parameters
socketsocket handle
__STATIC_INLINE void EvrNetUDP_OpenSocketWrongState ( int32_t  socket)

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

Parameters
socketsocket handle
__STATIC_INLINE void EvrNetUDP_ReceiveFrame ( uint32_t  length,
uint8_t  ip_version 
)

Event on UDP receive frame (Op)

Parameters
lengthframe length in bytes
ip_versioninternet protocol version
  • 0: IPv4
  • 1: IPv6
__STATIC_INLINE void EvrNetUDP_ReleaseSocket ( int32_t  socket)

Event on UDP release socket (Op)

Parameters
socketsocket handle
__STATIC_INLINE void EvrNetUDP_ReleaseSocketNotValid ( int32_t  socket)

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

Parameters
socketsocket handle
__STATIC_INLINE void EvrNetUDP_ReleaseSocketWrongState ( int32_t  socket)

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

Parameters
socketsocket handle
__STATIC_INLINE void EvrNetUDP_SendAddressUnspecified ( int32_t  socket)

Event on UDP send destination address not specified (Error)

Parameters
socketsocket handle
__STATIC_INLINE void EvrNetUDP_SendBufferInvalid ( int32_t  socket)

Event on UDP send buffer is invalid (Error)

Parameters
socketsocket handle
__STATIC_INLINE void EvrNetUDP_SendFrame ( int32_t  socket,
uint32_t  length 
)

Event on UDP send frame (Op)

Parameters
socketsocket handle
lengthframe length in bytes
__STATIC_INLINE void EvrNetUDP_SendPortUndefined ( int32_t  socket)

Event on UDP send port undefined (Error)

Parameters
socketsocket handle
__STATIC_INLINE void EvrNetUDP_SendSizeTruncated ( uint32_t  new_length)

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

Parameters
new_lengthtruncated frame length
__STATIC_INLINE void EvrNetUDP_SendSocketNotOpen ( int32_t  socket)

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

Parameters
socketsocket handle
__STATIC_INLINE void EvrNetUDP_SendSocketNotValid ( int32_t  socket)

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

Parameters
socketsocket handle
__STATIC_INLINE void EvrNetUDP_SendZeroLengthFrame ( int32_t  socket)

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

Parameters
socketsocket handle
__STATIC_INLINE void EvrNetUDP_SetOptionChecksum ( uint8_t  checksum)

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

Parameters
checksumchecksum calculation options bitmap
  • 0x01: calculate checksum for send frames
  • 0x02: verify checksum for received frames
__STATIC_INLINE void EvrNetUDP_SetOptionHopLimit ( uint8_t  ip6_hoplimit)

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

Parameters
ip6_hoplimithop limit value
__STATIC_INLINE void EvrNetUDP_SetOptionSocket ( int32_t  socket)

Event on UDP set socket option (Op)

Parameters
socketsocket handle
__STATIC_INLINE void EvrNetUDP_SetOptionSocketNotValid ( int32_t  socket)

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

Parameters
socketsocket handle
__STATIC_INLINE void EvrNetUDP_SetOptionSocketWrongState ( int32_t  socket)

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

Parameters
socketsocket handle
__STATIC_INLINE void EvrNetUDP_SetOptionTclass ( uint8_t  ip6_tclass)

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

Parameters
ip6_tclasstraffic class value
__STATIC_INLINE void EvrNetUDP_SetOptionTos ( uint8_t  ip4_tos)

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

Parameters
ip4_tostype of service value
__STATIC_INLINE void EvrNetUDP_SetOptionTtl ( uint8_t  ip4_ttl)

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

Parameters
ip4_ttltime to live value
__STATIC_INLINE void EvrNetUDP_SetOptionWrongOption ( int32_t  socket,
uint8_t  udp_option 
)

Event on UDP wrong set socket option (Error)

Parameters
socketsocket handle
udp_optionwrong set option value
__STATIC_INLINE void EvrNetUDP_SetOptionWrongValue ( int32_t  socket,
uint8_t  opt_value 
)

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

Parameters
socketsocket handle
opt_valuewrong value for set option
__STATIC_INLINE void EvrNetUDP_ShowFrameHeader ( const void *  udp_header)

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

Parameters
udp_headerpointer to UDP frame header of 8 bytes
  • SrcPort (2 bytes)
  • DstPort (2 bytes)
  • Len (2 bytes)
  • Chksum (2 bytes)
__STATIC_INLINE void EvrNetUDP_SocketAllocated ( int32_t  socket)

Event on UDP free socket allocated (Op)

Parameters
socketallocated socket handle
__STATIC_INLINE void EvrNetUDP_UninitSockets ( void  )

Event on UDP socket de-initialize (Op)