External interface for receiving user attachment status used by Kaa User subsystem. Should be implemented to receive user attachment/detachment notifications. More...

#include "../kaa_common.h"

Include dependency graph for ext_user_callback.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	kaa_attachment_status_listeners_t
	Interface for the user attachment status receiver. More...

struct	kaa_endpoint_status_listener_t
	Interface for the endpoint attachment status receiver. More...

Typedefs
typedef kaa_error_t(*	on_attached_fn )(void context, const char user_external_id, const char *endpoint_access_token)
	Notifies about the successful attachment of the current endpoint to some user. More...

typedef kaa_error_t(*	on_detached_fn )(void context, const char endpoint_access_token)
	Indicates that current endpoint was detached from a user. More...

typedef kaa_error_t(*	on_attach_success_fn )(void *context)
	Notifies about attach status changes. More...

typedef kaa_error_t(*	on_attach_failed_fn )(void context, user_verifier_error_code_t error_code, const char reason)
	Notifies about attach attempt was failed. More...

typedef kaa_error_t(*	on_endpoint_attached_fn )(void *context, const kaa_endpoint_id_p endpoint_key_hash)
	Notifies about attach attempt of endpoint was sucssed. More...

typedef kaa_error_t(*	on_endpoint_detached_fn )(void *context)
	Notifies about detach attempt of endpoint was sucssed. More...

typedef kaa_error_t(*	on_endpoint_failed_fn )(void *context)
	Notifies about attach attempt was failed. More...

Enumerations
enum	user_verifier_error_code_t { NO_VERIFIER_CONFIGURED = 0, TOKEN_INVALID = 1, TOKEN_EXPIRED = 2, INTERNAL_ERROR = 3, CONNECTION_ERROR = 4, REMOTE_ERROR = 5, OTHER = 6 }

Detailed Description

External interface for receiving user attachment status used by Kaa User subsystem. Should be implemented to receive user attachment/detachment notifications.

Definition in file ext_user_callback.h.

Typedef Documentation

typedef kaa_error_t(* on_attach_failed_fn)(void *context, user_verifier_error_code_t error_code, const char *reason)

Notifies about attach attempt was failed.

Parameters

[in]	context	Callback's context.
[in]	error_code	One of user_verifier_error_code_t values.
[in]	reason	Additional description for the error. May be NULL.

Returns: Error code

Definition at line 88 of file ext_user_callback.h.

typedef kaa_error_t(* on_attach_success_fn)(void *context)

Notifies about attach status changes.

Parameters

[in]	context	Callback's context.
[in]	is_attached	True - if a current endpoint was attached to user, false - otherwise.

Returns: Error code

Definition at line 77 of file ext_user_callback.h.

typedef kaa_error_t(* on_attached_fn)(void *context, const char *user_external_id, const char *endpoint_access_token)

Notifies about the successful attachment of the current endpoint to some user.

Parameters

[in]	context	Callback's context.
[in]	user_external_id	The ID of the user who has attached a current endpoint.
[in]	endpoint_access_token	The access token of the endpoint which has attached a current endpoint.

Returns: Error code

Definition at line 55 of file ext_user_callback.h.

typedef kaa_error_t(* on_detached_fn)(void *context, const char *endpoint_access_token)

Indicates that current endpoint was detached from a user.

Parameters

[in]	context	Callback's context.
[in]	endpoint_access_token	The access token of the endpoint which has detached a current endpoint.

Returns: Error code

Definition at line 66 of file ext_user_callback.h.

typedef kaa_error_t(* on_endpoint_attached_fn)(void *context, const kaa_endpoint_id_p endpoint_key_hash)

Notifies about attach attempt of endpoint was sucssed.

Parameters

[in]	context	Callback's context.
[in]	endpoint_key_hash	endpoint_id.

Returns: Error code

Definition at line 112 of file ext_user_callback.h.

typedef kaa_error_t(* on_endpoint_detached_fn)(void *context)

Notifies about detach attempt of endpoint was sucssed.

Parameters

[in] context Callback's context.

Returns: Error code

Definition at line 122 of file ext_user_callback.h.

typedef kaa_error_t(* on_endpoint_failed_fn)(void *context)

Notifies about attach attempt was failed.

Parameters

[in] context Callback's context.

Returns: Error code

Definition at line 132 of file ext_user_callback.h.

Enumeration Type Documentation

enum user_verifier_error_code_t

Enumerator
NO_VERIFIER_CONFIGURED
TOKEN_INVALID
TOKEN_EXPIRED
INTERNAL_ERROR
CONNECTION_ERROR
REMOTE_ERROR
OTHER

Definition at line 34 of file ext_user_callback.h.

Classes

Typedefs

Enumerations

Detailed Description

Typedef Documentation

Enumeration Type Documentation