kaa_common.h File Reference

Common C EP SDK definitions and small utilities. More...

#include "kaa_error.h"

Include dependency graph for kaa_common.h:

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

Go to the source code of this file.

Classes
struct	kaa_transport_protocol_id_t
	Identifier used to uniquely represent transport protocol. More...
struct	kaa_access_point_t
	Connection parameters used by transport channels to establish connection both to Bootstrap and Operations servers. More...

Macros
#define	KAA_RETURN_IF_ERR(E)   do { if (E) return E; } while (0)
#define	KAA_RETURN_IF_NIL(p, E)   do { if (!(p)) return E; } while (0)
#define	KAA_RETURN_IF_NIL2(p1, p2, E)   do { if (!(p1) || !(p2)) return E; } while (0)
#define	KAA_RETURN_IF_NIL3(p1, p2, p3, E)   do { if (!(p1) || !(p2) || !(p3)) return E; } while (0)
#define	KAA_RETURN_IF_NIL4(p1, p2, p3, p4, E)   do { if (!(p1) || !(p2) || !(p3) || !(p4)) return E; } while (0)
#define	KAA_RETURN_IF_NIL5(p1, p2, p3, p4, p5, E)   do { if (!(p1) || !(p2) || !(p3) || !(p4) || !(p5)) return E; } while (0)
#define	KAA_ENDPOINT_ID_LENGTH   20

Typedefs
typedef uint8_t	kaa_endpoint_id [KAA_ENDPOINT_ID_LENGTH]
typedef const uint8_t *	kaa_endpoint_id_p

Enumerations
enum	kaa_service_t {   KAA_SERVICE_BOOTSTRAP = 0, KAA_SERVICE_PROFILE = 1, KAA_SERVICE_USER = 2, KAA_SERVICE_EVENT = 3,   KAA_SERVICE_LOGGING = 4, KAA_SERVICE_CONFIGURATION = 5, KAA_SERVICE_NOTIFICATION = 6 }
	Types of Kaa platform services. More...

Functions
static int	kaa_transport_protocol_id_equals (const kaa_transport_protocol_id_t *first, const kaa_transport_protocol_id_t *second)

Detailed Description

Common C EP SDK definitions and small utilities.

Copyright 2014-2016 CyberVision, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definition in file kaa_common.h.

Macro Definition Documentation

#define KAA_ENDPOINT_ID_LENGTH   20

Definition at line 93 of file kaa_common.h.

#define KAA_RETURN_IF_ERR

(

E

)

do { if (E) return E; } while (0)

Definition at line 35 of file kaa_common.h.

#define KAA_RETURN_IF_NIL	(		p,
			E
	)		do { if (!(p)) return E; } while (0)

Definition at line 38 of file kaa_common.h.

#define KAA_RETURN_IF_NIL2	(		p1,
			p2,
			E
	)		do { if (!(p1) || !(p2)) return E; } while (0)

Definition at line 41 of file kaa_common.h.

#define KAA_RETURN_IF_NIL3	(		p1,
			p2,
			p3,
			E
	)		do { if (!(p1) || !(p2) || !(p3)) return E; } while (0)

Definition at line 44 of file kaa_common.h.

#define KAA_RETURN_IF_NIL4	(		p1,
			p2,
			p3,
			p4,
			E
	)		do { if (!(p1) || !(p2) || !(p3) || !(p4)) return E; } while (0)

Definition at line 47 of file kaa_common.h.

#define KAA_RETURN_IF_NIL5	(		p1,
			p2,
			p3,
			p4,
			p5,
			E
	)		do { if (!(p1) || !(p2) || !(p3) || !(p4) || !(p5)) return E; } while (0)

Definition at line 50 of file kaa_common.h.

Typedef Documentation

typedef uint8_t kaa_endpoint_id[KAA_ENDPOINT_ID_LENGTH]

Definition at line 94 of file kaa_common.h.

typedef const uint8_t* kaa_endpoint_id_p

Definition at line 95 of file kaa_common.h.

Enumeration Type Documentation

enum kaa_service_t

Types of Kaa platform services.

Enumerator
KAA_SERVICE_BOOTSTRAP
KAA_SERVICE_PROFILE
KAA_SERVICE_USER
KAA_SERVICE_EVENT
KAA_SERVICE_LOGGING
KAA_SERVICE_CONFIGURATION
KAA_SERVICE_NOTIFICATION

Definition at line 57 of file kaa_common.h.

Function Documentation

static int kaa_transport_protocol_id_equals ( const kaa_transport_protocol_id_t *  first, const kaa_transport_protocol_id_t *  second  )

inlinestatic

Definition at line 75 of file kaa_common.h.