ccl_platform_if

Abstraction for system/platform utilities. More...

Data Structures
struct	ccl_platform_metadata
	Encapsulates platform-specific metadata to be reported to Conviva. More...
struct	ccl_crypto_t
	Encapsulates function pointers for cryptographic functionalities like hashing, base64, etc. More...
struct	ccl_http_request_t
	Request type contains all the details for the http post. More...
struct	ccl_platform_t
	Encapsulates function pointers for system utilities like logging, timers, locks, etc. More...

Macros
#define	CCL_MAX_PLATFORM_METADATA_LENGTH   128

Typedefs
typedef struct ccl_platform_metadata	ccl_platform_metadata_t
	Encapsulates platform-specific metadata to be reported to Conviva.
typedef void(*	ccl_timer_callback) (void *timer_data)
	Callback function for use with timers.
typedef void(*	ccl_http_callback) (int status, void *http_data, const char *response, unsigned int response_length)
	Callback function to communicate HTTP responses back to Conviva.
typedef void(*	ccl_load_callback) (int status, const char *data, unsigned int length)
	Callback function to notify a local data to the ccl library.
typedef void(*	ccl_save_callback) (int status, const char *error, unsigned int length)
	Callback function to notify a status of saving operation to the ccl library.
typedef void(*	ccl_http_get_callback) (int status, const char *response, unsigned int response_length)
	Callback function to communicate HTTP get back to Conviva.

Enumerations
enum	ccl_device_type_t {   CCL_DEVICE_TYPE_UNKNOWN = 0 , CCL_DEVICE_TYPE_DESKTOP , CCL_DEVICE_TYPE_CONSOLE , CCL_DEVICE_TYPE_SETTOP ,   CCL_DEVICE_TYPE_MOBILE , CCL_DEVICE_TYPE_TABLET , CCL_DEVICE_TYPE_SMARTTV , CCL_DEVICE_TYPE_VEHICLE ,   CCL_DEVICE_TYPE_OTHER }
	Constants for valid device types. More...
enum	ccl_device_category_t {   CCL_DEVICE_CATEGORY_INVALID = 0 , CCL_DEVICE_CATEGORY_AND , CCL_DEVICE_CATEGORY_APL , CCL_DEVICE_CATEGORY_CHR ,   CCL_DEVICE_CATEGORY_DSKAPP , CCL_DEVICE_CATEGORY_SIMULATOR , CCL_DEVICE_CATEGORY_KAIOS , CCL_DEVICE_CATEGORY_LGTV ,   CCL_DEVICE_CATEGORY_LNX , CCL_DEVICE_CATEGORY_NINTENDO , CCL_DEVICE_CATEGORY_PS , CCL_DEVICE_CATEGORY_RK ,   CCL_DEVICE_CATEGORY_SAMSUNGTV , CCL_DEVICE_CATEGORY_VIDAA , CCL_DEVICE_CATEGORY_VIZIOTV , CCL_DEVICE_CATEGORY_WEB ,   CCL_DEVICE_CATEGORY_WIN , CCL_DEVICE_CATEGORY_XB }
	Constants for valid device categories. More...
enum	ccl_hash_algo_t { CCL_HASH_SHA1 }
	Constants for Hash algos. More...
enum	ccl_compression_type_t { CCL_UNKNOWN_COMPRESSION = 0 , CCL_GZIP_COMPRESSION }
	Constants for valid device types. More...

Detailed Description

Abstraction for system/platform utilities.

This structure has pointers to functions implemented at the platform/OS abstraction layer to perform various low-level duties.
These functions will be called by the Conviva library when needed.

Macro Definition Documentation

CCL_MAX_PLATFORM_METADATA_LENGTH

#define CCL_MAX_PLATFORM_METADATA_LENGTH   128

Typedef Documentation

ccl_http_callback

typedef void(* ccl_http_callback) (int status, void *http_data, const char *response, unsigned int response_length)

Callback function to communicate HTTP responses back to Conviva.

Parameters

http_data	Opaque HTTP context to pass along.
status	CCL_SUCCESS or CCL_ERROR.
response	The HTTP response string.
response_length	The length of the HTTP response string.

ccl_http_get_callback

typedef void(* ccl_http_get_callback) (int status, const char *response, unsigned int response_length)

Callback function to communicate HTTP get back to Conviva.

Parameters

status	CCL_SUCCESS or CCL_ERROR.
response	The HTTP response string.
response_length	The length of the HTTP response string.

ccl_load_callback

typedef void(* ccl_load_callback) (int status, const char *data, unsigned int length)

Callback function to notify a local data to the ccl library.

Parameters

status	CCL_SUCCESS or CCL_ERROR.
data	a client id string on CCL_SUCCESS, or an error string on CCL_ERROR.
length	the length of the data or the error string.

ccl_platform_metadata_t

typedef struct ccl_platform_metadata ccl_platform_metadata_t

Encapsulates platform-specific metadata to be reported to Conviva.

ccl_save_callback

typedef void(* ccl_save_callback) (int status, const char *error, unsigned int length)

Callback function to notify a status of saving operation to the ccl library.

Parameters

status	CCL_SUCCESS or CCL_ERROR.
error	an error string on CCL_ERROR, NULL on CCL_SUCCESS.
length	the length of the error string on CCL_ERROR, 0 on CCL_SUCCESS.

ccl_timer_callback

typedef void(* ccl_timer_callback) (void *timer_data)

Callback function for use with timers.

Enumeration Type Documentation

ccl_compression_type_t

enum ccl_compression_type_t

Constants for valid device types.

Enumerator
CCL_UNKNOWN_COMPRESSION	Default compression type.
CCL_GZIP_COMPRESSION	Gzip compression.

ccl_device_category_t

enum ccl_device_category_t

Constants for valid device categories.

Enumerator
CCL_DEVICE_CATEGORY_INVALID	The device type is not known or does not fit any other category.
CCL_DEVICE_CATEGORY_AND
CCL_DEVICE_CATEGORY_APL
CCL_DEVICE_CATEGORY_CHR
CCL_DEVICE_CATEGORY_DSKAPP
CCL_DEVICE_CATEGORY_SIMULATOR
CCL_DEVICE_CATEGORY_KAIOS
CCL_DEVICE_CATEGORY_LGTV
CCL_DEVICE_CATEGORY_LNX
CCL_DEVICE_CATEGORY_NINTENDO
CCL_DEVICE_CATEGORY_PS
CCL_DEVICE_CATEGORY_RK
CCL_DEVICE_CATEGORY_SAMSUNGTV
CCL_DEVICE_CATEGORY_VIDAA
CCL_DEVICE_CATEGORY_VIZIOTV
CCL_DEVICE_CATEGORY_WEB
CCL_DEVICE_CATEGORY_WIN
CCL_DEVICE_CATEGORY_XB

ccl_device_type_t

enum ccl_device_type_t

Constants for valid device types.

Enumerator
CCL_DEVICE_TYPE_UNKNOWN	The device type is not known or does not fit any other category.
CCL_DEVICE_TYPE_DESKTOP	The device is a desktop/laptop computer.
CCL_DEVICE_TYPE_CONSOLE	The device is a gaming console.
CCL_DEVICE_TYPE_SETTOP	The device is a set-top box.
CCL_DEVICE_TYPE_MOBILE	The device is a mobile phone.
CCL_DEVICE_TYPE_TABLET	The device is a tablet.
CCL_DEVICE_TYPE_SMARTTV	The device is a smart TV.
CCL_DEVICE_TYPE_VEHICLE	The device is vehicle infotainment system.
CCL_DEVICE_TYPE_OTHER	other device types.

ccl_hash_algo_t

enum ccl_hash_algo_t

Constants for Hash algos.

Enumerator
CCL_HASH_SHA1	SHA1 hash algo.