Provides mechanism to recieve feedback about changes to libIntegra's state. More...

#include "api/notification_sink.h"

Inheritance diagram for integra_api::INotificationSink:

Public Member Functions
virtual void	on_set_command (const IServer &server, const CPath &endpoint_path, const CCommandSource &source)=0
	Callback invoked when Control Endpoints are set. More...

Detailed Description

Provides mechanism to recieve feedback about changes to libIntegra's state.

In order to receive feedback from libIntegra, the caller can subclass INotificationSink, and pass the subclass into IntegraSession via CServerStartupInfo.

Note: libIntegra may call into this notification sink from many different threads, although it will only use it when the server is locked (so it never call into it from multiple threads simultaneously). If the user is developing a single-threaded gui application, they may wish to use the helper class CPollingNotificationSink, instead of using INotificationSink directly.

Member Function Documentation

virtual void integra_api::INotificationSink::on_set_command	(	const IServer &	server,
		const CPath &	endpoint_path,
		const CCommandSource &	source
	)

pure virtual

Callback invoked when Control Endpoints are set.

Override this method to receive notifications /note 'set' is the only command for which notifications are provided. This is because none of the other commands originate from within libIntegra - they always come from the user of the api. There's no need to inform the user of the api about something which they initiated in the first place.

The documentation for this class was generated from the following file:

/Users/jamie/Documents/IntegraLive/libIntegra/api/notification_sink.h

Public Member Functions

Detailed Description

Member Function Documentation