docs/reference.rst

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