#include <IKaaClient.hpp>

Inheritance diagram for kaa::IKaaClient:

Public Member Functions
virtual void	start ()=0
	Starts Kaa's workflow. More...

virtual void	stop ()=0
	Stops Kaa's workflow. More...

virtual void	pause ()=0
	Pauses Kaa's workflow. More...

virtual void	resume ()=0
	Resumes Kaa's workflow. More...

virtual void	setProfileContainer (IProfileContainerPtr container)=0
	Sets profile container implemented by the user. More...

virtual void	updateProfile ()=0
	Notifies server about profile changes. More...

virtual EventFamilyFactory &	getEventFamilyFactory ()=0

virtual void	addTopicListListener (INotificationTopicListListener &listener)=0
	Adds the listener which receives updates on the list of available topics. More...

virtual void	removeTopicListListener (INotificationTopicListListener &listener)=0
	Removes listener which receives updates on the list of available topics. More...

virtual Topics	getTopics ()=0
	Retrieves the list of available topics. More...

virtual void	addNotificationListener (INotificationListener &listener)=0
	Adds the listener which receives notifications on all available topics. More...

virtual void	addNotificationListener (std::int64_t topicId, INotificationListener &listener)=0
	Adds the listener which receives notifications on the specified topic. More...

virtual void	removeNotificationListener (INotificationListener &listener)=0
	Removes the listener which receives notifications on all available topics. More...

virtual void	removeNotificationListener (std::int64_t topicId, INotificationListener &listener)=0
	Removes the listener which receives notifications on the specified topic. More...

virtual void	subscribeToTopic (std::int64_t id, bool forceSync=true)=0
	Subscribes to the specified optional topic to receive notifications on that topic. More...

virtual void	subscribeToTopics (const std::list< std::int64_t > &idList, bool forceSync=true)=0
	Subscribes to the specified list of optional topics to receive notifications on those topics. More...

virtual void	unsubscribeFromTopic (std::int64_t id, bool forceSync=true)=0
	Unsubscribes from the specified optional topic to stop receiving notifications on that topic. More...

virtual void	unsubscribeFromTopics (const std::list< std::int64_t > &idList, bool forceSync=true)=0
	Unsubscribes from the specified list of optional topics to stop receiving notifications on those topics. More...

virtual void	syncTopicSubscriptions ()=0
	Sends subscription request(s) to the Operations server. More...

virtual void	addConfigurationListener (IConfigurationReceiver &receiver)=0

virtual void	removeConfigurationListener (IConfigurationReceiver &receiver)=0

virtual const KaaRootConfiguration &	getConfiguration ()=0

virtual void	setConfigurationStorage (IConfigurationStoragePtr storage)=0

virtual void	attachEndpoint (const std::string &endpointAccessToken, IAttachEndpointCallbackPtr listener=IAttachEndpointCallbackPtr())=0
	Attaches the specified endpoint to the user to which the current endpoint is attached. More...

virtual void	detachEndpoint (const std::string &endpointKeyHash, IDetachEndpointCallbackPtr listener=IDetachEndpointCallbackPtr())=0
	Detaches the specified endpoint from the user to which the current endpoint is attached. More...

virtual void	attachUser (const std::string &userExternalId, const std::string &userAccessToken, IUserAttachCallbackPtr listener=IUserAttachCallbackPtr())=0
	Attaches the current endpoint to the specifier user. The user verification is carried out by the default verifier. More...

virtual void	attachUser (const std::string &userExternalId, const std::string &userAccessToken, const std::string &userVerifierToken, IUserAttachCallbackPtr listener=IUserAttachCallbackPtr())=0

virtual void	setAttachStatusListener (IAttachStatusListenerPtr listener)=0
	Sets listener to notify of the current endpoint is attached/detached by another one. More...

virtual bool	isAttachedToUser ()=0
	Checks if the current endpoint is already attached to some user. More...

virtual std::int32_t	findEventListeners (const std::list< std::string > &eventFQNs, IFetchEventListenersPtr listener)=0
	Submits an event listeners resolution request. More...

virtual RecordFuture	addLogRecord (const KaaUserLogRecord &record)=0
	Adds a new log record to the log storage. More...

virtual void	setLogDeliveryListener (ILogDeliveryListenerPtr listener)=0
	Set a listener which receives a delivery status of each log bucket. More...

virtual void	setLogStorage (ILogStoragePtr storage)=0
	Sets the new log storage. More...

virtual void	setLogUploadStrategy (ILogUploadStrategyPtr strategy)=0
	Sets the new log upload strategy. More...

virtual void	setFailoverStrategy (IFailoverStrategyPtr strategy)=0

virtual IKaaChannelManager &	getChannelManager ()=0
	Retrieves the Channel Manager. More...

virtual const KeyPair &	getClientKeyPair ()=0
	Retrieves the client's public and private key. More...

virtual void	setEndpointAccessToken (const std::string &token)=0
	Set new access token for a current endpoint. More...

virtual std::string	refreshEndpointAccessToken ()=0
	Generate new access token for a current endpoint. More...

virtual std::string	getEndpointAccessToken () const =0
	Retrieve an access token for a current endpoint. More...

virtual std::string	getEndpointKeyHash () const =0

virtual IKaaDataMultiplexer &	getOperationMultiplexer ()=0
	Retrieves Kaa operations data multiplexer. More...

virtual IKaaDataDemultiplexer &	getOperationDemultiplexer ()=0
	Retrieves Kaa operations data demultiplexer. More...

virtual IKaaDataMultiplexer &	getBootstrapMultiplexer ()=0
	Retrieves Kaa bootstrap data multiplexer. More...

virtual IKaaDataDemultiplexer &	getBootstrapDemultiplexer ()=0
	Retrieves Kaa bootstrap data demultiplexer. More...

virtual IKaaClientContext &	getKaaClientContext ()=0
	Retrieves Kaa context data. More...

virtual	~IKaaClient ()

Detailed Description

Interface for the Kaa client.

Base interface to operate with Kaa library.

Author: Yaroslav Zeygerman

Definition at line 57 of file IKaaClient.hpp.

Constructor & Destructor Documentation

virtual kaa::IKaaClient::~IKaaClient ( )

inlinevirtual

Definition at line 488 of file IKaaClient.hpp.

Member Function Documentation

virtual void kaa::IKaaClient::addConfigurationListener ( IConfigurationReceiver & receiver )

pure virtual

Subscribes listener of configuration updates.

Parameters

receiver Listener to be added to notification list.

Implemented in kaa::KaaClient.

virtual RecordFuture kaa::IKaaClient::addLogRecord ( const KaaUserLogRecord & record )

pure virtual

Adds a new log record to the log storage.

To store log records, MemoryLogStorage is used by default. Use setStorage() to set your own implementation.

Parameters

[in] record The log record to be added.

See Also: KaaUserLogRecord; ILogStorage

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::addNotificationListener ( INotificationListener & listener )

pure virtual

Adds the listener which receives notifications on all available topics.

Parameters

[in] listener The listener which receives notifications.

See Also: INotificationListener

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::addNotificationListener	(	std::int64_t	topicId,
		INotificationListener &	listener
	)

pure virtual

Adds the listener which receives notifications on the specified topic.

Listener(s) for optional topics may be added/removed irrespective to whether subscription is already done or not.

Parameters

[in]	topicId	The id of the topic (either mandatory or optional).
[in]	listener	The listener which receives notifications.

Exceptions

UnavailableTopicException Throws if the unknown topic id is provided.

See Also: INotificationListener

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::addTopicListListener ( INotificationTopicListListener & listener )

pure virtual

Adds the listener which receives updates on the list of available topics.

Parameters

[in] listener The listener which receives updates.

See Also: INotificationTopicListListener

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::attachEndpoint	(	const std::string &	endpointAccessToken,
		IAttachEndpointCallbackPtr	listener = `IAttachEndpointCallbackPtr()`
	)

pure virtual

Attaches the specified endpoint to the user to which the current endpoint is attached.

Parameters

[in]	endpointAccessToken	The access token of the endpoint to be attached to the user.
[in]	listener	The optional listener to notify of the result.

Exceptions

BadCredentials	The endpoint access token is empty.
TransportNotFoundException	The Kaa SDK isn't fully initialized.
KaaException	Some other failure has happened.

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::attachUser	(	const std::string &	userExternalId,
		const std::string &	userAccessToken,
		IUserAttachCallbackPtr	listener = `IUserAttachCallbackPtr()`
	)

pure virtual

Attaches the current endpoint to the specifier user. The user verification is carried out by the default verifier.

NOTE: If the default user verifier (DEFAULT_USER_VERIFIER_TOKEN) is not specified, the attach attempt fails with the KaaException exception.

Only endpoints associated with the same user can exchange events.

Parameters

[in]	userExternalId	The external user ID.
[in]	userAccessToken	The user access token.

Exceptions

BadCredentials	The endpoint access token is empty.
TransportNotFoundException	The Kaa SDK isn't fully initialized.
KaaException	Some other failure has happened.

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::attachUser	(	const std::string &	userExternalId,
		const std::string &	userAccessToken,
		const std::string &	userVerifierToken,
		IUserAttachCallbackPtr	listener = `IUserAttachCallbackPtr()`
	)

pure virtual

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::detachEndpoint	(	const std::string &	endpointKeyHash,
		IDetachEndpointCallbackPtr	listener = `IDetachEndpointCallbackPtr()`
	)

pure virtual

Detaches the specified endpoint from the user to which the current endpoint is attached.

Parameters

[in]	endpointKeyHash	The key hash of the endpoint to be detached from the user.
[in]	listener	The optional listener to notify of the result.

Exceptions

BadCredentials	The endpoint access token is empty.
TransportNotFoundException	The Kaa SDK isn't fully initialized.
KaaException	Some other failure has happened.

Implemented in kaa::KaaClient.

virtual std::int32_t kaa::IKaaClient::findEventListeners	(	const std::list< std::string > &	eventFQNs,
		IFetchEventListenersPtr	listener
	)

pure virtual

Submits an event listeners resolution request.

Parameters

eventFQNs	List of event class FQNs which have to be supported by endpoint.
listener	Result listener IFetchEventListeners}

Exceptions

KaaException when data is invalid (empty list or null listener)

Returns: Request ID of submitted request

Implemented in kaa::KaaClient.

virtual IKaaDataDemultiplexer& kaa::IKaaClient::getBootstrapDemultiplexer ( )

pure virtual

Retrieves Kaa bootstrap data demultiplexer.

Returns: IKaaDataDemultiplexer object

Implemented in kaa::KaaClient.

virtual IKaaDataMultiplexer& kaa::IKaaClient::getBootstrapMultiplexer ( )

pure virtual

Retrieves Kaa bootstrap data multiplexer.

Returns: IKaaDataMultiplexer object

Implemented in kaa::KaaClient.

virtual IKaaChannelManager& kaa::IKaaClient::getChannelManager ( )

pure virtual

Retrieves the Channel Manager.

Implemented in kaa::KaaClient.

virtual const KeyPair& kaa::IKaaClient::getClientKeyPair ( )

pure virtual

Retrieves the client's public and private key.

Required in user implementation of an operation data channel. Public key hash (SHA-1) is used by servers as identification number to uniquely identify each connected endpoint.

Private key is used by encryption schema between endpoint and servers.

Returns: client's public/private key pair

Implemented in kaa::KaaClient.

virtual const KaaRootConfiguration& kaa::IKaaClient::getConfiguration ( )

pure virtual

Returns full configuration tree which is actual at current moment.

Returns: ICommonRecord containing current configuration tree.

Implemented in kaa::KaaClient.

virtual std::string kaa::IKaaClient::getEndpointAccessToken ( ) const

pure virtual

Retrieve an access token for a current endpoint.

Returns: The current access token.

Implemented in kaa::KaaClient.

virtual std::string kaa::IKaaClient::getEndpointKeyHash ( ) const

pure virtual

Retrieve Endpoint Key Hash.

Returns: Representation of Endpoint Key Hash in Base64 format.

Implemented in kaa::KaaClient.

virtual EventFamilyFactory& kaa::IKaaClient::getEventFamilyFactory ( )

pure virtual

Retrieves Kaa event family factory.

Returns: EventFamilyFactory object.

Implemented in kaa::KaaClient.

virtual IKaaClientContext& kaa::IKaaClient::getKaaClientContext ( )

pure virtual

Retrieves Kaa context data.

Returns: IKaaClientContext object

Implemented in kaa::KaaClient.

virtual IKaaDataDemultiplexer& kaa::IKaaClient::getOperationDemultiplexer ( )

pure virtual

Retrieves Kaa operations data demultiplexer.

Returns: IKaaDataDemultiplexer object

Implemented in kaa::KaaClient.

virtual IKaaDataMultiplexer& kaa::IKaaClient::getOperationMultiplexer ( )

pure virtual

Retrieves Kaa operations data multiplexer.

Returns: IKaaDataMultiplexer object

Implemented in kaa::KaaClient.

virtual Topics kaa::IKaaClient::getTopics ( )

pure virtual

Retrieves the list of available topics.

Returns: The list of available topics.

Implemented in kaa::KaaClient.

virtual bool kaa::IKaaClient::isAttachedToUser ( )

pure virtual

Checks if the current endpoint is already attached to some user.

Returns: TRUE if the current endpoint is attached, FALSE otherwise.

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::pause ( )

pure virtual

Pauses Kaa's workflow.

Implemented in kaa::KaaClient.

virtual std::string kaa::IKaaClient::refreshEndpointAccessToken ( )

pure virtual

Generate new access token for a current endpoint.

Returns: The new access token.

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::removeConfigurationListener ( IConfigurationReceiver & receiver )

pure virtual

Unsubscribes listener of configuration updates.

Parameters

receiver Listener to be removed from notification list.

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::removeNotificationListener ( INotificationListener & listener )

pure virtual

Removes the listener which receives notifications on all available topics.

Parameters

[in] listener The listener which receives notifications.

See Also: INotificationListener

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::removeNotificationListener	(	std::int64_t	topicId,
		INotificationListener &	listener
	)

pure virtual

Removes the listener which receives notifications on the specified topic.

Listener(s) for optional topics may be added/removed irrespective to whether subscription is already done or not.

Parameters

[in]	topicId	The id of topic (either mandatory or optional).
[in]	listener	The listener which receives notifications.

Exceptions

UnavailableTopicException Throws if the unknown topic id is provided.

See Also: INotificationListener

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::removeTopicListListener ( INotificationTopicListListener & listener )

pure virtual

Removes listener which receives updates on the list of available topics.

Parameters

[in] listener The listener which receives updates.

See Also: INotificationTopicListListener

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::resume ( )

pure virtual

Resumes Kaa's workflow.

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::setAttachStatusListener ( IAttachStatusListenerPtr listener )

pure virtual

Sets listener to notify of the current endpoint is attached/detached by another one.

Parameters

[in] listener Listener to notify of the attach status is changed.

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::setConfigurationStorage ( IConfigurationStoragePtr storage )

pure virtual

Registers new configuration persistence routines. Replaces previously set value. Memory pointed by given parameter should be managed by user.

Parameters

storage User-defined persistence routines.

See Also: IConfigurationStorage

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::setEndpointAccessToken ( const std::string & token )

pure virtual

Set new access token for a current endpoint.

Parameters

[in] token The new access token.

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::setFailoverStrategy ( IFailoverStrategyPtr strategy )

pure virtual

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::setLogDeliveryListener ( ILogDeliveryListenerPtr listener )

pure virtual

Set a listener which receives a delivery status of each log bucket.

Parameters

listener[in] the listener

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::setLogStorage ( ILogStoragePtr storage )

pure virtual

Sets the new log storage.

MemoryLogStorage is used by default.

Parameters

[in] storage The ILogStorage implementation.

Exceptions

KaaException The storage is NULL.

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::setLogUploadStrategy ( ILogUploadStrategyPtr strategy )

pure virtual

Sets the new log upload strategy.

DefaultLogUploadStrategy is used by default.

Parameters

[in] strategy The ILogUploadStrategy implementation.

Exceptions

KaaException The strategy is NULL.

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::setProfileContainer ( IProfileContainerPtr container )

pure virtual

Sets profile container implemented by the user.

Parameters

container User-defined container

See Also: AbstractProfileContainer

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::start ( )

pure virtual

Starts Kaa's workflow.

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::stop ( )

pure virtual

Stops Kaa's workflow.

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::subscribeToTopic	(	std::int64_t	id,
		bool	forceSync = `true`
	)

pure virtual

Subscribes to the specified optional topic to receive notifications on that topic.

Parameters

[in]	topicId	The id of the optional topic.
[in]	forceSync	Indicates whether the subscription request should be sent immediately to the Operations server. If false , the request postpones to the explicit call of syncTopicSubscriptions() or to the first call of subscribeToTopic(), subscribeToTopics(), unsubscribeFromTopic() or unsubscribeFromTopics() with the true value for the forceSync parameter.

Exceptions

UnavailableTopicException Throws if the unknown topic id is provided or the topic isn't optional.

See Also: syncTopicSubscriptions()

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::subscribeToTopics	(	const std::list< std::int64_t > &	idList,
		bool	forceSync = `true`
	)

pure virtual

Subscribes to the specified list of optional topics to receive notifications on those topics.

Parameters

[in]	topicIds	The list of optional topic id-s.
[in]	forceSync	Indicates whether the subscription request should be sent immediately to the Operations server. If false , the request postpones to the explicit call of syncTopicSubscriptions() or to the first call of subscribeToTopic(), subscribeToTopics(), unsubscribeFromTopic() or unsubscribeFromTopics() with the true value for the forceSync parameter.

Exceptions

UnavailableTopicException Throws if the unknown topic id is provided or the topic isn't optional.

See Also: syncTopicSubscriptions()

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::syncTopicSubscriptions ( )

pure virtual

Sends subscription request(s) to the Operations server.

Use as a convenient way to send several subscription requests at once.

IKaaClient& kaaClient = Kaa::getKaaClient();
// Add listener(s) to receive notifications on topic(s)
kaaClient.subscribeToTopics({"optional_topic1_id", "optional_topic2_id"}, false);
kaaClient.unsubscribeFromTopic("optional_topic3_id", false);
kaaClient.syncTopicSubscriptions();

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::unsubscribeFromTopic	(	std::int64_t	id,
		bool	forceSync = `true`
	)

pure virtual

Unsubscribes from the specified optional topic to stop receiving notifications on that topic.

Parameters

[in]	topicId	The id of the optional topic.
[in]	forceSync	Indicates whether the subscription request should be sent immediately to the Operations server. If false , the request postpones to the explicit call of syncTopicSubscriptions() or to the first call of subscribeToTopic(), subscribeToTopics(), unsubscribeFromTopic() or unsubscribeFromTopics() with the true value for the forceSync parameter.

Exceptions

UnavailableTopicException Throws if the unknown topic id is provided or the topic isn't optional.

See Also: syncTopicSubscriptions()

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::unsubscribeFromTopics	(	const std::list< std::int64_t > &	idList,
		bool	forceSync = `true`
	)

pure virtual

Unsubscribes from the specified list of optional topics to stop receiving notifications on those topics.

Parameters

[in]	topicId	The list of optional topic id-s.
[in]	forceSync	Indicates whether the subscription request should be sent immediately to the Operations server. If false , the request postpones to the explicit call of syncTopicSubscriptions() or to the first call of subscribeToTopic(), subscribeToTopics(), unsubscribeFromTopic() or unsubscribeFromTopics() with the true value for the forceSync parameter.

Exceptions

UnavailableTopicException Throws if the unknown topic id is provided or the topic isn't optional.

See Also: syncTopicSubscriptions()

Implemented in kaa::KaaClient.

virtual void kaa::IKaaClient::updateProfile ( )

pure virtual

Notifies server about profile changes.

Implemented in kaa::KaaClient.

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

/home/architec/Documents/kaa/client/client-multi/client-cpp/kaa/IKaaClient.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation