docs/reference.rst

   1 =====================
   2 Nanopb: API reference
   3 =====================
   4
   5 .. include :: menu.rst
   6
   7 .. contents ::
   8
   9 Compilation options
  10 ===================
  11 The following options can be specified using -D switch given to the C compiler:
  12
  13 :__BIG_ENDIAN__: Set this if your platform stores integers and floats in big-endian format. Mixed-endian systems (different layout for ints and floats) are currently not supported.
  14
  15 pb.h
  16 ====
  17
  18 pb_type_t
  19 ---------
  20 Defines the encoder/decoder behaviour that should be used for a field. ::
  21
  22     typedef enum { ... } pb_type_t;
  23
  24 The low-order byte of the enumeration values defines the function that can be used for encoding and decoding the field data:
  25
  26 ==================== ===== ================================================
  27 LTYPE identifier     Value Storage format
  28 ==================== ===== ================================================
  29 PB_LTYPE_VARINT      0x00  Integer.
  30 PB_LTYPE_SVARINT     0x01  Integer, zigzag encoded.
  31 PB_LTYPE_FIXED       0x02  Integer or floating point.
  32 PB_LTYPE_BYTES       0x03  Structure with *size_t* field and byte array.
  33 PB_LTYPE_STRING      0x04  Null-terminated string.
  34 PB_LTYPE_SUBMESSAGE  0x05  Submessage structure.
  35 ==================== ===== ================================================
  36
  37 The high-order byte defines whether the field is required, optional, repeated or callback:
  38
  39 ==================== ===== ================================================
  40 HTYPE identifier     Value Field handling
  41 ==================== ===== ================================================
  42 PB_HTYPE_REQUIRED    0x00  Verify that field exists in decoded message.
  43 PB_HTYPE_OPTIONAL    0x10  Use separate *has_<field>* boolean to specify
  44                            whether the field is present.
  45 PB_HTYPE_ARRAY       0x20  A repeated field with preallocated array.
  46                            Separate *<field>_count* for number of items.
  47 PB_HTYPE_CALLBACK    0x30  A field with dynamic storage size, data is
  48                            actually a pointer to a structure containing a
  49                            callback function.
  50 ==================== ===== ================================================
  51
  52 pb_field_t
  53 ----------
  54 Describes a single structure field with memory position in relation to others. The descriptions are usually autogenerated. ::
  55
  56     typedef struct _pb_field_t pb_field_t;
  57     struct _pb_field_t {
  58         uint8_t tag;
  59         pb_type_t type;
  60         uint8_t data_offset;
  61         int8_t size_offset;
  62         uint8_t data_size;
  63         uint8_t array_size;
  64         const void *ptr;
  65     } pb_packed;
  66
  67 :tag:           Tag number of the field or 0 to terminate a list of fields.
  68 :type:          LTYPE and HTYPE of the field.
  69 :data_offset:   Offset of field data, relative to the end of the previous field.
  70 :size_offset:   Offset of *bool* flag for optional fields or *size_t* count for arrays, relative to field data.
  71 :data_size:     Size of a single data entry, in bytes. For PB_LTYPE_BYTES, the size of the byte array inside the containing structure. For PB_HTYPE_CALLBACK, size of the C data type if known.
  72 :array_size:    Maximum number of entries in an array, if it is an array type.
  73 :ptr:           Pointer to default value for optional fields, or to submessage description for PB_LTYPE_SUBMESSAGE.
  74
  75 The *uint8_t* datatypes limit the maximum size of a single item to 255 bytes and arrays to 255 items. Compiler will warn "Initializer too large for type" if the limits are exceeded. The types can be changed to larger ones if necessary.
  76
  77 pb_bytes_array_t
  78 ----------------
  79 An byte array with a field for storing the length::
  80
  81     typedef struct {
  82         size_t size;
  83         uint8_t bytes[1];
  84     } pb_bytes_array_t;
  85
  86 In an actual array, the length of *bytes* may be different.
  87
  88 pb_callback_t
  89 -------------
  90 Part of a message structure, for fields with type PB_HTYPE_CALLBACK::
  91
  92     typedef struct _pb_callback_t pb_callback_t;
  93     struct _pb_callback_t {
  94         union {
  95             bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void *arg);
  96             bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg);
  97         } funcs;
  98
  99         void *arg;
 100     };
 101
 102 The *arg* is passed to the callback when calling. It can be used to store any information that the callback might need.
 103
 104 When calling `pb_encode`_, *funcs.encode* is used, and similarly when calling `pb_decode`_, *funcs.decode* is used. The function pointers are stored in the same memory location but are of incompatible types. You can set the function pointer to NULL to skip the field.
 105
 106 pb_wire_type_t
 107 --------------
 108 Protocol Buffers wire types. These are used with `pb_encode_tag`_. ::
 109
 110     typedef enum {
 111         PB_WT_VARINT = 0,
 112         PB_WT_64BIT  = 1,
 113         PB_WT_STRING = 2,
 114         PB_WT_32BIT  = 5
 115     } pb_wire_type_t;
 116
 117 pb_encode.h
 118 ===========
 119
 120 pb_ostream_from_buffer
 121 ----------------------
 122 Constructs an output stream for writing into a memory buffer. This is just a helper function, it doesn't do anything you couldn't do yourself in a callback function. It uses an internal callback that stores the pointer in stream *state* field. ::
 123
 124     pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize);
 125
 126 :buf:           Memory buffer to write into.
 127 :bufsize:       Maximum number of bytes to write.
 128 :returns:       An output stream.
 129
 130 After writing, you can check *stream.bytes_written* to find out how much valid data there is in the buffer.
 131
 132 pb_write
 133 --------
 134 Writes data to an output stream. Always use this function, instead of trying to call stream callback manually. ::
 135
 136     bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count);
 137
 138 :stream:        Output stream to write to.
 139 :buf:           Pointer to buffer with the data to be written.
 140 :count:         Number of bytes to write.
 141 :returns:       True on success, false if maximum length is exceeded or an IO error happens.
 142
 143 If an error happens, *bytes_written* is not incremented. Depending on the callback used, calling pb_write again after it has failed once may be dangerous. Nanopb itself never does this, instead it returns the error to user application. The builtin pb_ostream_from_buffer is safe to call again after failed write.
 144
 145 pb_encode
 146 ---------
 147 Encodes the contents of a structure as a protocol buffers message and writes it to output stream. ::
 148
 149     bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
 150
 151 :stream:        Output stream to write to.
 152 :fields:        A field description array, usually autogenerated.
 153 :src_struct:    Pointer to the data that will be serialized.
 154 :returns:       True on success, false on IO error, on detectable errors in field description, or if a field encoder returns false.
 155
 156 Normally pb_encode simply walks through the fields description array and serializes each field in turn. However, submessages must be serialized twice: first to calculate their size and then to actually write them to output. This causes some constraints for callback fields, which must return the same data on every call.
 157
 158 .. sidebar:: Encoding fields manually
 159
 160     The functions with names *pb_encode_\** are used when dealing with callback fields. The typical reason for using callbacks is to have an array of unlimited size. In that case, `pb_encode`_ will call your callback function, which in turn will call *pb_encode_\** functions repeatedly to write out values.
 161
 162     The tag of a field must be encoded separately with `pb_encode_tag_for_field`_. After that, you can call exactly one of the content-writing functions to encode the payload of the field. For repeated fields, you can repeat this process multiple times.
 163
 164     Writing packed arrays is a little bit more involved: you need to use `pb_encode_tag` and specify `PB_WT_STRING` as the wire type. Then you need to know exactly how much data you are going to write, and use `pb_encode_varint`_ to write out the number of bytes before writing the actual data. Substreams can be used to determine the number of bytes beforehand; see `pb_encode_submessage`_ source code for an example.
 165
 166 pb_encode_tag
 167 -------------
 168 Starts a field in the Protocol Buffers binary format: encodes the field number and the wire type of the data. ::
 169
 170     bool pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, int field_number);
 171
 172 :stream:        Output stream to write to. 1-5 bytes will be written.
 173 :wiretype:      PB_WT_VARINT, PB_WT_64BIT, PB_WT_STRING or PB_WT_32BIT
 174 :field_number:  Identifier for the field, defined in the .proto file. You can get it from field->tag.
 175 :returns:       True on success, false on IO error.
 176
 177 pb_encode_tag_for_field
 178 -----------------------
 179 Same as `pb_encode_tag`_, except takes the parameters from a *pb_field_t* structure. ::
 180
 181     bool pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field);
 182
 183 :stream:        Output stream to write to. 1-5 bytes will be written.
 184 :field:         Field description structure. Usually autogenerated.
 185 :returns:       True on success, false on IO error or unknown field type.
 186
 187 This function only considers the LTYPE of the field. You can use it from your field callbacks, because the source generator writes correct LTYPE also for callback type fields.
 188
 189 Wire type mapping is as follows:
 190
 191 ========================= ============
 192 LTYPEs                    Wire type
 193 ========================= ============
 194 VARINT, SVARINT           PB_WT_VARINT
 195 FIXED64                   PB_WT_64BIT
 196 STRING, BYTES, SUBMESSAGE PB_WT_STRING
 197 FIXED32                   PB_WT_32BIT
 198 ========================= ============
 199
 200 pb_encode_varint
 201 ----------------
 202 Encodes a signed or unsigned integer in the varint_ format. Works for fields of type `bool`, `enum`, `int32`, `int64`, `uint32` and `uint64`::
 203
 204     bool pb_encode_varint(pb_ostream_t *stream, uint64_t value);
 205
 206 :stream:        Output stream to write to. 1-10 bytes will be written.
 207 :value:         Value to encode. Just cast e.g. int32_t directly to uint64_t.
 208 :returns:       True on success, false on IO error.
 209
 210 .. _varint: http://code.google.com/apis/protocolbuffers/docs/encoding.html#varints
 211
 212 pb_encode_svarint
 213 -----------------
 214 Encodes a signed integer in the 'zig-zagged' format. Works for fields of type `sint32` and `sint64`::
 215
 216     bool pb_encode_svarint(pb_ostream_t *stream, int64_t value);
 217
 218 (parameters are the same as for `pb_encode_varint`_
 219
 220 pb_encode_string
 221 ----------------
 222 Writes the length of a string as varint and then contents of the string. Works for fields of type `bytes` and `string`::
 223
 224     bool pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size);
 225
 226 :stream:        Output stream to write to.
 227 :buffer:        Pointer to string data.
 228 :size:          Number of bytes in the string. Pass `strlen(s)` for strings.
 229 :returns:       True on success, false on IO error.
 230
 231 pb_encode_fixed32
 232 -----------------
 233 Writes 4 bytes to stream and swaps bytes on big-endian architectures. Works for fields of type `fixed32`, `sfixed32` and `float`::
 234
 235     bool pb_encode_fixed32(pb_ostream_t *stream, const void *value);
 236
 237 :stream:    Output stream to write to.
 238 :value:     Pointer to a 4-bytes large C variable, for example `uint32_t foo;`.
 239 :returns:   True on success, false on IO error.
 240
 241 pb_encode_fixed64
 242 -----------------
 243 Writes 8 bytes to stream and swaps bytes on big-endian architecture. Works for fields of type `fixed64`, `sfixed64` and `double`::
 244
 245     bool pb_encode_fixed64(pb_ostream_t *stream, const void *value);
 246
 247 :stream:    Output stream to write to.
 248 :value:     Pointer to a 8-bytes large C variable, for example `uint64_t foo;`.
 249 :returns:   True on success, false on IO error.
 250
 251 pb_encode_submessage
 252 --------------------
 253 Encodes a submessage field, including the size header for it. Works for fields of any message type::
 254
 255     bool pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
 256
 257 :stream:        Output stream to write to.
 258 :fields:        Pointer to the autogenerated field description array for the submessage type, e.g. `MyMessage_fields`.
 259 :src:           Pointer to the structure where submessage data is.
 260 :returns:       True on success, false on IO errors, pb_encode errors or if submessage size changes between calls.
 261
 262 In Protocol Buffers format, the submessage size must be written before the submessage contents. Therefore, this function has to encode the submessage twice in order to know the size beforehand.
 263
 264 If the submessage contains callback fields, the callback function might misbehave and write out a different amount of data on the second call. This situation is recognized and *false* is returned, but garbage will be written to the output before the problem is detected.
 265
 266 pb_decode.h
 267 ===========
 268
 269 pb_istream_from_buffer
 270 ----------------------
 271 Helper function for creating an input stream that reads data from a memory buffer. ::
 272
 273     pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize);
 274
 275 :buf:           Pointer to byte array to read from.
 276 :bufsize:       Size of the byte array.
 277 :returns:       An input stream ready to use.
 278
 279 pb_read
 280 -------
 281 Read data from input stream. Always use this function, don't try to call the stream callback directly. ::
 282
 283     bool pb_read(pb_istream_t *stream, uint8_t *buf, size_t count);
 284
 285 :stream:        Input stream to read from.
 286 :buf:           Buffer to store the data to, or NULL to just read data without storing it anywhere.
 287 :count:         Number of bytes to read.
 288 :returns:       True on success, false if *stream->bytes_left* is less than *count* or if an IO error occurs.
 289
 290 End of file is signalled by *stream->bytes_left* being zero after pb_read returns false.
 291
 292 pb_decode
 293 ---------
 294 Read and decode all fields of a structure. Reads until EOF on input stream. ::
 295
 296     bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
 297
 298 :stream:        Input stream to read from.
 299 :fields:        A field description array. Usually autogenerated.
 300 :dest_struct:   Pointer to structure where data will be stored.
 301 :returns:       True on success, false on IO error, on detectable errors in field description, if a field encoder returns false or if a required field is missing.
 302
 303 In Protocol Buffers binary format, EOF is only allowed between fields. If it happens anywhere else, pb_decode will return *false*. If pb_decode returns false, you cannot trust any of the data in the structure.
 304
 305 In addition to EOF, the pb_decode implementation supports terminating a message with a 0 byte. This is compatible with the official Protocol Buffers because 0 is never a valid field tag.
 306
 307 For optional fields, this function applies the default value and sets *has_<field>* to false if the field is not present.
 308
 309 Because of memory concerns, the detection of missing required fields is not perfect if the structure contains more than 32 fields.
 310
 311 pb_decode_varint
 312 ----------------
 313 Read and decode a varint_ encoded integer. ::
 314
 315     bool pb_decode_varint(pb_istream_t *stream, uint64_t *dest);
 316
 317 :stream:        Input stream to read from. 1-10 bytes will be read.
 318 :dest:          Storage for the decoded integer. Value is undefined on error.
 319 :returns:       True on success, false if value exceeds uint64_t range or an IO error happens.
 320
 321 pb_skip_varint
 322 --------------
 323 Skip a varint_ encoded integer without decoding it. ::
 324
 325     bool pb_skip_varint(pb_istream_t *stream);
 326
 327 :stream:        Input stream to read from. Will read 1 byte at a time until the MSB is clear.
 328 :returns:       True on success, false on IO error.
 329
 330 pb_skip_string
 331 --------------
 332 Skip a varint-length-prefixed string. This means skipping a value with wire type PB_WT_STRING. ::
 333
 334     bool pb_skip_string(pb_istream_t *stream);
 335
 336 :stream:        Input stream to read from.
 337 :returns:       True on success, false on IO error or length exceeding uint32_t.
 338
 339 pb_decode_tag
 340 -------------
 341 Decode the tag that comes before field in the protobuf encoding::
 342
 343     bool pb_decode_tag(pb_istream_t *stream, pb_wire_type_t *wire_type, int *tag, bool *eof);
 344
 345 :stream:        Input stream to read from.
 346 :wire_type:     Pointer to variable where to store the wire type of the field.
 347 :tag:           Pointer to variable where to store the tag of the field.
 348 :eof:           Pointer to variable where to store end-of-file status.
 349 :returns:       True on success, false on error or EOF.
 350
 351 When the message (stream) ends, this function will return false and set *eof* to true. On other
 352 errors, *eof* will be set to false.
 353
 354 pb_skip_field
 355 -------------
 356 Remove the data for a field from the stream, without actually decoding it::
 357
 358     bool pb_skip_field(pb_istream_t *stream, pb_wire_type_t wire_type);
 359
 360 :stream:        Input stream to read from.
 361 :wire_type:     Type of field to skip.
 362 :returns:       True on success, false on IO error.
 363
 364 .. sidebar:: Field decoders
 365
 366     The functions with names beginning with *pb_dec_* are called field decoders. Each PB_LTYPE has an own field decoder, which handles translating from Protocol Buffers data to C data.
 367
 368     Each field decoder reads and decodes a single value. For arrays, the decoder is called repeatedly.
 369
 370     You can use the decoders from your callbacks. Just be aware that the pb_field_t passed to the callback is not directly compatible
 371     with the *varint* field decoders. Instead, you must create a new pb_field_t structure and set the data_size according to the data type
 372     you pass to *dest*, e.g. *field.data_size = sizeof(int);*. Other fields in the *pb_field_t* don't matter.
 373
 374     The field decoder interface is a bit messy as a result of the interface required inside the nanopb library.
 375     Eventually they may be replaced by separate wrapper functions with a more friendly interface.
 376
 377 pb_dec_varint
 378 -------------
 379 Field decoder for PB_LTYPE_VARINT. ::
 380
 381     bool pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest)
 382
 383 :stream:        Input stream to read from. 1-10 bytes will be read.
 384 :field:         Field description structure. Only *field->data_size* matters.
 385 :dest:          Pointer to destination integer. Must have size of *field->data_size* bytes.
 386 :returns:       True on success, false on IO errors or if `pb_decode_varint`_ fails.
 387
 388 This function first calls `pb_decode_varint`_. It then copies the first bytes of the 64-bit result value to *dest*, or on big endian architectures, the last bytes.
 389
 390 pb_dec_svarint
 391 --------------
 392 Field decoder for PB_LTYPE_SVARINT. Similar to `pb_dec_varint`_, except that it performs zigzag-decoding on the value. ::
 393
 394     bool pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest);
 395
 396 (parameters are the same as `pb_dec_varint`_)
 397
 398 pb_dec_fixed32
 399 --------------
 400 Field decoder for PB_LTYPE_FIXED32. ::
 401
 402     bool pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest);
 403
 404 :stream:        Input stream to read from. 4 bytes will be read.
 405 :field:         Not used.
 406 :dest:          Pointer to destination *int32_t*, *uint32_t* or *float*.
 407 :returns:       True on success, false on IO errors.
 408
 409 This function reads 4 bytes from the input stream.
 410 On big endian architectures, it then reverses the order of the bytes.
 411 Finally, it writes the bytes to *dest*.
 412
 413 pb_dec_fixed64
 414 --------------
 415 Field decoder for PB_LTYPE_FIXED64. ::
 416
 417     bool pb_dec_fixed(pb_istream_t *stream, const pb_field_t *field, void *dest);
 418
 419 :stream:        Input stream to read from. 8 bytes will be read.
 420 :field:         Not used.
 421 :dest:          Pointer to destination *int64_t*, *uint64_t* or *double*.
 422 :returns:       True on success, false on IO errors.
 423
 424 Same as `pb_dec_fixed32`_, except this reads 8 bytes.
 425
 426 pb_dec_bytes
 427 ------------
 428 Field decoder for PB_LTYPE_BYTES. Reads a length-prefixed block of bytes. ::
 429
 430     bool pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest);
 431
 432 **Note:** This is an internal function that is not useful in decoder callbacks. To read bytes fields in callbacks, use
 433 *stream->bytes_left* and `pb_read`_.
 434
 435 :stream:        Input stream to read from.
 436 :field:         Field description structure. Only *field->data_size* matters.
 437 :dest:          Pointer to a structure similar to pb_bytes_array_t.
 438 :returns:       True on success, false on IO error or if length exceeds the array size.
 439
 440 This function expects a pointer to a structure with a *size_t* field at start, and a variable sized byte array after it. It will deduce the maximum size of the array from *field->data_size*.
 441
 442 pb_dec_string
 443 -------------
 444 Field decoder for PB_LTYPE_STRING. Reads a length-prefixed string. ::
 445
 446     bool pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest);
 447
 448 **Note:** This is an internal function that is not useful in decoder callbacks. To read string fields in callbacks, use
 449 *stream->bytes_left* and `pb_read`_.
 450
 451 :stream:        Input stream to read from.
 452 :field:         Field description structure. Only *field->data_size* matters.
 453 :dest:          Pointer to a character array of size *field->data_size*.
 454 :returns:       True on success, false on IO error or if length exceeds the array size.
 455
 456 This function null-terminates the string when successful. On error, the contents of the destination array is undefined.
 457
 458 pb_dec_submessage
 459 -----------------
 460 Field decoder for PB_LTYPE_SUBMESSAGE. Calls `pb_decode`_ to perform the actual decoding. ::
 461
 462     bool pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest)
 463
 464 **Note:** This is an internal function that is not useful in decoder callbacks. To read submessage fields in callbacks, use
 465 `pb_decode`_ directly.
 466
 467 :stream:        Input stream to read from.
 468 :field:         Field description structure. Only *field->ptr* matters.
 469 :dest:          Pointer to the destination structure.
 470 :returns:       True on success, false on IO error or if `pb_decode`_ fails.
 471
 472 The *field->ptr* should be a pointer to *pb_field_t* array describing the submessage.
 473