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