User Callback

Function to notify the user application of critical errors in the network core. More...

Functions
void	netHandleError (netErrorCode error)
	Handle Network Component critical error. [user-provided].

Description

Function to notify the user application of critical errors in the network core.

After a critical error, normal operation of the network component is not possible. The function netHandleError reports a critical error. The network component provides a weak implementation of this function, but you can supply your own implementation to replace the default one from the library.

Function Documentation

netHandleError()

void netHandleError ( netErrorCode error )

extern

Handle Network Component critical error. [user-provided].

Parameters

[in]

error

system error code.

The netHandleError callback function serves as a critical error handler. It is invoked when the system encounters an unrecoverable error. In such cases, the typical response is to restart the network component.

The argument error specifies the type of error that caused the function to be called.

Note

For recovery, the error is typically stored in a global variable, while cleanup and restart are handled asynchronously by another thread. This involves deinitializing the network component and its associated drivers, followed by reinitialization.

Code Example

void netHandleError (netErrorCode error) {
  switch (error) {
    case netErrorMemAlloc:
      /* Out of memory */
      break;
    case netErrorMemFree:
      /* Trying to release non existing memory block */
      break;
    case netErrorMemCorrupt:
      /* Memory Link pointer corrupted */
      /* More data written than the size of allocated memory block */
      break;
    case netErrorConfig:
      /* Network configuration error found */
      break;
    case netErrorRtosCreate:
      /* RTOS object creation failed (thread, semaphore, mutex) */
      break;
    case netErrorUdpAlloc:
      /* Out of UDP Sockets */
      break;
    case netErrorTcpAlloc:
      /* Out of TCP Sockets */
      break;
    case netErrorTcpState:
      /* TCP State machine in undefined state */
      break;
  }
  while (1);
}