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