Kaa client C SDK
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Data Structures | Typedefs
ext_transport_channel.h File Reference
#include "kaa_common.h"
#include "kaa_platform_protocol.h"

Go to the source code of this file.

Data Structures

struct  kaa_transport_context_t
 Used to initialize transport channel implementation with Kaa specific transport context. More...
 
struct  kaa_transport_channel_interface_t
 Interface for a client transport channel implementation. More...
 

Typedefs

typedef kaa_error_t(* kaa_init_channel_fn )(void *channel_context, kaa_transport_context_t *transport_context)
 Initializes the transport channel implementation. More...
 
typedef kaa_error_t(* kaa_set_access_point_fn )(void *channel_context, kaa_access_point_t *access_point)
 Sets transport connection data. More...
 
typedef kaa_error_t(* kaa_get_protocol_id_fn )(void *context, kaa_transport_protocol_id_t *protocol_info)
 Retrieves a transport protocol id supported by a transport channel implementation. More...
 
typedef kaa_error_t(* kaa_get_supported_services_fn )(void *context, const kaa_extension_id **supported_services, size_t *service_count)
 Retrieves the list of the supported services. More...
 
typedef kaa_error_t(* kaa_sync_handler_fn )(void *context, const kaa_extension_id services[], size_t service_count)
 Kaa sync request handler function for specific services. More...
 
typedef kaa_error_t(* kaa_tcp_channel_destroy_fn )(void *context)
 Releases channel context. More...
 

Typedef Documentation

typedef kaa_error_t(* kaa_get_protocol_id_fn)(void *context, kaa_transport_protocol_id_t *protocol_info)

Retrieves a transport protocol id supported by a transport channel implementation.

Parameters
[in]contextChannel context.
[out]protocol_infoTransport protocol id instance to be filled in.
Returns
Error code.
See Also
kaa_transport_protocol_id_t
typedef kaa_error_t(* kaa_get_supported_services_fn)(void *context, const kaa_extension_id **supported_services, size_t *service_count)

Retrieves the list of the supported services.

Parameters
[in]contextChannel context.
[out]supported_servicesList of the supported services.
[out]service_countNumber of the supported services.
Returns
Error code.
See Also
kaa_extension_id
typedef kaa_error_t(* kaa_init_channel_fn)(void *channel_context, kaa_transport_context_t *transport_context)

Initializes the transport channel implementation.

Parameters
[in]channel_contextChannel context.
[in]transport_contextKaa specific transport context.
Returns
Error code.
typedef kaa_error_t(* kaa_set_access_point_fn)(void *channel_context, kaa_access_point_t *access_point)

Sets transport connection data.

Note
Copy connection data for the local usage.
Parameters
[in]channel_contextChannel context.
[in]access_pointConnection data used to establish connection to Operations server.
Returns
Error code.
typedef kaa_error_t(* kaa_sync_handler_fn)(void *context, const kaa_extension_id services[], size_t service_count)

Kaa sync request handler function for specific services.

Parameters
[in]contextChannel context.
[in]servicesList of services.
[in]service_countNumber of services.
Returns
Error code.
See Also
kaa_extension_id
typedef kaa_error_t(* kaa_tcp_channel_destroy_fn)(void *context)

Releases channel context.

Parameters
[in]contextChannel context.
Returns
Error code.