Network Component  Version 7.11.0
MDK Middleware for IPv4 and IPv6 Networking
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NetDNS: DNS Client

Events generated by the Network - DNS Client functions. More...

Functions

__STATIC_INLINE void EvrNetDNS_InitClient (uint32_t num_entries)
 Event on DNS client initialize (Op) More...
 
__STATIC_INLINE void EvrNetDNS_GetSocketFailed (void)
 Event on DNS client failed to allocate UDP socket (Error) More...
 
__STATIC_INLINE void EvrNetDNS_ChangeDnsServer (int32_t server)
 Event on DNS client change active DNS server (Error) More...
 
__STATIC_INLINE void EvrNetDNS_ClientStopTimeoutExpired (void)
 Event on DNS client stop operation timeout expired (Error) More...
 
__STATIC_INLINE void EvrNetDNS_ReceiveFrameIp4 (const uint8_t *ip4_addr, uint32_t length)
 Event on DNS client receive frame from IPv4 server (Op) More...
 
__STATIC_INLINE void EvrNetDNS_ReceiveFrameIp6 (const uint8_t *ip6_addr, uint32_t length)
 Event on DNS client receive frame from IPv6 server (Op) More...
 
__STATIC_INLINE void EvrNetDNS_WrongServerPort (uint16_t udp_port)
 Event on DNS client wrong server port (Error) More...
 
__STATIC_INLINE void EvrNetDNS_FrameTooShort (uint32_t length, uint32_t min_length)
 Event on DNS client receive frame is too short (Error) More...
 
__STATIC_INLINE void EvrNetDNS_WrongServerAddress (void)
 Event on DNS client wrong DNS server address received (Error) More...
 
__STATIC_INLINE void EvrNetDNS_ShowFrameHeader (const void *dns_header)
 Event on DNS client display send/receive frame header (Detail) More...
 
__STATIC_INLINE void EvrNetDNS_WrongTransactionId (uint16_t tid, uint16_t tid_valid)
 Event on DNS client wrong transaction identifier (TID) received (Error) More...
 
__STATIC_INLINE void EvrNetDNS_DnsRequestReceived (void)
 Event on DNS client received a DNS request (Error) More...
 
__STATIC_INLINE void EvrNetDNS_OpcodeOrTruncated (void)
 Event on DNS client OPCODE not zero or message truncated received (Error) More...
 
__STATIC_INLINE void EvrNetDNS_NoSuchNameFound (void)
 Event on DNS client no such name found message received (Op) More...
 
__STATIC_INLINE void EvrNetDNS_RcodeAndRecursion (void)
 Event on DNS client RCODE not zero and recursion available received (Error) More...
 
__STATIC_INLINE void EvrNetDNS_MoreAnswersReceived (void)
 Event on DNS client more than one answer received (Error) More...
 
__STATIC_INLINE void EvrNetDNS_QnameNotTheSame (void)
 Event on DNS client QNAME in a response not the same as requested (Error) More...
 
__STATIC_INLINE void EvrNetDNS_QtypeNotTheSame (void)
 Event on DNS client QTYPE in a response not the same as requested (Error) More...
 
__STATIC_INLINE void EvrNetDNS_QclassNotInet (void)
 Event on DNS client QCLASS in a response is not CLASS_INET (Error) More...
 
__STATIC_INLINE void EvrNetDNS_GotHostAddressIp4 (const uint8_t *ip4_addr, uint32_t ttl)
 Event on DNS client receive resolved IPv4 address (Op) More...
 
__STATIC_INLINE void EvrNetDNS_GotHostAddressIp6 (const uint8_t *ip6_addr, uint32_t ttl)
 Event on DNS client receive resolved IPv6 address (Op) More...
 
__STATIC_INLINE void EvrNetDNS_GotAuthorityAddressIp4 (const uint8_t *ip4_addr)
 Event on DNS client receive IPv4 address of the authority (Op) More...
 
__STATIC_INLINE void EvrNetDNS_GotAuthorityAddressIp6 (const uint8_t *ip6_addr)
 Event on DNS client receive IPv6 address of the authority (Op) More...
 
__STATIC_INLINE void EvrNetDNS_RecordTypeNotSupported (uint16_t rr_type)
 Event on DNS client can not handle resource record type (Error) More...
 
__STATIC_INLINE void EvrNetDNS_Resolve (const char *host_name, uint32_t length)
 Event on DNS client resolve host requested (Op) More...
 
__STATIC_INLINE void EvrNetDNS_ResolveInvalidParameter (void)
 Event on DNS client invalid parameter for resolve request (Error) More...
 
__STATIC_INLINE void EvrNetDNS_ResolveClientBusy (void)
 Event on DNS client resolve request failed, client busy (Error) More...
 
__STATIC_INLINE void EvrNetDNS_ResolvedAddressIp4 (const uint8_t *ip4_addr)
 Event on DNS client resolved IPv4 address internally (Op) More...
 
__STATIC_INLINE void EvrNetDNS_ResolvedAddressIp6 (const uint8_t *ip6_addr)
 Event on DNS client resolved IPv6 address internally (Op) More...
 
__STATIC_INLINE void EvrNetDNS_ResolveDnsServerUnknown (void)
 Event on DNS client resolve failed, DNS server unknown (Error) More...
 
__STATIC_INLINE void EvrNetDNS_SendRequestIp4 (const uint8_t *ip4_addr)
 Event on DNS client send resolve request to IPv4 server (Op) More...
 
__STATIC_INLINE void EvrNetDNS_SendRequestIp6 (const uint8_t *ip6_addr)
 Event on DNS client send resolve request to IPv6 server (Op) More...
 
__STATIC_INLINE void EvrNetDNS_ClearCache (uint32_t used, uint32_t available)
 Event on DNS client clear cache requested (API) More...
 
__STATIC_INLINE void EvrNetDNS_ClearCacheClientBusy (void)
 Event on DNS client clear cache request failed, client busy (Error) More...
 
__STATIC_INLINE void EvrNetDNS_UninitClient (void)
 Event on DNS client de-initialize (Op) More...
 

Description

Events generated by the Network - DNS Client functions.

Function Documentation

__STATIC_INLINE void EvrNetDNS_ChangeDnsServer ( int32_t  server)

Event on DNS client change active DNS server (Error)

Parameters
serverDNS server to use
  • 0: primary
  • 1: secondary
__STATIC_INLINE void EvrNetDNS_ClearCache ( uint32_t  used,
uint32_t  available 
)

Event on DNS client clear cache requested (API)

Parameters
usednumber of used entries flushed from cache
availablenumber of entries available in cache
__STATIC_INLINE void EvrNetDNS_ClearCacheClientBusy ( void  )

Event on DNS client clear cache request failed, client busy (Error)

__STATIC_INLINE void EvrNetDNS_ClientStopTimeoutExpired ( void  )

Event on DNS client stop operation timeout expired (Error)

__STATIC_INLINE void EvrNetDNS_DnsRequestReceived ( void  )

Event on DNS client received a DNS request (Error)

__STATIC_INLINE void EvrNetDNS_FrameTooShort ( uint32_t  length,
uint32_t  min_length 
)

Event on DNS client receive frame is too short (Error)

Parameters
lengthframe length in bytes
min_lengthminimum length of the frame
__STATIC_INLINE void EvrNetDNS_GetSocketFailed ( void  )

Event on DNS client failed to allocate UDP socket (Error)

__STATIC_INLINE void EvrNetDNS_GotAuthorityAddressIp4 ( const uint8_t *  ip4_addr)

Event on DNS client receive IPv4 address of the authority (Op)

Parameters
ip4_addrpointer to IPv4 address of the authority
__STATIC_INLINE void EvrNetDNS_GotAuthorityAddressIp6 ( const uint8_t *  ip6_addr)

Event on DNS client receive IPv6 address of the authority (Op)

Parameters
ip6_addrpointer to IPv6 address of the authority
__STATIC_INLINE void EvrNetDNS_GotHostAddressIp4 ( const uint8_t *  ip4_addr,
uint32_t  ttl 
)

Event on DNS client receive resolved IPv4 address (Op)

Parameters
ip4_addrpointer to IPv4 address of the host
ttladdress expiration timeout
__STATIC_INLINE void EvrNetDNS_GotHostAddressIp6 ( const uint8_t *  ip6_addr,
uint32_t  ttl 
)

Event on DNS client receive resolved IPv6 address (Op)

Parameters
ip6_addrpointer to IPv6 address of the host
ttladdress expiration timeout
__STATIC_INLINE void EvrNetDNS_InitClient ( uint32_t  num_entries)

Event on DNS client initialize (Op)

Parameters
num_entriesnumber of entries available in cache
__STATIC_INLINE void EvrNetDNS_MoreAnswersReceived ( void  )

Event on DNS client more than one answer received (Error)

__STATIC_INLINE void EvrNetDNS_NoSuchNameFound ( void  )

Event on DNS client no such name found message received (Op)

__STATIC_INLINE void EvrNetDNS_OpcodeOrTruncated ( void  )

Event on DNS client OPCODE not zero or message truncated received (Error)

__STATIC_INLINE void EvrNetDNS_QclassNotInet ( void  )

Event on DNS client QCLASS in a response is not CLASS_INET (Error)

__STATIC_INLINE void EvrNetDNS_QnameNotTheSame ( void  )

Event on DNS client QNAME in a response not the same as requested (Error)

__STATIC_INLINE void EvrNetDNS_QtypeNotTheSame ( void  )

Event on DNS client QTYPE in a response not the same as requested (Error)

__STATIC_INLINE void EvrNetDNS_RcodeAndRecursion ( void  )

Event on DNS client RCODE not zero and recursion available received (Error)

__STATIC_INLINE void EvrNetDNS_ReceiveFrameIp4 ( const uint8_t *  ip4_addr,
uint32_t  length 
)

Event on DNS client receive frame from IPv4 server (Op)

Parameters
ip4_addrpointer to IPv4 address of the server
lengthframe length in bytes
__STATIC_INLINE void EvrNetDNS_ReceiveFrameIp6 ( const uint8_t *  ip6_addr,
uint32_t  length 
)

Event on DNS client receive frame from IPv6 server (Op)

Parameters
ip6_addrpointer to IPv6 address of the server
lengthframe length in bytes
__STATIC_INLINE void EvrNetDNS_RecordTypeNotSupported ( uint16_t  rr_type)

Event on DNS client can not handle resource record type (Error)

Parameters
rr_typerecource record type
__STATIC_INLINE void EvrNetDNS_Resolve ( const char *  host_name,
uint32_t  length 
)

Event on DNS client resolve host requested (Op)

Parameters
host_namename of the host to resolve
lengthlength of the host_name string
__STATIC_INLINE void EvrNetDNS_ResolveClientBusy ( void  )

Event on DNS client resolve request failed, client busy (Error)

__STATIC_INLINE void EvrNetDNS_ResolvedAddressIp4 ( const uint8_t *  ip4_addr)

Event on DNS client resolved IPv4 address internally (Op)

Parameters
ip4_addrpointer to resolved IPv4 address
__STATIC_INLINE void EvrNetDNS_ResolvedAddressIp6 ( const uint8_t *  ip6_addr)

Event on DNS client resolved IPv6 address internally (Op)

Parameters
ip6_addrpointer to resolved IPv6 address
__STATIC_INLINE void EvrNetDNS_ResolveDnsServerUnknown ( void  )

Event on DNS client resolve failed, DNS server unknown (Error)

__STATIC_INLINE void EvrNetDNS_ResolveInvalidParameter ( void  )

Event on DNS client invalid parameter for resolve request (Error)

__STATIC_INLINE void EvrNetDNS_SendRequestIp4 ( const uint8_t *  ip4_addr)

Event on DNS client send resolve request to IPv4 server (Op)

Parameters
ip4_addrpointer to IPv4 address of DNS server
__STATIC_INLINE void EvrNetDNS_SendRequestIp6 ( const uint8_t *  ip6_addr)

Event on DNS client send resolve request to IPv6 server (Op)

Parameters
ip6_addrpointer to IPv6 address of DNS server
__STATIC_INLINE void EvrNetDNS_ShowFrameHeader ( const void *  dns_header)

Event on DNS client display send/receive frame header (Detail)

Parameters
dns_headerpointer to DNS frame header of 12 bytes
  • TID (2 bytes)
  • Flags (2 bytes)
  • QDCOUNT (2 bytes)
  • ANCOUNT (2 bytes)
  • NSCOUNT (2 bytes)
  • ARCOUNT (2 bytes)
__STATIC_INLINE void EvrNetDNS_UninitClient ( void  )

Event on DNS client de-initialize (Op)

__STATIC_INLINE void EvrNetDNS_WrongServerAddress ( void  )

Event on DNS client wrong DNS server address received (Error)

__STATIC_INLINE void EvrNetDNS_WrongServerPort ( uint16_t  udp_port)

Event on DNS client wrong server port (Error)

Parameters
udp_portwrong UDP port number
__STATIC_INLINE void EvrNetDNS_WrongTransactionId ( uint16_t  tid,
uint16_t  tid_valid 
)

Event on DNS client wrong transaction identifier (TID) received (Error)

Parameters
tidreceived transaction identifier
tid_validvalid transaction identifier