Dokumentacja pliku protobuf-c.h

Struktury danych
struct	_ProtobufCBinaryData
struct	_ProtobufCAllocator
struct	_ProtobufCBuffer
struct	_ProtobufCEnumValue
struct	_ProtobufCEnumDescriptor
struct	_ProtobufCFieldDescriptor
struct	_ProtobufCMessageDescriptor
struct	_ProtobufCMessage
struct	_ProtobufCMethodDescriptor
struct	_ProtobufCServiceDescriptor
struct	_ProtobufCService
struct	_ProtobufCMessageUnknownField
struct	_ProtobufCBufferSimple
struct	_ProtobufCEnumValueIndex
struct	_ProtobufCIntRange

Definicje
#define	PROTOBUF_C_BEGIN_DECLS
#define	PROTOBUF_C_END_DECLS
#define	PROTOBUF_C_DEPRECATED
#define	PROTOBUF_C_MAJOR   0
#define	PROTOBUF_C_MINOR   14
#define	PROTOBUF_C_API
#define	PROTOBUF_C_OFFSETOF(struct, member)   offsetof(struct, member)
#define	PROTOBUF_C_ASSERT(condition)   assert(condition)
#define	PROTOBUF_C_ASSERT_NOT_REACHED()   assert(0)
#define	PROTOBUF_C_MESSAGE_INIT(descriptor)   { descriptor, 0, NULL }
#define	PROTOBUF_C_BUFFER_SIMPLE_INIT(array_of_bytes)
#define	PROTOBUF_C_BUFFER_SIMPLE_CLEAR(simp_buf)
#define	protobuf_c_type_to_ctype(type)   ((ProtobufCCType)(protobuf_c_type_to_ctype_array[(type)]))
#define	_PROTOBUF_C_FORCE_ENUM_TO_BE_INT_SIZE(enum_name)   , _##enum_name##_IS_INT_SIZE = INT_MAX
#define	PROTOBUF_C_SERVICE_DESCRIPTOR_MAGIC   0x14159bc3
#define	PROTOBUF_C_MESSAGE_DESCRIPTOR_MAGIC   0x28aaeef9
#define	PROTOBUF_C_ENUM_DESCRIPTOR_MAGIC   0x114315af

Definicje typów
typedef int	protobuf_c_boolean
typedef struct _ProtobufCBinaryData	ProtobufCBinaryData
typedef struct _ProtobufCIntRange	ProtobufCIntRange
typedef struct _ProtobufCAllocator	ProtobufCAllocator
typedef struct _ProtobufCBuffer	ProtobufCBuffer
typedef struct _ProtobufCEnumValue	ProtobufCEnumValue
typedef struct _ProtobufCEnumValueIndex	ProtobufCEnumValueIndex
typedef struct _ProtobufCEnumDescriptor	ProtobufCEnumDescriptor
typedef struct _ProtobufCMessageDescriptor	ProtobufCMessageDescriptor
typedef struct _ProtobufCFieldDescriptor	ProtobufCFieldDescriptor
typedef struct _ProtobufCMessage	ProtobufCMessage
typedef void(*	ProtobufCMessageInit )(ProtobufCMessage *)
typedef struct _ProtobufCMessageUnknownField	ProtobufCMessageUnknownField
typedef struct _ProtobufCMethodDescriptor	ProtobufCMethodDescriptor
typedef struct _ProtobufCServiceDescriptor	ProtobufCServiceDescriptor
typedef struct _ProtobufCService	ProtobufCService
typedef void(*	ProtobufCClosure )(const ProtobufCMessage *message, void *closure_data)
typedef struct _ProtobufCBufferSimple	ProtobufCBufferSimple
typedef void(*	ProtobufCServiceDestroy )(ProtobufCService *service)

Wyliczenia
enum	ProtobufCLabel {   PROTOBUF_C_LABEL_REQUIRED,   PROTOBUF_C_LABEL_OPTIONAL,   PROTOBUF_C_LABEL_REPEATED }
enum	ProtobufCType {   PROTOBUF_C_TYPE_INT32,   PROTOBUF_C_TYPE_SINT32,   PROTOBUF_C_TYPE_SFIXED32,   PROTOBUF_C_TYPE_INT64,   PROTOBUF_C_TYPE_SINT64,   PROTOBUF_C_TYPE_SFIXED64,   PROTOBUF_C_TYPE_UINT32,   PROTOBUF_C_TYPE_FIXED32,   PROTOBUF_C_TYPE_UINT64,   PROTOBUF_C_TYPE_FIXED64,   PROTOBUF_C_TYPE_FLOAT,   PROTOBUF_C_TYPE_DOUBLE,   PROTOBUF_C_TYPE_BOOL,   PROTOBUF_C_TYPE_ENUM,   PROTOBUF_C_TYPE_STRING,   PROTOBUF_C_TYPE_BYTES,   PROTOBUF_C_TYPE_MESSAGE }
enum	ProtobufCWireType {   PROTOBUF_C_WIRE_TYPE_VARINT,   PROTOBUF_C_WIRE_TYPE_64BIT,   PROTOBUF_C_WIRE_TYPE_LENGTH_PREFIXED,   PROTOBUF_C_WIRE_TYPE_START_GROUP,   PROTOBUF_C_WIRE_TYPE_END_GROUP,   PROTOBUF_C_WIRE_TYPE_32BIT }
enum	ProtobufCCType {   PROTOBUF_C_CTYPE_INT32,   PROTOBUF_C_CTYPE_UINT32,   PROTOBUF_C_CTYPE_INT64,   PROTOBUF_C_CTYPE_UINT64,   PROTOBUF_C_CTYPE_FLOAT,   PROTOBUF_C_CTYPE_DOUBLE,   PROTOBUF_C_CTYPE_BOOL,   PROTOBUF_C_CTYPE_ENUM,   PROTOBUF_C_CTYPE_STRING,   PROTOBUF_C_CTYPE_BYTES,   PROTOBUF_C_CTYPE_MESSAGE }

Funkcje
PROTOBUF_C_API size_t	protobuf_c_message_get_packed_size (const ProtobufCMessage *message)
PROTOBUF_C_API size_t	protobuf_c_message_pack (const ProtobufCMessage *message, uint8_t *out)
PROTOBUF_C_API size_t	protobuf_c_message_pack_to_buffer (const ProtobufCMessage *message, ProtobufCBuffer *buffer)
PROTOBUF_C_API ProtobufCMessage *	protobuf_c_message_unpack (const ProtobufCMessageDescriptor *, ProtobufCAllocator *allocator, size_t len, const uint8_t *data)
PROTOBUF_C_API void	protobuf_c_message_free_unpacked (ProtobufCMessage *message, ProtobufCAllocator *allocator)
PROTOBUF_C_API void	protobuf_c_message_init (const ProtobufCMessageDescriptor *, void *message)
void	protobuf_c_service_destroy (ProtobufCService *)
PROTOBUF_C_API const ProtobufCEnumValue *	protobuf_c_enum_descriptor_get_value_by_name (const ProtobufCEnumDescriptor *desc, const char *name)
PROTOBUF_C_API const ProtobufCEnumValue *	protobuf_c_enum_descriptor_get_value (const ProtobufCEnumDescriptor *desc, int value)
PROTOBUF_C_API const ProtobufCFieldDescriptor *	protobuf_c_message_descriptor_get_field_by_name (const ProtobufCMessageDescriptor *desc, const char *name)
PROTOBUF_C_API const ProtobufCFieldDescriptor *	protobuf_c_message_descriptor_get_field (const ProtobufCMessageDescriptor *desc, unsigned value)
PROTOBUF_C_API const ProtobufCMethodDescriptor *	protobuf_c_service_descriptor_get_method_by_name (const ProtobufCServiceDescriptor *desc, const char *name)
ProtobufCCType	protobuf_c_type_to_ctype (ProtobufCType type)
void	protobuf_c_buffer_simple_append (ProtobufCBuffer *buffer, size_t len, const unsigned char *data)
int	protobuf_c_int_ranges_lookup (unsigned n_ranges, ProtobufCIntRange *ranges)
void	protobuf_c_service_generated_init (ProtobufCService *service, const ProtobufCServiceDescriptor *descriptor, ProtobufCServiceDestroy destroy)
void	protobuf_c_service_invoke_internal (ProtobufCService *service, unsigned method_index, const ProtobufCMessage *input, ProtobufCClosure closure, void *closure_data)

Zmienne
unsigned	protobuf_c_major
unsigned	protobuf_c_minor
PROTOBUF_C_API ProtobufCAllocator	protobuf_c_default_allocator
PROTOBUF_C_API ProtobufCAllocator	protobuf_c_system_allocator
PROTOBUF_C_API void(*	protobuf_c_out_of_memory )(void)

Dokumentacja definicji

#define PROTOBUF_C_BEGIN_DECLS

#define PROTOBUF_C_END_DECLS

#define PROTOBUF_C_DEPRECATED

#define PROTOBUF_C_MAJOR   0

#define PROTOBUF_C_MINOR   14

#define PROTOBUF_C_API

#define PROTOBUF_C_OFFSETOF	(		struct,
			member
	)		offsetof(struct, member)

#define PROTOBUF_C_ASSERT

(

condition

)

assert(condition)

#define PROTOBUF_C_ASSERT_NOT_REACHED

(

)

assert(0)

#define PROTOBUF_C_MESSAGE_INIT

(

descriptor

)

{ descriptor, 0, NULL }

#define PROTOBUF_C_BUFFER_SIMPLE_INIT

(

array_of_bytes

)

Wartość:

{ { protobuf_c_buffer_simple_append }, \
  sizeof(array_of_bytes), 0, (array_of_bytes), 0 }

#define PROTOBUF_C_BUFFER_SIMPLE_CLEAR

(

simp_buf

)

Wartość:

do { if ((simp_buf)->must_free_data) \
         protobuf_c_default_allocator.free (&protobuf_c_default_allocator.allocator_data, (simp_buf)->data); } while (0)

#define protobuf_c_type_to_ctype

(

type

)

((ProtobufCCType)(protobuf_c_type_to_ctype_array[(type)]))

#define _PROTOBUF_C_FORCE_ENUM_TO_BE_INT_SIZE

(

enum_name

)

, _##enum_name##_IS_INT_SIZE = INT_MAX

#define PROTOBUF_C_SERVICE_DESCRIPTOR_MAGIC   0x14159bc3

#define PROTOBUF_C_MESSAGE_DESCRIPTOR_MAGIC   0x28aaeef9

#define PROTOBUF_C_ENUM_DESCRIPTOR_MAGIC   0x114315af

Dokumentacja definicji typów

typedef int protobuf_c_boolean

typedef struct _ProtobufCBinaryData ProtobufCBinaryData

typedef struct _ProtobufCIntRange ProtobufCIntRange

typedef struct _ProtobufCAllocator ProtobufCAllocator

typedef struct _ProtobufCBuffer ProtobufCBuffer

typedef struct _ProtobufCEnumValue ProtobufCEnumValue

typedef struct _ProtobufCEnumValueIndex ProtobufCEnumValueIndex

typedef struct _ProtobufCEnumDescriptor ProtobufCEnumDescriptor

typedef struct _ProtobufCMessageDescriptor ProtobufCMessageDescriptor

typedef struct _ProtobufCFieldDescriptor ProtobufCFieldDescriptor

typedef struct _ProtobufCMessage ProtobufCMessage

typedef void(* ProtobufCMessageInit)(ProtobufCMessage *)

typedef struct _ProtobufCMessageUnknownField ProtobufCMessageUnknownField

typedef struct _ProtobufCMethodDescriptor ProtobufCMethodDescriptor

typedef struct _ProtobufCServiceDescriptor ProtobufCServiceDescriptor

typedef struct _ProtobufCService ProtobufCService

typedef void(* ProtobufCClosure)(const ProtobufCMessage *message, void *closure_data)

typedef struct _ProtobufCBufferSimple ProtobufCBufferSimple

typedef void(* ProtobufCServiceDestroy)(ProtobufCService *service)

Dokumentacja typów wyliczanych

enum ProtobufCLabel

Wartości wyliczeń
PROTOBUF_C_LABEL_REQUIRED
PROTOBUF_C_LABEL_OPTIONAL
PROTOBUF_C_LABEL_REPEATED

enum ProtobufCType

Wartości wyliczeń
PROTOBUF_C_TYPE_INT32
PROTOBUF_C_TYPE_SINT32
PROTOBUF_C_TYPE_SFIXED32
PROTOBUF_C_TYPE_INT64
PROTOBUF_C_TYPE_SINT64
PROTOBUF_C_TYPE_SFIXED64
PROTOBUF_C_TYPE_UINT32
PROTOBUF_C_TYPE_FIXED32
PROTOBUF_C_TYPE_UINT64
PROTOBUF_C_TYPE_FIXED64
PROTOBUF_C_TYPE_FLOAT
PROTOBUF_C_TYPE_DOUBLE
PROTOBUF_C_TYPE_BOOL
PROTOBUF_C_TYPE_ENUM
PROTOBUF_C_TYPE_STRING
PROTOBUF_C_TYPE_BYTES
PROTOBUF_C_TYPE_MESSAGE

enum ProtobufCWireType

Wartości wyliczeń
PROTOBUF_C_WIRE_TYPE_VARINT
PROTOBUF_C_WIRE_TYPE_64BIT
PROTOBUF_C_WIRE_TYPE_LENGTH_PREFIXED
PROTOBUF_C_WIRE_TYPE_START_GROUP
PROTOBUF_C_WIRE_TYPE_END_GROUP
PROTOBUF_C_WIRE_TYPE_32BIT

enum ProtobufCCType

Wartości wyliczeń
PROTOBUF_C_CTYPE_INT32
PROTOBUF_C_CTYPE_UINT32
PROTOBUF_C_CTYPE_INT64
PROTOBUF_C_CTYPE_UINT64
PROTOBUF_C_CTYPE_FLOAT
PROTOBUF_C_CTYPE_DOUBLE
PROTOBUF_C_CTYPE_BOOL
PROTOBUF_C_CTYPE_ENUM
PROTOBUF_C_CTYPE_STRING
PROTOBUF_C_CTYPE_BYTES
PROTOBUF_C_CTYPE_MESSAGE

Dokumentacja funkcji

PROTOBUF_C_API size_t protobuf_c_message_get_packed_size

(

const ProtobufCMessage *

message

)

PROTOBUF_C_API size_t protobuf_c_message_pack	(	const ProtobufCMessage *	message,
		uint8_t *	out
	)

PROTOBUF_C_API size_t protobuf_c_message_pack_to_buffer	(	const ProtobufCMessage *	message,
		ProtobufCBuffer *	buffer
	)

PROTOBUF_C_API ProtobufCMessage* protobuf_c_message_unpack	(	const ProtobufCMessageDescriptor *	,
		ProtobufCAllocator *	allocator,
		size_t	len,
		const uint8_t *	data
	)

PROTOBUF_C_API void protobuf_c_message_free_unpacked	(	ProtobufCMessage *	message,
		ProtobufCAllocator *	allocator
	)

PROTOBUF_C_API void protobuf_c_message_init	(	const ProtobufCMessageDescriptor *	,
		void *	message
	)

void protobuf_c_service_destroy

(

ProtobufCService *

)

PROTOBUF_C_API const ProtobufCEnumValue* protobuf_c_enum_descriptor_get_value_by_name	(	const ProtobufCEnumDescriptor *	desc,
		const char *	name
	)

PROTOBUF_C_API const ProtobufCEnumValue* protobuf_c_enum_descriptor_get_value	(	const ProtobufCEnumDescriptor *	desc,
		int	value
	)

PROTOBUF_C_API const ProtobufCFieldDescriptor* protobuf_c_message_descriptor_get_field_by_name	(	const ProtobufCMessageDescriptor *	desc,
		const char *	name
	)

PROTOBUF_C_API const ProtobufCFieldDescriptor* protobuf_c_message_descriptor_get_field	(	const ProtobufCMessageDescriptor *	desc,
		unsigned	value
	)

PROTOBUF_C_API const ProtobufCMethodDescriptor* protobuf_c_service_descriptor_get_method_by_name	(	const ProtobufCServiceDescriptor *	desc,
		const char *	name
	)

ProtobufCCType protobuf_c_type_to_ctype

(

ProtobufCType

type

)

void protobuf_c_buffer_simple_append	(	ProtobufCBuffer *	buffer,
		size_t	len,
		const unsigned char *	data
	)

int protobuf_c_int_ranges_lookup	(	unsigned	n_ranges,
		ProtobufCIntRange *	ranges
	)

void protobuf_c_service_generated_init	(	ProtobufCService *	service,
		const ProtobufCServiceDescriptor *	descriptor,
		ProtobufCServiceDestroy	destroy
	)

void protobuf_c_service_invoke_internal	(	ProtobufCService *	service,
		unsigned	method_index,
		const ProtobufCMessage *	input,
		ProtobufCClosure	closure,
		void *	closure_data
	)

Dokumentacja zmiennych

unsigned protobuf_c_major

unsigned protobuf_c_minor

PROTOBUF_C_API ProtobufCAllocator protobuf_c_default_allocator

PROTOBUF_C_API ProtobufCAllocator protobuf_c_system_allocator

PROTOBUF_C_API void(* protobuf_c_out_of_memory)(void)