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

Functions
__STATIC_INLINE void	EvrNetNBNS_InitService (uint16_t if_id)
	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 (uint16_t if_id, uint32_t length)
	Event on NBNS receive frame (Op) More...

__STATIC_INLINE void	EvrNetNBNS_WrongRemotePort (uint16_t if_id, uint16_t port, uint16_t port_valid)
	Event on NBNS wrong remote UDP port (Error) More...

__STATIC_INLINE void	EvrNetNBNS_FrameTooShort (uint16_t if_id, uint32_t length, uint32_t min_length)
	Event on NBNS receive frame is too short (Error) More...

__STATIC_INLINE void	EvrNetNBNS_NetBiosDisabled (uint16_t if_id)
	Event on NBNS receive frame for NetBIOS disabled (Op) 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 (uint16_t if_id, const uint8_t *ip4_addr)
	Event on NBNS name query from IP-address (Detail) More...

__STATIC_INLINE void	EvrNetNBNS_NameQueryResponse (uint16_t if_id, const uint8_t *ip4_addr)
	Event on NBNS response to a name query (Op) More...

__STATIC_INLINE void	EvrNetNBNS_WrongTransactionId (uint16_t if_id, uint16_t tid, uint16_t tid_valid)
	Event on NBNS client wrong transaction identifier (TID) received (Error) More...

__STATIC_INLINE void	EvrNetNBNS_ResolveInvalidParameter (uint16_t if_id)
	Event on NBNS resolve request with invalid parameter (Error) More...

__STATIC_INLINE void	EvrNetNBNS_ResolveNetBiosDisabled (uint16_t if_id)
	Event on NBNS resolve request with NetBIOS disabled (Error) More...

__STATIC_INLINE void	EvrNetNBNS_ResolveClientBusy (uint16_t if_id)
	Event on NBNS resolve request with client busy (Error) More...

__STATIC_INLINE void	EvrNetNBNS_Resolve (const char *host_name, uint32_t length)
	Event on NBNS resolve host requested (API) More...

__STATIC_INLINE void	EvrNetNBNS_ResolvedFromCache (uint16_t if_id, const uint8_t *ip4_addr)
	Event on NBNS address resolved from cache (Op) More...

__STATIC_INLINE void	EvrNetNBNS_ResolveTimeoutExpired (uint16_t if_id)
	Event on NBNS resolve request timeout expired (Error) More...

__STATIC_INLINE void	EvrNetNBNS_ResolvedAddress (uint16_t if_id, const uint8_t *ip4_addr)
	Event on NBNS address successfully resolved (Op) More...

__STATIC_INLINE void	EvrNetNBNS_ClearCacheInvalidParam (uint16_t if_id)
	Event on NBNS clear cache request with invalid parameter (Error) More...

__STATIC_INLINE void	EvrNetNBNS_ResolveRetransmit (uint16_t if_id)
	Event on NBNS resolve address retransmit (Op) More...

__STATIC_INLINE void	EvrNetNBNS_ClrCacheNetBiosDisabled (uint16_t if_id)
	Event on NBNS clear cache request with NetBIOS disabled (Error) More...

__STATIC_INLINE void	EvrNetNBNS_ClearCacheClientBusy (uint16_t if_id)
	Event on NBNS clear cache request with client busy (Error) More...

__STATIC_INLINE void	EvrNetNBNS_ClearCache (uint16_t if_id, uint32_t deleted, uint32_t available)
	Event on NBNS clear cache requested (API) More...

__STATIC_INLINE void	EvrNetNBNS_UninitService (uint16_t if_id)
	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

◆ EvrNetNBNS_ClearCache()

__STATIC_INLINE void EvrNetNBNS_ClearCache	(	uint16_t	if_id,
		uint32_t	deleted,
		uint32_t	available
	)

Event on NBNS clear cache requested (API)

Parameters

if_id	network interface identifier
deleted	number of entries deleted from cache
available	number of entries available in cache

The event ClearCache is created when the function netNBNS_ClearCache is executed.

Value in the Event Recorder shows:

netif: network interface identifier.
deleted: number of deleted cache entries.
max: maximum number of NBNS cache entries.

◆ EvrNetNBNS_ClearCacheClientBusy()

__STATIC_INLINE void EvrNetNBNS_ClearCacheClientBusy ( uint16_t if_id )

Event on NBNS clear cache request with client busy (Error)

Parameters

if_id network interface identifier

The event ClearCacheClientBusy is created when the function netNBNS_ClearCache is executed, and the internal resolve process is still in progress. For example, another instance of netNBNS_Resolve is still running and has not yet completed.

Value in the Event Recorder shows:

netif: network interface identifier.

◆ EvrNetNBNS_ClearCacheInvalidParam()

__STATIC_INLINE void EvrNetNBNS_ClearCacheInvalidParam ( uint16_t if_id )

Event on NBNS clear cache request with invalid parameter (Error)

Parameters

if_id network interface identifier

The event ClearCacheInvalidParam is created when the function netNBNS_ClearCache is executed, and the function input parameter is invalid.

Value in the Event Recorder shows:

netif: network interface identifier.

◆ EvrNetNBNS_ClrCacheNetBiosDisabled()

__STATIC_INLINE void EvrNetNBNS_ClrCacheNetBiosDisabled ( uint16_t if_id )

Event on NBNS clear cache request with NetBIOS disabled (Error)

Parameters

if_id network interface identifier

The event ClrCacheNetBiosDisabled is created when when the function netNBNS_ClearCache is executed, but NetBIOS protocol is disabled for this interface.

Value in the Event Recorder shows:

netif: network interface identifier.

◆ EvrNetNBNS_FrameTooShort()

__STATIC_INLINE void EvrNetNBNS_FrameTooShort	(	uint16_t	if_id,
		uint32_t	length,
		uint32_t	min_length
	)

Event on NBNS receive frame is too short (Error)

Parameters

if_id	network interface identifier
length	frame length in bytes
min_length	minimum 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:

netif: network interface identifier.
len: length of the received frame in bytes.
min: minimum valid frame length in bytes.

◆ EvrNetNBNS_GetSocketFailed()

__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. To resolve this error, you must increase the number of available UDP sockets in the UDP socket configuration.

Value in the Event Recorder shows:

error

◆ EvrNetNBNS_InitService()

__STATIC_INLINE void EvrNetNBNS_InitService ( uint16_t if_id )

Event on NBNS name service initialize (Op)

Parameters

if_id network interface identifier

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:

netif: network interface identifier.

◆ EvrNetNBNS_NameQueryRequest()

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

Event on NBNS name query request received (Op)

Parameters

q_name	pointer to a question name string
length	length 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.

◆ EvrNetNBNS_NameQueryResponse()

__STATIC_INLINE void EvrNetNBNS_NameQueryResponse	(	uint16_t	if_id,
		const uint8_t *	ip4_addr
	)

Event on NBNS response to a name query (Op)

Parameters

if_id	network interface identifier
ip4_addr	pointer 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:

netif: network interface identifier.
addr: local IP address.

◆ EvrNetNBNS_NetBiosDisabled()

__STATIC_INLINE void EvrNetNBNS_NetBiosDisabled ( uint16_t if_id )

Event on NBNS receive frame for NetBIOS disabled (Op)

Parameters

if_id network interface identifier

The event NetBiosDisabled is created when the network library receives the NBNS frame, but NetBIOS protocol is disabled in the interface configuration.

Value in the Event Recorder shows:

netif: network interface identifier.

◆ EvrNetNBNS_QueryFromAddress()

__STATIC_INLINE void EvrNetNBNS_QueryFromAddress	(	uint16_t	if_id,
		const uint8_t *	ip4_addr
	)

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

Parameters

if_id	network interface identifier
ip4_addr	pointer 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:

netif: network interface identifier.
addr: IP address of the sender.

◆ EvrNetNBNS_ReceiveFrame()

__STATIC_INLINE void EvrNetNBNS_ReceiveFrame	(	uint16_t	if_id,
		uint32_t	length
	)

Event on NBNS receive frame (Op)

Parameters

if_id	network interface identifier
length	frame length in bytes

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

Value in the Event Recorder shows:

netif: network interface identifier.
len: length of the received frame in bytes.

◆ EvrNetNBNS_Resolve()

__STATIC_INLINE void EvrNetNBNS_Resolve	(	const char *	host_name,
		uint32_t	length
	)

Event on NBNS resolve host requested (API)

Parameters

host_name	name of the host to resolve
length	length of the host_name string

The event Resolve is created when the NBNS host name resolver starts, that is, when the function netNBNS_Resolve is executed.

Value in the Event Recorder shows:

name: name of the host to resolve.

◆ EvrNetNBNS_ResolveClientBusy()

__STATIC_INLINE void EvrNetNBNS_ResolveClientBusy ( uint16_t if_id )

Event on NBNS resolve request with client busy (Error)

Parameters

if_id network interface identifier

The event ResolveClientBusy is created when the function netNBNS_Resolve is executed, and the internal resolve process is still in progress. For example, another instance of netNBNS_Resolve is still running and has not yet completed.

Value in the Event Recorder shows:

netif: network interface identifier.

◆ EvrNetNBNS_ResolvedAddress()

__STATIC_INLINE void EvrNetNBNS_ResolvedAddress	(	uint16_t	if_id,
		const uint8_t *	ip4_addr
	)

Event on NBNS address successfully resolved (Op)

Parameters

if_id	network interface identifier
ip4_addr	pointer to IP address

The event ResolvedAddress is created when an NBNS client successfully resolves a requested host on the local network.

Value in the Event Recorder shows:

netif: network interface identifier.
addr: resolved IP address of the host.

◆ EvrNetNBNS_ResolvedFromCache()

__STATIC_INLINE void EvrNetNBNS_ResolvedFromCache	(	uint16_t	if_id,
		const uint8_t *	ip4_addr
	)

Event on NBNS address resolved from cache (Op)

Parameters

if_id	network interface identifier
ip4_addr	pointer to IP address

The event ResolvedFromCache is created when the NBNS client has resolved the requested host name internally from the NBNS name cache.

Value in the Event Recorder shows:

netif: network interface identifier.
addr: resolved IP address of the host.

◆ EvrNetNBNS_ResolveInvalidParameter()

__STATIC_INLINE void EvrNetNBNS_ResolveInvalidParameter ( uint16_t if_id )

Event on NBNS resolve request with invalid parameter (Error)

Parameters

if_id network interface identifier

The event ResolveInvalidParameter is created when the function netNBNS_Resolve is executed, and the function input parameter is invalid.

Value in the Event Recorder shows:

netif: network interface identifier.

◆ EvrNetNBNS_ResolveNetBiosDisabled()

__STATIC_INLINE void EvrNetNBNS_ResolveNetBiosDisabled ( uint16_t if_id )

Event on NBNS resolve request with NetBIOS disabled (Error)

Parameters

if_id network interface identifier

The event ResolveNetBiosDisabled is created when when the function netNBNS_Resolve is executed, but NetBIOS protocol is disabled for this interface.

Value in the Event Recorder shows:

netif: network interface identifier.

◆ EvrNetNBNS_ResolveRetransmit()

__STATIC_INLINE void EvrNetNBNS_ResolveRetransmit ( uint16_t if_id )

Event on NBNS resolve address retransmit (Op)

Parameters

if_id network interface identifier

The event ResolveRetransmit is created when the network library resends the NBNS name query request.

Value in the Event Recorder shows:

netif: network interface identifier.

◆ EvrNetNBNS_ResolveTimeoutExpired()

__STATIC_INLINE void EvrNetNBNS_ResolveTimeoutExpired ( uint16_t if_id )

Event on NBNS resolve request timeout expired (Error)

Parameters

if_id network interface identifier

The event ResolveTimeoutExpired is created when the network library has left the name resolving procedure, since no host responded.

Value in the Event Recorder shows:

netif: network interface identifier.

◆ EvrNetNBNS_UninitService()

__STATIC_INLINE void EvrNetNBNS_UninitService ( uint16_t if_id )

Event on NBNS name service de-initialize (Op)

Parameters

if_id network interface identifier

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

Value in the Event Recorder shows:

netif: network interface identifier.

◆ EvrNetNBNS_WrongRemotePort()

__STATIC_INLINE void EvrNetNBNS_WrongRemotePort	(	uint16_t	if_id,
		uint16_t	port,
		uint16_t	port_valid
	)

Event on NBNS wrong remote UDP port (Error)

Parameters

if_id	network interface identifier
port	received remote port number
port_valid	valid remote port number

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

Value in the Event Recorder shows:

netif: network interface identifier.
port: received remote UDP port.
valid: expected remote UDP port.

◆ EvrNetNBNS_WrongTransactionId()

__STATIC_INLINE void EvrNetNBNS_WrongTransactionId	(	uint16_t	if_id,
		uint16_t	tid,
		uint16_t	tid_valid
	)

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

Parameters

if_id	network interface identifier
tid	received transaction identifier
tid_valid	valid transaction identifier

The event WrongTransactionId is created when the network library receives the NBNS response frame, but the received transaction identifier (TID) is not identical to the transaction identifier of our NBNS name query request. The frame is therefore discarded.

Value in the Event Recorder shows:

netif: network interface identifier.
tid: received transaction identifier.
valid: expected transaction identifier.

Functions

Description

Function Documentation

◆ EvrNetNBNS_ClearCache()

◆ EvrNetNBNS_ClearCacheClientBusy()

◆ EvrNetNBNS_ClearCacheInvalidParam()

◆ EvrNetNBNS_ClrCacheNetBiosDisabled()

◆ EvrNetNBNS_FrameTooShort()

◆ EvrNetNBNS_GetSocketFailed()

◆ EvrNetNBNS_InitService()

◆ EvrNetNBNS_NameQueryRequest()

◆ EvrNetNBNS_NameQueryResponse()

◆ EvrNetNBNS_NetBiosDisabled()

◆ EvrNetNBNS_QueryFromAddress()

◆ EvrNetNBNS_ReceiveFrame()

◆ EvrNetNBNS_Resolve()

◆ EvrNetNBNS_ResolveClientBusy()

◆ EvrNetNBNS_ResolvedAddress()

◆ EvrNetNBNS_ResolvedFromCache()

◆ EvrNetNBNS_ResolveInvalidParameter()

◆ EvrNetNBNS_ResolveNetBiosDisabled()

◆ EvrNetNBNS_ResolveRetransmit()

◆ EvrNetNBNS_ResolveTimeoutExpired()

◆ EvrNetNBNS_UninitService()

◆ EvrNetNBNS_WrongRemotePort()

◆ EvrNetNBNS_WrongTransactionId()