NetSYS: System Core

Events generated by the Network - System Core functions. More...

Functions
__STATIC_INLINE void	EvrNetSYS_InitSystem (uint32_t lib_version)
	Event on network initialize start (Op) More...
__STATIC_INLINE void	EvrNetSYS_ThreadCreateFailed (void)
	Event on failure to create network core thread (Error) More...
__STATIC_INLINE void	EvrNetSYS_TimerCreateFailed (void)
	Event on failure to create network interval timer (Error) More...
__STATIC_INLINE void	EvrNetSYS_InitComplete (void)
	Event on network initialize complete (Op) More...
__STATIC_INLINE void	EvrNetSYS_GetOption (uint16_t if_id, int32_t option)
	Event on get interface option (API) More...
__STATIC_INLINE void	EvrNetSYS_SetOption (uint16_t if_id, int32_t option)
	Event on set interface option (API) More...
__STATIC_INLINE void	EvrNetSYS_SetDefault (uint16_t if_id, int32_t ip_version)
	Event on set default interface (API) More...
__STATIC_INLINE void	EvrNetSYS_SetHostName (const char *name, uint32_t length)
	Event on set local host name (API) More...
__STATIC_INLINE void	EvrNetSYS_UninitSystem (void)
	Event on network uninitialize start (Op) More...
__STATIC_INLINE void	EvrNetSYS_UninitComplete (void)
	Event on network uninitialize complete (Op) More...

Description

Events generated by the Network - System Core functions.

The Network System Core functions generate events that inform about the general system events and help in troubleshooting.

Function Documentation

EvrNetSYS_GetOption()

__STATIC_INLINE void EvrNetSYS_GetOption	(	uint16_t	if_id,
		int32_t	option
	)

Event on get interface option (API)

Parameters

if_id	network interface identifier
option	interface option to get

The event GetOption is created when the function netIF_GetOption is executed.

Value in the Event Recorder shows:

• netif: interface identification (ETH0, ETH1, WiFi0, WiFi1, PPP, SLIP).
• opt: interface option to get as specified in netIF_Option.

EvrNetSYS_InitComplete()

__STATIC_INLINE void EvrNetSYS_InitComplete

(

void

)

Event on network initialize complete (Op)

The event InitComplete is created when the function netInitialize successfully initialized the Network component.

EvrNetSYS_InitSystem()

__STATIC_INLINE void EvrNetSYS_InitSystem

(

uint32_t

lib_version

)

Event on network initialize start (Op)

Parameters

lib_version

encoded library version BCD (MMmmbbbb) MM: Major mm: minor bbbb: build

The event InitSystem is created when the function netInitialize is executed.

Value in the Event Recorder shows:

• ver: library version of the Network component (major.minor.build).

EvrNetSYS_SetDefault()

__STATIC_INLINE void EvrNetSYS_SetDefault	(	uint16_t	if_id,
		int32_t	ip_version
	)

Event on set default interface (API)

Parameters

if_id	network interface identifier
ip_version	internet protocol version to use

The event SetDefault is created when the function netIF_SetDefault is executed.

Value in the Event Recorder shows:

• netif: interface identification (ETH0, ETH1, WiFi0, WiFi1, PPP, SLIP).
• ver: IP version used (IPv4, IPv6).

EvrNetSYS_SetHostName()

__STATIC_INLINE void EvrNetSYS_SetHostName	(	const char *	name,
		uint32_t	length
	)

Event on set local host name (API)

Parameters

name	pointer to host name string
length	length of host name string

The event SetHostName is created when the function netSYS_SetHostName is executed.

Value in the Event Recorder shows:

• name: local host name that has been set.

EvrNetSYS_SetOption()

__STATIC_INLINE void EvrNetSYS_SetOption	(	uint16_t	if_id,
		int32_t	option
	)

Event on set interface option (API)

Parameters

if_id	network interface identifier
option	interface option to set

The event SetOption is created when the function netIF_SetOption is executed.

Value in the Event Recorder shows:

• netif: interface identification (ETH0, ETH1, WiFi0, WiFi1, PPP, SLIP).
• opt: interface option to set as specified in netIF_Option.

EvrNetSYS_ThreadCreateFailed()

__STATIC_INLINE void EvrNetSYS_ThreadCreateFailed

(

void

)

Event on failure to create network core thread (Error)

The event ThreadCreateFailed is generated, if the function netInitialize failed to create the Network Core thread.

Value in the Event Recorder shows:

• thread: netCore_Thread.

EvrNetSYS_TimerCreateFailed()

__STATIC_INLINE void EvrNetSYS_TimerCreateFailed

(

void

)

Event on failure to create network interval timer (Error)

The event TimerCreateFailed is generated, if the function netInitialize failed to create the Network Tick timer.

Value in the Event Recorder shows:

• timer: net_tick.

EvrNetSYS_UninitComplete()

__STATIC_INLINE void EvrNetSYS_UninitComplete

(

void

)

Event on network uninitialize complete (Op)

The event UninitComplete is created when the function netUninitialize successfully de-initialized the Network component.

EvrNetSYS_UninitSystem()

__STATIC_INLINE void EvrNetSYS_UninitSystem

(

void

)

Event on network uninitialize start (Op)

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