Network Component  Version 7.16.0
MDK Middleware for IPv4 and IPv6 Networking
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_ReceiveFrame (const void *net_addr, uint32_t length)
 Event on DNS client receive frame from the 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_OpcodeNotQuery (void)
 Event on DNS client OPCODE in a response is not QUERY (Error) More...
 
__STATIC_INLINE void EvrNetDNS_MessageTruncated (void)
 Event on DNS client truncated response message received (Op) 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_GotHostAddress (const void *net_addr, uint32_t ttl)
 Event on DNS client receive resolved IP address (Op) More...
 
__STATIC_INLINE void EvrNetDNS_GotAuthorityAddress (const void *net_addr)
 Event on DNS client receive IP 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_ResolvedAddress (const void *net_addr)
 Event on DNS client resolved IP 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_SendRequest (const void *net_addr)
 Event on DNS client send resolve request to the 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

◆ EvrNetDNS_ChangeDnsServer()

__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

◆ EvrNetDNS_ClearCache()

__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

◆ EvrNetDNS_ClearCacheClientBusy()

__STATIC_INLINE void EvrNetDNS_ClearCacheClientBusy ( void  )

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

◆ EvrNetDNS_ClientStopTimeoutExpired()

__STATIC_INLINE void EvrNetDNS_ClientStopTimeoutExpired ( void  )

Event on DNS client stop operation timeout expired (Error)

◆ EvrNetDNS_DnsRequestReceived()

__STATIC_INLINE void EvrNetDNS_DnsRequestReceived ( void  )

Event on DNS client received a DNS request (Error)

◆ EvrNetDNS_FrameTooShort()

__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

◆ EvrNetDNS_GetSocketFailed()

__STATIC_INLINE void EvrNetDNS_GetSocketFailed ( void  )

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

◆ EvrNetDNS_GotAuthorityAddress()

__STATIC_INLINE void EvrNetDNS_GotAuthorityAddress ( const void *  net_addr)

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

Parameters
net_addrpointer to net address of the authority

◆ EvrNetDNS_GotHostAddress()

__STATIC_INLINE void EvrNetDNS_GotHostAddress ( const void *  net_addr,
uint32_t  ttl 
)

Event on DNS client receive resolved IP address (Op)

Parameters
net_addrpointer to network address of the host
ttladdress expiration timeout

◆ EvrNetDNS_InitClient()

__STATIC_INLINE void EvrNetDNS_InitClient ( uint32_t  num_entries)

Event on DNS client initialize (Op)

Parameters
num_entriesnumber of entries available in cache

◆ EvrNetDNS_MessageTruncated()

__STATIC_INLINE void EvrNetDNS_MessageTruncated ( void  )

Event on DNS client truncated response message received (Op)

◆ EvrNetDNS_MoreAnswersReceived()

__STATIC_INLINE void EvrNetDNS_MoreAnswersReceived ( void  )

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

◆ EvrNetDNS_NoSuchNameFound()

__STATIC_INLINE void EvrNetDNS_NoSuchNameFound ( void  )

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

◆ EvrNetDNS_OpcodeNotQuery()

__STATIC_INLINE void EvrNetDNS_OpcodeNotQuery ( void  )

Event on DNS client OPCODE in a response is not QUERY (Error)

◆ EvrNetDNS_QclassNotInet()

__STATIC_INLINE void EvrNetDNS_QclassNotInet ( void  )

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

◆ EvrNetDNS_QnameNotTheSame()

__STATIC_INLINE void EvrNetDNS_QnameNotTheSame ( void  )

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

◆ EvrNetDNS_QtypeNotTheSame()

__STATIC_INLINE void EvrNetDNS_QtypeNotTheSame ( void  )

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

◆ EvrNetDNS_RcodeAndRecursion()

__STATIC_INLINE void EvrNetDNS_RcodeAndRecursion ( void  )

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

◆ EvrNetDNS_ReceiveFrame()

__STATIC_INLINE void EvrNetDNS_ReceiveFrame ( const void *  net_addr,
uint32_t  length 
)

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

Parameters
net_addrpointer to NET_ADDR address of the server
lengthframe length in bytes
Remarks
Port member is undefined and reused for the length parameter.

◆ EvrNetDNS_RecordTypeNotSupported()

__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

◆ EvrNetDNS_Resolve()

__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

◆ EvrNetDNS_ResolveClientBusy()

__STATIC_INLINE void EvrNetDNS_ResolveClientBusy ( void  )

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

◆ EvrNetDNS_ResolvedAddress()

__STATIC_INLINE void EvrNetDNS_ResolvedAddress ( const void *  net_addr)

Event on DNS client resolved IP address internally (Op)

Parameters
net_addrpointer to NET_ADDR address structure

◆ EvrNetDNS_ResolveDnsServerUnknown()

__STATIC_INLINE void EvrNetDNS_ResolveDnsServerUnknown ( void  )

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

◆ EvrNetDNS_ResolveInvalidParameter()

__STATIC_INLINE void EvrNetDNS_ResolveInvalidParameter ( void  )

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

◆ EvrNetDNS_SendRequest()

__STATIC_INLINE void EvrNetDNS_SendRequest ( const void *  net_addr)

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

Parameters
net_addrpointer to NET_ADDR address structure

◆ EvrNetDNS_ShowFrameHeader()

__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)

◆ EvrNetDNS_UninitClient()

__STATIC_INLINE void EvrNetDNS_UninitClient ( void  )

Event on DNS client de-initialize (Op)

◆ EvrNetDNS_WrongServerAddress()

__STATIC_INLINE void EvrNetDNS_WrongServerAddress ( void  )

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

◆ EvrNetDNS_WrongServerPort()

__STATIC_INLINE void EvrNetDNS_WrongServerPort ( uint16_t  udp_port)

Event on DNS client wrong server port (Error)

Parameters
udp_portwrong UDP port number

◆ EvrNetDNS_WrongTransactionId()

__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