Notification handler for the CHAI. More...

Public Member Functions
virtual void	OnCHAI_Notification (CPNS::ICHAI *const pCHAI, CPNS::Enums::CHAINotificationTypes const notification, CPNS::Endpoint const &optionalEndpoint)=0
	Used by the CHAI to notify the application about global network changes. More...

virtual void	OnCHAI_DeviceDeclaration (CPNS::ICHAI const pCHAI, CPNS::Enums::DeviceDeclarationNotificationTypes const declarationType, CPNS::IRemoteDevice const pRemDev)
	Called on device declaration. More...

virtual void	OnCHAI_DeviceDiscarded (CPNS::ICHAI *const pCHAI, CPNS::DeviceID const &devID, CPNS::Enums::DeviceDiscardedReasons const reason)
	Called on device unplug, or if a device becomes unreachable. More...

virtual void	OnCHAI_DeviceIdentityChanged (CPNS::ICHAI *const pCHAI, CPNS::DeviceID const &oldDeviceID, CPNS::DeviceID const &newDeviceID)
	Inform the application that a device identity changed. More...

virtual void	OnCHAI_Warning (CPNS::ICHAI const pCHAI, CPNS::Endpoint const &optionalSource, CPNS::CombinedWarningCodes const code, CPNS::Enums::WarningDomains const domain, CPNS::char8 const const utf8Title, CPNS::char8 const *const utf8Content)
	The CHAI received a warning message and forward it to the application. More...

Detailed Description

Notification handler for the CHAI.

See Also: ICHAI::RegisterNotificationHandler

Member Function Documentation

virtual void CPNS::ICHAI_NotificationHandler::OnCHAI_DeviceDeclaration	(	CPNS::ICHAI *const	pCHAI,
		CPNS::Enums::DeviceDeclarationNotificationTypes const	declarationType,
		CPNS::IRemoteDevice *const	pRemDev
	)

inlinevirtual

Called on device declaration.

Can occur if a new root device is connected to the network, if a device needs to reflect changes (capabilities, name...). By default, this is not called for CHAI devices (BrandID 0x0001 and ModelID 0x0001). Use CPNS::ICHAI::SetCHAIDeviceFiltering to enable CHAI devices related notification.

Remarks: This call is performed only for root devices (having null ModuleID)

Parameters

[in]	pCHAI	Pointer to the CHAI object
[in]	declarationType	Type of declaration
[in]	pRemDev	Remote device

virtual void CPNS::ICHAI_NotificationHandler::OnCHAI_DeviceDiscarded	(	CPNS::ICHAI *const	pCHAI,
		CPNS::DeviceID const &	devID,
		CPNS::Enums::DeviceDiscardedReasons const	reason
	)

inlinevirtual

Called on device unplug, or if a device becomes unreachable.

By default, this is not called for CHAI devices (BrandID 0x0001 and ModelID 0x0001). Use CPNS::ICHAI::SetCHAIDeviceFiltering to enable CHAI devices related notification.

Parameters

[in]	pCHAI	Pointer to the CHAI object
[in]	devID	Device ID
[in]	reason	Reason of discarding the device

virtual void CPNS::ICHAI_NotificationHandler::OnCHAI_DeviceIdentityChanged	(	CPNS::ICHAI *const	pCHAI,
		CPNS::DeviceID const &	oldDeviceID,
		CPNS::DeviceID const &	newDeviceID
	)

inlinevirtual

Inform the application that a device identity changed.

This call is performed after the CHAI has automatically updated all related IRemoteDevice objects. By default, this is not called for CHAI devices (BrandID 0x0001 and ModelID 0x0001). Use CPNS::ICHAI::SetCHAIDeviceFiltering to enable CHAI devices related notification.

Remarks: This call is performed only for root devices (having null ModuleID)

Parameters

[in]	pCHAI	Pointer to the CHAI object
[in]	oldDeviceID	Former Device ID
[in]	newDeviceID	New Device ID

virtual void CPNS::ICHAI_NotificationHandler::OnCHAI_Notification	(	CPNS::ICHAI *const	pCHAI,
		CPNS::Enums::CHAINotificationTypes const	notification,
		CPNS::Endpoint const &	optionalEndpoint
	)

pure virtual

Used by the CHAI to notify the application about global network changes.

Parameters

[in]	pCHAI	Pointer to the CHAI object
[in]	notification	Notification type
[in]	optionalEndpoint	Optional endpoint depending on the notification type

virtual void CPNS::ICHAI_NotificationHandler::OnCHAI_Warning	(	CPNS::ICHAI *const	pCHAI,
		CPNS::Endpoint const &	optionalSource,
		CPNS::CombinedWarningCodes const	code,
		CPNS::Enums::WarningDomains const	domain,
		CPNS::char8 const *const	utf8Title,
		CPNS::char8 const *const	utf8Content
	)

inlinevirtual

The CHAI received a warning message and forward it to the application.

Parameters

[in]	pCHAI	Pointer to the CHAI object
[in]	optionalSource	Source of the warning message, if available
[in]	code	Warning code
[in]	domain	Warning domain
[in]	utf8Title	Title of the warning
[in]	utf8Content	Additional content

Public Member Functions

Detailed Description

Member Function Documentation