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 PB_MAX_REQUIRED_FIELDS         Maximum number of required fields to check for presence. Default value is 64. Increases stack
  18                                usage 1 byte per every 8 fields. Compiler warning will tell if you need this.
  19 PB_FIELD_16BIT                 Add support for tag numbers > 255 and fields larger than 255 bytes or 255 array entries.
  20                                Increases code size 3 bytes per each field. Compiler error will tell if you need this.
  21 PB_FIELD_32BIT                 Add support for tag numbers > 65535 and fields larger than 65535 bytes or 65535 array entries.
  22                                Increases code size 9 bytes per each field. Compiler error will tell if you need this.
  23 PB_NO_ERRMSG                   Disables the support for error messages; only error information is the true/false return value.
  24                                Decreases the code size by a few hundred bytes.
  25 ============================  ================================================================================================
  26
  27 The PB_MAX_REQUIRED_FIELDS, PB_FIELD_16BIT and PB_FIELD_32BIT settings allow raising some datatype limits to suit larger messages.
  28 Their need is recognized automatically by C-preprocessor #if-directives in the generated .pb.h files. The default setting is to use
  29 the smallest datatypes (least resources used).
  30
  31 pb.h
  32 ====
  33
  34 pb_type_t
  35 ---------
  36 Defines the encoder/decoder behaviour that should be used for a field. ::
  37
  38     typedef enum { ... } pb_type_t;
  39
  40 The low-order byte of the enumeration values defines the function that can be used for encoding and decoding the field data:
  41
  42 ==================== ===== ================================================
  43 LTYPE identifier     Value Storage format
  44 ==================== ===== ================================================
  45 PB_LTYPE_VARINT      0x00  Integer.
  46 PB_LTYPE_SVARINT     0x01  Integer, zigzag encoded.
  47 PB_LTYPE_FIXED       0x02  Integer or floating point.
  48 PB_LTYPE_BYTES       0x03  Structure with *size_t* field and byte array.
  49 PB_LTYPE_STRING      0x04  Null-terminated string.
  50 PB_LTYPE_SUBMESSAGE  0x05  Submessage structure.
  51 ==================== ===== ================================================
  52
  53 The high-order byte defines whether the field is required, optional, repeated or callback:
  54
  55 ==================== ===== ================================================
  56 HTYPE identifier     Value Field handling
  57 ==================== ===== ================================================
  58 PB_HTYPE_REQUIRED    0x00  Verify that field exists in decoded message.
  59 PB_HTYPE_OPTIONAL    0x10  Use separate *has_<field>* boolean to specify
  60                            whether the field is present.
  61 PB_HTYPE_ARRAY       0x20  A repeated field with preallocated array.
  62                            Separate *<field>_count* for number of items.
  63 PB_HTYPE_CALLBACK    0x30  A field with dynamic storage size, data is
  64                            actually a pointer to a structure containing a
  65                            callback function.
  66 ==================== ===== ================================================
  67
  68 pb_field_t
  69 ----------
  70 Describes a single structure field with memory position in relation to others. The descriptions are usually autogenerated. ::
  71
  72     typedef struct _pb_field_t pb_field_t;
  73     struct _pb_field_t {
  74         uint8_t tag;
  75         pb_type_t type;
  76         uint8_t data_offset;
  77         int8_t size_offset;
  78         uint8_t data_size;
  79         uint8_t array_size;
  80         const void *ptr;
  81     } pb_packed;
  82
  83 :tag:           Tag number of the field or 0 to terminate a list of fields.
  84 :type:          LTYPE and HTYPE of the field.
  85 :data_offset:   Offset of field data, relative to the end of the previous field.
  86 :size_offset:   Offset of *bool* flag for optional fields or *size_t* count for arrays, relative to field data.
  87 :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.
  88 :array_size:    Maximum number of entries in an array, if it is an array type.
  89 :ptr:           Pointer to default value for optional fields, or to submessage description for PB_LTYPE_SUBMESSAGE.
  90
  91 The *uint8_t* datatypes limit the maximum size of a single item to 255 bytes and arrays to 255 items. Compiler will give error if the values are too large. The types can be changed to larger ones by defining *PB_FIELD_16BIT*.
  92
  93 pb_bytes_array_t
  94 ----------------
  95 An byte array with a field for storing the length::
  96
  97     typedef struct {
  98         size_t size;
  99         uint8_t bytes[1];
 100     } pb_bytes_array_t;
 101
 102 In an actual array, the length of *bytes* may be different.
 103
 104 pb_callback_t
 105 -------------
 106 Part of a message structure, for fields with type PB_HTYPE_CALLBACK::
 107
 108     typedef struct _pb_callback_t pb_callback_t;
 109     struct _pb_callback_t {
 110         union {
 111             bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void *arg);
 112             bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg);
 113         } funcs;
 114
 115         void *arg;
 116     };
 117
 118 The *arg* is passed to the callback when calling. It can be used to store any information that the callback might need.
 119
 120 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.
 121
 122 pb_wire_type_t
 123 --------------
 124 Protocol Buffers wire types. These are used with `pb_encode_tag`_. ::
 125
 126     typedef enum {
 127         PB_WT_VARINT = 0,
 128         PB_WT_64BIT  = 1,
 129         PB_WT_STRING = 2,
 130         PB_WT_32BIT  = 5
 131     } pb_wire_type_t;
 132
 133 pb_encode.h
 134 ===========
 135
 136 pb_ostream_from_buffer
 137 ----------------------
 138 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. ::
 139
 140     pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize);
 141
 142 :buf:           Memory buffer to write into.
 143 :bufsize:       Maximum number of bytes to write.
 144 :returns:       An output stream.
 145
 146 After writing, you can check *stream.bytes_written* to find out how much valid data there is in the buffer.
 147
 148 pb_write
 149 --------
 150 Writes data to an output stream. Always use this function, instead of trying to call stream callback manually. ::
 151
 152     bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count);
 153
 154 :stream:        Output stream to write to.
 155 :buf:           Pointer to buffer with the data to be written.
 156 :count:         Number of bytes to write.
 157 :returns:       True on success, false if maximum length is exceeded or an IO error happens.
 158
 159 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.
 160
 161 pb_encode
 162 ---------
 163 Encodes the contents of a structure as a protocol buffers message and writes it to output stream. ::
 164
 165     bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
 166
 167 :stream:        Output stream to write to.
 168 :fields:        A field description array, usually autogenerated.
 169 :src_struct:    Pointer to the data that will be serialized.
 170 :returns:       True on success, false on IO error, on detectable errors in field description, or if a field encoder returns false.
 171
 172 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.
 173
 174 .. sidebar:: Encoding fields manually
 175
 176     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.
 177
 178     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.
 179
 180     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.
 181
 182 pb_encode_tag
 183 -------------
 184 Starts a field in the Protocol Buffers binary format: encodes the field number and the wire type of the data. ::
 185
 186     bool pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, int field_number);
 187
 188 :stream:        Output stream to write to. 1-5 bytes will be written.
 189 :wiretype:      PB_WT_VARINT, PB_WT_64BIT, PB_WT_STRING or PB_WT_32BIT
 190 :field_number:  Identifier for the field, defined in the .proto file. You can get it from field->tag.
 191 :returns:       True on success, false on IO error.
 192
 193 pb_encode_tag_for_field
 194 -----------------------
 195 Same as `pb_encode_tag`_, except takes the parameters from a *pb_field_t* structure. ::
 196
 197     bool pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field);
 198
 199 :stream:        Output stream to write to. 1-5 bytes will be written.
 200 :field:         Field description structure. Usually autogenerated.
 201 :returns:       True on success, false on IO error or unknown field type.
 202
 203 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.
 204
 205 Wire type mapping is as follows:
 206
 207 ========================= ============
 208 LTYPEs                    Wire type
 209 ========================= ============
 210 VARINT, SVARINT           PB_WT_VARINT
 211 FIXED64                   PB_WT_64BIT
 212 STRING, BYTES, SUBMESSAGE PB_WT_STRING
 213 FIXED32                   PB_WT_32BIT
 214 ========================= ============
 215
 216 pb_encode_varint
 217 ----------------
 218 Encodes a signed or unsigned integer in the varint_ format. Works for fields of type `bool`, `enum`, `int32`, `int64`, `uint32` and `uint64`::
 219
 220     bool pb_encode_varint(pb_ostream_t *stream, uint64_t value);
 221
 222 :stream:        Output stream to write to. 1-10 bytes will be written.
 223 :value:         Value to encode. Just cast e.g. int32_t directly to uint64_t.
 224 :returns:       True on success, false on IO error.
 225
 226 .. _varint: http://code.google.com/apis/protocolbuffers/docs/encoding.html#varints
 227
 228 pb_encode_svarint
 229 -----------------
 230 Encodes a signed integer in the 'zig-zagged' format. Works for fields of type `sint32` and `sint64`::
 231
 232     bool pb_encode_svarint(pb_ostream_t *stream, int64_t value);
 233
 234 (parameters are the same as for `pb_encode_varint`_
 235
 236 pb_encode_string
 237 ----------------
 238 Writes the length of a string as varint and then contents of the string. Works for fields of type `bytes` and `string`::
 239
 240     bool pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size);
 241
 242 :stream:        Output stream to write to.
 243 :buffer:        Pointer to string data.
 244 :size:          Number of bytes in the string. Pass `strlen(s)` for strings.
 245 :returns:       True on success, false on IO error.
 246
 247 pb_encode_fixed32
 248 -----------------
 249 Writes 4 bytes to stream and swaps bytes on big-endian architectures. Works for fields of type `fixed32`, `sfixed32` and `float`::
 250
 251     bool pb_encode_fixed32(pb_ostream_t *stream, const void *value);
 252
 253 :stream:    Output stream to write to.
 254 :value:     Pointer to a 4-bytes large C variable, for example `uint32_t foo;`.
 255 :returns:   True on success, false on IO error.
 256
 257 pb_encode_fixed64
 258 -----------------
 259 Writes 8 bytes to stream and swaps bytes on big-endian architecture. Works for fields of type `fixed64`, `sfixed64` and `double`::
 260
 261     bool pb_encode_fixed64(pb_ostream_t *stream, const void *value);
 262
 263 :stream:    Output stream to write to.
 264 :value:     Pointer to a 8-bytes large C variable, for example `uint64_t foo;`.
 265 :returns:   True on success, false on IO error.
 266
 267 pb_encode_submessage
 268 --------------------
 269 Encodes a submessage field, including the size header for it. Works for fields of any message type::
 270
 271     bool pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
 272
 273 :stream:        Output stream to write to.
 274 :fields:        Pointer to the autogenerated field description array for the submessage type, e.g. `MyMessage_fields`.
 275 :src:           Pointer to the structure where submessage data is.
 276 :returns:       True on success, false on IO errors, pb_encode errors or if submessage size changes between calls.
 277
 278 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.
 279
 280 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.
 281
 282 pb_decode.h
 283 ===========
 284
 285 pb_istream_from_buffer
 286 ----------------------
 287 Helper function for creating an input stream that reads data from a memory buffer. ::
 288
 289     pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize);
 290
 291 :buf:           Pointer to byte array to read from.
 292 :bufsize:       Size of the byte array.
 293 :returns:       An input stream ready to use.
 294
 295 pb_read
 296 -------
 297 Read data from input stream. Always use this function, don't try to call the stream callback directly. ::
 298
 299     bool pb_read(pb_istream_t *stream, uint8_t *buf, size_t count);
 300
 301 :stream:        Input stream to read from.
 302 :buf:           Buffer to store the data to, or NULL to just read data without storing it anywhere.
 303 :count:         Number of bytes to read.
 304 :returns:       True on success, false if *stream->bytes_left* is less than *count* or if an IO error occurs.
 305
 306 End of file is signalled by *stream->bytes_left* being zero after pb_read returns false.
 307
 308 pb_decode
 309 ---------
 310 Read and decode all fields of a structure. Reads until EOF on input stream. ::
 311
 312     bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
 313
 314 :stream:        Input stream to read from.
 315 :fields:        A field description array. Usually autogenerated.
 316 :dest_struct:   Pointer to structure where data will be stored.
 317 :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.
 318
 319 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.
 320
 321 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.
 322
 323 For optional fields, this function applies the default value and sets *has_<field>* to false if the field is not present.
 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:: Decoding fields manually
 369
 370     The functions with names beginning with *pb_decode_* 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_decode`_ will call your callback function repeatedly, which can then store the values into e.g. filesystem in the order received in.
 371
 372     For decoding numeric (including enumerated and boolean) values, use `pb_decode_varint`_, `pb_decode_svarint`_, `pb_decode_fixed32`_ and `pb_decode_fixed64`_. They take a pointer to a 32- or 64-bit C variable, which you may then cast to smaller datatype for storage.
 373
 374     For decoding strings and bytes fields, the length has already been decoded. You can therefore check the total length in *stream->state* and read the data using `pb_read`_.
 375
 376     Finally, for decoding submessages in a callback, simply use `pb_decode`_ and pass it the *SubMessage_fields* descriptor array.
 377
 378 pb_decode_varint
 379 ----------------
 380 Read and decode a varint_ encoded integer. ::
 381
 382     bool pb_decode_varint(pb_istream_t *stream, uint64_t *dest);
 383
 384 :stream:        Input stream to read from. 1-10 bytes will be read.
 385 :dest:          Storage for the decoded integer. Value is undefined on error.
 386 :returns:       True on success, false if value exceeds uint64_t range or an IO error happens.
 387
 388 pb_decode_svarint
 389 -----------------
 390 Similar to `pb_decode_varint`_, except that it performs zigzag-decoding on the value. This corresponds to the Protocol Buffers *sint32* and *sint64* datatypes. ::
 391
 392     bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest);
 393
 394 (parameters are the same as `pb_decode_varint`_)
 395
 396 pb_decode_fixed32
 397 -----------------
 398 Decode a *fixed32*, *sfixed32* or *float* value. ::
 399
 400     bool pb_decode_fixed32(pb_istream_t *stream, void *dest);
 401
 402 :stream:        Input stream to read from. 4 bytes will be read.
 403 :dest:          Pointer to destination *int32_t*, *uint32_t* or *float*.
 404 :returns:       True on success, false on IO errors.
 405
 406 This function reads 4 bytes from the input stream.
 407 On big endian architectures, it then reverses the order of the bytes.
 408 Finally, it writes the bytes to *dest*.
 409
 410 pb_decode_fixed64
 411 -----------------
 412 Decode a *fixed64*, *sfixed64* or *double* value. ::
 413
 414     bool pb_dec_fixed(pb_istream_t *stream, const pb_field_t *field, void *dest);
 415
 416 :stream:        Input stream to read from. 8 bytes will be read.
 417 :field:         Not used.
 418 :dest:          Pointer to destination *int64_t*, *uint64_t* or *double*.
 419 :returns:       True on success, false on IO errors.
 420
 421 Same as `pb_decode_fixed32`_, except this reads 8 bytes.
 422
 423 pb_make_string_substream
 424 ------------------------
 425 Decode the length for a field with wire type *PB_WT_STRING* and create a substream for reading the data. ::
 426
 427     bool pb_make_string_substream(pb_istream_t *stream, pb_istream_t *substream);
 428
 429 :stream:        Original input stream to read the length and data from.
 430 :substream:     New substream that has limited length. Filled in by the function.
 431 :returns:       True on success, false if reading the length fails.
 432
 433 This function uses `pb_decode_varint`_ to read an integer from the stream. This is interpreted as a number of bytes, and the substream is set up so that its `bytes_left` is initially the same as the length, and its callback function and state the same as the parent stream.
 434
 435 pb_close_string_substream
 436 -------------------------
 437 Close the substream created with `pb_make_string_substream`_. ::
 438
 439     void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream);
 440
 441 :stream:        Original input stream to read the length and data from.
 442 :substream:     Substream to close
 443
 444 This function copies back the state from the substream to the parent stream.
 445 It must be called after done with the substream.