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) | |
__STATIC_INLINE void | EvrNetNBNS_GetSocketFailed (void) |
Event on NBNS failed to allocate UDP socket (Error) | |
__STATIC_INLINE void | EvrNetNBNS_ReceiveFrame (uint16_t if_id, uint32_t length) |
Event on NBNS receive frame (Op) | |
__STATIC_INLINE void | EvrNetNBNS_WrongRemotePort (uint16_t if_id, uint16_t port, uint16_t port_valid) |
Event on NBNS wrong remote UDP port (Error) | |
__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) | |
__STATIC_INLINE void | EvrNetNBNS_NetBiosDisabled (uint16_t if_id) |
Event on NBNS receive frame for NetBIOS disabled (Op) | |
__STATIC_INLINE void | EvrNetNBNS_NameQueryRequest (const char *q_name, uint32_t length) |
Event on NBNS name query request received (Op) | |
__STATIC_INLINE void | EvrNetNBNS_QueryFromAddress (uint16_t if_id, const uint8_t *ip4_addr) |
Event on NBNS name query from IP-address (Detail) | |
__STATIC_INLINE void | EvrNetNBNS_NameQueryResponse (uint16_t if_id, const uint8_t *ip4_addr) |
Event on NBNS response to a name query (Op) | |
__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) | |
__STATIC_INLINE void | EvrNetNBNS_ResolveInvalidParameter (uint16_t if_id) |
Event on NBNS resolve request with invalid parameter (Error) | |
__STATIC_INLINE void | EvrNetNBNS_ResolveNetBiosDisabled (uint16_t if_id) |
Event on NBNS resolve request with NetBIOS disabled (Error) | |
__STATIC_INLINE void | EvrNetNBNS_ResolveClientBusy (uint16_t if_id) |
Event on NBNS resolve request with client busy (Error) | |
__STATIC_INLINE void | EvrNetNBNS_Resolve (const char *host_name, uint32_t length) |
Event on NBNS resolve host requested (API) | |
__STATIC_INLINE void | EvrNetNBNS_ResolvedFromCache (uint16_t if_id, const uint8_t *ip4_addr) |
Event on NBNS address resolved from cache (Op) | |
__STATIC_INLINE void | EvrNetNBNS_ResolveTimeoutExpired (uint16_t if_id) |
Event on NBNS resolve request timeout expired (Error) | |
__STATIC_INLINE void | EvrNetNBNS_ResolvedAddress (uint16_t if_id, const uint8_t *ip4_addr) |
Event on NBNS address successfully resolved (Op) | |
__STATIC_INLINE void | EvrNetNBNS_ClearCacheInvalidParam (uint16_t if_id) |
Event on NBNS clear cache request with invalid parameter (Error) | |
__STATIC_INLINE void | EvrNetNBNS_ResolveRetransmit (uint16_t if_id) |
Event on NBNS resolve address retransmit (Op) | |
__STATIC_INLINE void | EvrNetNBNS_ClrCacheNetBiosDisabled (uint16_t if_id) |
Event on NBNS clear cache request with NetBIOS disabled (Error) | |
__STATIC_INLINE void | EvrNetNBNS_ClearCacheClientBusy (uint16_t if_id) |
Event on NBNS clear cache request with client busy (Error) | |
__STATIC_INLINE void | EvrNetNBNS_ClearCache (uint16_t if_id, uint32_t deleted, uint32_t available) |
Event on NBNS clear cache requested (API) | |
__STATIC_INLINE void | EvrNetNBNS_UninitService (uint16_t if_id) |
Event on NBNS name service de-initialize (Op) | |
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.
__STATIC_INLINE void EvrNetNBNS_ClearCache | ( | uint16_t | if_id, |
uint32_t | deleted, | ||
uint32_t | available | ||
) |
Event on NBNS clear cache requested (API)
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:
__STATIC_INLINE void EvrNetNBNS_ClearCacheClientBusy | ( | uint16_t | if_id | ) |
Event on NBNS clear cache request with client busy (Error)
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:
__STATIC_INLINE void EvrNetNBNS_ClearCacheInvalidParam | ( | uint16_t | if_id | ) |
Event on NBNS clear cache request with invalid parameter (Error)
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:
__STATIC_INLINE void EvrNetNBNS_ClrCacheNetBiosDisabled | ( | uint16_t | if_id | ) |
Event on NBNS clear cache request with NetBIOS disabled (Error)
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:
__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)
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:
__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:
__STATIC_INLINE void EvrNetNBNS_InitService | ( | uint16_t | if_id | ) |
Event on NBNS name service initialize (Op)
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:
__STATIC_INLINE void EvrNetNBNS_NameQueryRequest | ( | const char * | q_name, |
uint32_t | length | ||
) |
Event on NBNS name query request received (Op)
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:
__STATIC_INLINE void EvrNetNBNS_NameQueryResponse | ( | uint16_t | if_id, |
const uint8_t * | ip4_addr | ||
) |
Event on NBNS response to a name query (Op)
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:
__STATIC_INLINE void EvrNetNBNS_NetBiosDisabled | ( | uint16_t | if_id | ) |
Event on NBNS receive frame for NetBIOS disabled (Op)
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:
__STATIC_INLINE void EvrNetNBNS_QueryFromAddress | ( | uint16_t | if_id, |
const uint8_t * | ip4_addr | ||
) |
Event on NBNS name query from IP-address (Detail)
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:
__STATIC_INLINE void EvrNetNBNS_ReceiveFrame | ( | uint16_t | if_id, |
uint32_t | length | ||
) |
Event on NBNS receive frame (Op)
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:
__STATIC_INLINE void EvrNetNBNS_Resolve | ( | const char * | host_name, |
uint32_t | length | ||
) |
Event on NBNS resolve host requested (API)
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:
__STATIC_INLINE void EvrNetNBNS_ResolveClientBusy | ( | uint16_t | if_id | ) |
Event on NBNS resolve request with client busy (Error)
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:
__STATIC_INLINE void EvrNetNBNS_ResolvedAddress | ( | uint16_t | if_id, |
const uint8_t * | ip4_addr | ||
) |
Event on NBNS address successfully resolved (Op)
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:
__STATIC_INLINE void EvrNetNBNS_ResolvedFromCache | ( | uint16_t | if_id, |
const uint8_t * | ip4_addr | ||
) |
Event on NBNS address resolved from cache (Op)
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:
__STATIC_INLINE void EvrNetNBNS_ResolveInvalidParameter | ( | uint16_t | if_id | ) |
Event on NBNS resolve request with invalid parameter (Error)
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:
__STATIC_INLINE void EvrNetNBNS_ResolveNetBiosDisabled | ( | uint16_t | if_id | ) |
Event on NBNS resolve request with NetBIOS disabled (Error)
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:
__STATIC_INLINE void EvrNetNBNS_ResolveRetransmit | ( | uint16_t | if_id | ) |
Event on NBNS resolve address retransmit (Op)
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:
__STATIC_INLINE void EvrNetNBNS_ResolveTimeoutExpired | ( | uint16_t | if_id | ) |
Event on NBNS resolve request timeout expired (Error)
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:
__STATIC_INLINE void EvrNetNBNS_UninitService | ( | uint16_t | if_id | ) |
Event on NBNS name service de-initialize (Op)
if_id | network interface identifier |
The event UninitService is created when the function netUninitialize is executed.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetNBNS_WrongRemotePort | ( | uint16_t | if_id, |
uint16_t | port, | ||
uint16_t | port_valid | ||
) |
Event on NBNS wrong remote UDP port (Error)
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:
__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)
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: