Provides Network Management functions. More...

Topics
	Referred Types
	Network Management related types.

Data Structures
struct	Ucs_Network_InitData_t
	The network section of the UNICENS initialization data. More...

struct	Ucs_Network_AliveStatus_t
	Type of the AliveMessage.AliveStatus values. More...

Callback Functions
typedef void(*	Ucs_Network_StatusCb_t )(uint16_t change_mask, uint16_t events, Ucs_Network_Availability_t availability, Ucs_Network_AvailInfo_t avail_info, Ucs_Network_AvailTransCause_t avail_trans_cause, uint16_t node_address, uint8_t max_position, uint16_t packet_bw, void *user_ptr)
	Function signature used for the Network Status callback function.

typedef void(*	Ucs_Network_AliveCb_t )(Ucs_Network_AliveStatus_t result_ptr, void user_ptr)
	Report function for Alive Status message.

typedef void(*	Ucs_Network_FrameCounterCb_t )(uint32_t reference, uint32_t frame_counter, bool frame_lock, Ucs_StdResult_t result, void *user_ptr)
	Function signature of result callback used by Ucs_Network_GetFrameCounter().

Enumerations
enum	Ucs_Welcomed_t { UCS_NOT_WELCOMED = 0x0U, UCS_WELCOMED = 0x1U }
	Type of the AliveMessage.AliveStatus.Welcomed value. More...

Functions
Ucs_Return_t	Ucs_Network_GetFrameCounter (Ucs_Inst_t *self, uint32_t reference, Ucs_Network_FrameCounterCb_t result_fptr)
	Retrieves the Network Frame Counter, which is the number of frames since reset.

Ucs_Return_t	Ucs_Network_GetNodesCount (Ucs_Inst_t self, uint8_t count_ptr)
	Retrieves the number of nodes within the network.

Ucs_Return_t	Ucs_Network_SetPacketFilterMode (Ucs_Inst_t *self, uint16_t node_address, uint16_t mode, Ucs_StdNodeResultCb_t result_fptr)
	Sets the packet filter mode of an available node.

Ucs_Return_t	Ucs_Network_RegisterAliveCb (Ucs_Inst_t *self, Ucs_Network_AliveCb_t report_fptr)
	Registers the alive message callback function.

void	Ucs_Network_UnRegisterAliveCb (Ucs_Inst_t *self)
	Unregisters the alive message callback function.

Detailed Description

Provides Network Management functions.

Topics