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