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
NetNBNS: NBNS Client

Events generated by the Network - NetBIOS Name Service Client functions. More...

Functions

__STATIC_INLINE void EvrNetNBNS_InitService (void)
 Event on NBNS name service initialize (Op) More...
 
__STATIC_INLINE void EvrNetNBNS_GetSocketFailed (void)
 Event on NBNS failed to allocate UDP socket (Error) More...
 
__STATIC_INLINE void EvrNetNBNS_ReceiveFrame (uint32_t length)
 Event on NBNS receive frame (Op) More...
 
__STATIC_INLINE void EvrNetNBNS_WrongPort (uint16_t port, uint16_t port_valid)
 Event on NBNS wrong UDP source port (Error) More...
 
__STATIC_INLINE void EvrNetNBNS_FrameTooShort (uint32_t length, uint32_t min_length)
 Event on NBNS receive frame is too short (Error) More...
 
__STATIC_INLINE void EvrNetNBNS_NameQueryRequest (const char *q_name, uint32_t length)
 Event on NBNS name query request received (Op) More...
 
__STATIC_INLINE void EvrNetNBNS_QueryFromAddress (const uint8_t *ip4_addr)
 Event on NBNS name query from IP-address (Detail) More...
 
__STATIC_INLINE void EvrNetNBNS_NameQueryResponse (const uint8_t *ip4_addr)
 Event on NBNS response to a name query (Op) More...
 
__STATIC_INLINE void EvrNetNBNS_UninitService (void)
 Event on NBNS name service de-initialize (Op) More...
 

Description

Events generated by the Network - NetBIOS Name Service Client functions.

The Network NBNS Client functions generate events that report events in the NetBIOS name service and help in troubleshooting.

Function Documentation

__STATIC_INLINE void EvrNetNBNS_FrameTooShort ( uint32_t  length,
uint32_t  min_length 
)

Event on NBNS receive frame is too short (Error)

Parameters
lengthframe length in bytes
min_lengthminimum length of the frame

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

Value in the Event Recorder shows:

  • len: length of the received frame in bytes.
  • min: minimum valid frame length in bytes.
__STATIC_INLINE void EvrNetNBNS_GetSocketFailed ( void  )

Event on NBNS failed to allocate UDP socket (Error)

The event GetSocketFailed is created when the NetBIOS name service is initialized, that is, when the function netInitialize is executed, and the service could not assign the UDP socket.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetNBNS_InitService ( void  )

Event on NBNS name service initialize (Op)

The event InitService is created when the NetBIOS name service is initialized, that is, when the function netInitialize is executed.

Value in the Event Recorder shows:

  • nbns
__STATIC_INLINE void EvrNetNBNS_NameQueryRequest ( const char *  q_name,
uint32_t  length 
)

Event on NBNS name query request received (Op)

Parameters
q_namepointer to a question name string
lengthlength of the question name string

The event NameQueryRequest is created when the network library receives a request for the host name to be resolved.

Value in the Event Recorder shows:

  • name: name of the host to resolve.
__STATIC_INLINE void EvrNetNBNS_NameQueryResponse ( const uint8_t *  ip4_addr)

Event on NBNS response to a name query (Op)

Parameters
ip4_addrpointer to local IPv4 address

The event NameQueryResponse is created when the network library responds to name query request with a local IP address. This happens when the requested name is the same as the name of the local host.

Value in the Event Recorder shows:

  • addr: local IP address.
__STATIC_INLINE void EvrNetNBNS_QueryFromAddress ( const uint8_t *  ip4_addr)

Event on NBNS name query from IP-address (Detail)

Parameters
ip4_addrpointer to IPv4 address of a host

The event QueryFromAddress is created when the network library wants to display the IP address of the sender of the name query request.

Value in the Event Recorder shows:

  • addr: IP address of the sender.
__STATIC_INLINE void EvrNetNBNS_ReceiveFrame ( uint32_t  length)

Event on NBNS receive frame (Op)

Parameters
lengthframe length in bytes

The event ReceiveFrame is created when the network library receives the NBNS frame.

Value in the Event Recorder shows:

  • len: length of the received frame in bytes.
__STATIC_INLINE void EvrNetNBNS_UninitService ( void  )

Event on NBNS name service de-initialize (Op)

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

Value in the Event Recorder shows:

  • nbns
__STATIC_INLINE void EvrNetNBNS_WrongPort ( uint16_t  port,
uint16_t  port_valid 
)

Event on NBNS wrong UDP source port (Error)

Parameters
portreceived source port number
port_validvalid source port number

The event WrongPort is created when the network library receives the NBNS frame, and the source UDP port is not a standard NBNS port.

Value in the Event Recorder shows:

  • port: received source UDP port.
  • valid: expected source UDP port.