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 PB_HTYPE_CALLBACK    0x30  A field with dynamic storage size, data is
  41                            actually a pointer to a structure containing a
  42                            callback function.
  43 ==================== ===== ================================================
  44
  45 pb_field_t
  46 ----------
  47 Describes a single structure field with memory position in relation to others. The descriptions are usually autogenerated. ::
  48
  49     typedef struct _pb_field_t pb_field_t;
  50     struct _pb_field_t {
  51         uint8_t tag;
  52         pb_type_t type;
  53         uint8_t data_offset;
  54         int8_t size_offset;
  55         uint8_t data_size;
  56         uint8_t array_size;
  57         const void *ptr;
  58     } pb_packed;
  59
  60 :tag:           Tag number of the field or 0 to terminate a list of fields.
  61 :type:          LTYPE and HTYPE of the field.
  62 :data_offset:   Offset of field data, relative to the end of the previous field.
  63 :size_offset:   Offset of *bool* flag for optional fields or *size_t* count for arrays, relative to field data.
  64 :data_size:     Size of a single data entry, in bytes.
  65 :array_size:    Maximum number of entries in an array, if it is an array type.
  66 :ptr:           Pointer to default value for optional fields, or to submessage description for PB_LTYPE_SUBMESSAGE.
  67
  68 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.
  69
  70 pb_bytes_array_t
  71 ----------------
  72 An byte array with a field for storing the length::
  73
  74     typedef struct {
  75         size_t size;
  76         uint8_t bytes[1];
  77     } pb_bytes_array_t;
  78
  79 In an actual array, the length of *bytes* may be different.
  80
  81 pb_callback_t
  82 -------------
  83 Part of a message structure, for fields with type PB_HTYPE_CALLBACK::
  84
  85     typedef struct _pb_callback_t pb_callback_t;
  86     struct _pb_callback_t {
  87         union {
  88             bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void *arg);
  89             bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg);
  90         } funcs;
  91
  92         void *arg;
  93     };
  94
  95 The *arg* is passed to the callback when calling. It can be used to store any information that the callback might need.
  96
  97 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.
  98
  99 pb_wire_type_t
 100 --------------
 101 Protocol Buffers wire types. These are used with `pb_encode_tag`_. ::
 102
 103     typedef enum {
 104         PB_WT_VARINT = 0,
 105         PB_WT_64BIT  = 1,
 106         PB_WT_STRING = 2,
 107         PB_WT_32BIT  = 5
 108     } pb_wire_type_t;
 109
 110 pb_encode.h
 111 ===========
 112
 113 pb_ostream_from_buffer
 114 ----------------------
 115 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. ::
 116
 117     pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize);
 118
 119 :buf:           Memory buffer to write into.
 120 :bufsize:       Maximum number of bytes to write.
 121 :returns:       An output stream.
 122
 123 After writing, you can check *stream.bytes_written* to find out how much valid data there is in the buffer.
 124
 125 pb_write
 126 --------
 127 Writes data to an output stream. Always use this function, instead of trying to call stream callback manually. ::
 128
 129     bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count);
 130
 131 :stream:        Output stream to write to.
 132 :buf:           Pointer to buffer with the data to be written.
 133 :count:         Number of bytes to write.
 134 :returns:       True on success, false if maximum length is exceeded or an IO error happens.
 135
 136 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.
 137
 138 pb_encode
 139 ---------
 140 Encodes the contents of a structure as a protocol buffers message and writes it to output stream. ::
 141
 142     bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
 143
 144 :stream:        Output stream to write to.
 145 :fields:        A field description array, usually autogenerated.
 146 :src_struct:    Pointer to the data that will be serialized.
 147 :returns:       True on success, false on IO error, on detectable errors in field description, or if a field encoder returns false.
 148
 149 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.
 150
 151 pb_encode_varint
 152 ----------------
 153 Encodes an unsigned integer in the varint_ format. ::
 154
 155     bool pb_encode_varint(pb_ostream_t *stream, uint64_t value);
 156
 157 :stream:        Output stream to write to. 1-10 bytes will be written.
 158 :value:         Value to encode.
 159 :returns:       True on success, false on IO error.
 160
 161 .. _varint: http://code.google.com/apis/protocolbuffers/docs/encoding.html#varints
 162
 163 pb_encode_tag
 164 -------------
 165 Starts a field in the Protocol Buffers binary format: encodes the field number and the wire type of the data. ::
 166
 167     bool pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, int field_number);
 168
 169 :stream:        Output stream to write to. 1-5 bytes will be written.
 170 :wiretype:      PB_WT_VARINT, PB_WT_64BIT, PB_WT_STRING or PB_WT_32BIT
 171 :field_number:  Identifier for the field, defined in the .proto file.
 172 :returns:       True on success, false on IO error.
 173
 174 pb_encode_tag_for_field
 175 -----------------------
 176 Same as `pb_encode_tag`_, except takes the parameters from a *pb_field_t* structure. ::
 177
 178     bool pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field);
 179
 180 :stream:        Output stream to write to. 1-5 bytes will be written.
 181 :field:         Field description structure. Usually autogenerated.
 182 :returns:       True on success, false on IO error or unknown field type.
 183
 184 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.
 185
 186 pb_encode_string
 187 ----------------
 188 Writes the length of a string as varint and then contents of the string. Used for writing fields with wire type PB_WT_STRING. ::
 189
 190     bool pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size);
 191
 192 :stream:        Output stream to write to.
 193 :buffer:        Pointer to string data.
 194 :size:          Number of bytes in the string.
 195 :returns:       True on success, false on IO error.
 196
 197 .. sidebar:: Field encoders
 198
 199     The functions with names beginning with *pb_enc_* are called field encoders. Each PB_LTYPE has an own field encoder, which handles translating from C data into Protocol Buffers data.
 200
 201     By using the *data_size* in the field description and by taking advantage of C casting rules, it has been possible to combine many data types to a single LTYPE. For example, *int32*, *uint32*, *int64*, *uint64*, *bool* and *enum* are all handled by *pb_enc_varint*.
 202
 203     Each field encoder only encodes the contents of the field. The tag must be encoded separately with `pb_encode_tag_for_field`_.
 204
 205     You can use the field encoders from your callbacks.
 206
 207 pb_enc_varint
 208 -------------
 209 Field encoder for PB_LTYPE_VARINT. Takes the first *field->data_size* bytes from src, casts them as *uint64_t* and calls `pb_encode_varint`_. ::
 210
 211     bool pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
 212
 213 :stream:        Output stream to write to.
 214 :field:         Field description structure. Only *data_size* matters.
 215 :src:           Pointer to start of the field data.
 216 :returns:       True on success, false on IO error.
 217
 218 pb_enc_svarint
 219 --------------
 220 Field encoder for PB_LTYPE_SVARINT. Similar to `pb_enc_varint`_, except first zig-zag encodes the value for more efficient negative number encoding. ::
 221
 222     bool pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
 223
 224 (parameters are the same as for `pb_enc_varint`_)
 225
 226 The number is considered negative if the high-order bit of the value is set. On big endian computers, it is the highest bit of *\*src*. On little endian computers, it is the highest bit of *\*(src + field->data_size - 1)*.
 227
 228 pb_enc_fixed
 229 ------------
 230 Field encoder for PB_LTYPE_FIXED. Writes the data in little endian order. On big endian computers, reverses the order of bytes. ::
 231
 232     bool pb_enc_fixed(pb_ostream_t *stream, const pb_field_t *field, const void *src);
 233
 234 (parameters are the same as for `pb_enc_varint`_)
 235
 236 The same function is used for both integers, floats and doubles. This break encoding of double values on architectures where they are mixed endian (primarily some arm processors with hardware FPU).
 237
 238 pb_enc_bytes
 239 ------------
 240 Field encoder for PB_LTYPE_BYTES. Just calls `pb_encode_string`_. ::
 241
 242     bool pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src);
 243
 244 :stream:        Output stream to write to.
 245 :field:         Not used.
 246 :src:           Pointer to a structure similar to pb_bytes_array_t.
 247 :returns:       True on success, false on IO error.
 248
 249 This function expects a pointer to a structure with a *size_t* field at start, and a variable sized byte array after it. The platform-specific field offset is inferred from *pb_bytes_array_t*, which has a byte array of size 1.
 250
 251 pb_enc_string
 252 -------------
 253 Field encoder for PB_LTYPE_STRING. Determines size of string with strlen() and then calls `pb_encode_string`_. ::
 254
 255     bool pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src);
 256
 257 :stream:        Output stream to write to.
 258 :field:         Not used.
 259 :src:           Pointer to a null-terminated string.
 260 :returns:       True on success, false on IO error.
 261
 262 pb_enc_submessage
 263 -----------------
 264 Field encoder for PB_LTYPE_SUBMESSAGE. Calls `pb_encode`_ to perform the actual encoding. ::
 265
 266     bool pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src);
 267
 268 :stream:        Output stream to write to.
 269 :field:         Field description structure. The *ptr* field must be a pointer to a field description array for the submessage.
 270 :src:           Pointer to the structure where submessage data is.
 271 :returns:       True on success, false on IO errors, pb_encode errors or if submessage size changes between calls.
 272
 273 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.
 274
 275 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 it is up to the caller to ensure that the receiver of the message does not interpret it as valid data.
 276
 277 pb_decode.h
 278 ===========
 279
 280 pb_istream_from_buffer
 281 ----------------------
 282 Helper function for creating an input stream that reads data from a memory buffer. ::
 283
 284     pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize);
 285
 286 :buf:           Pointer to byte array to read from.
 287 :bufsize:       Size of the byte array.
 288 :returns:       An input stream ready to use.
 289
 290 pb_read
 291 -------
 292 Read data from input stream. Always use this function, don't try to call the stream callback directly. ::
 293
 294     bool pb_read(pb_istream_t *stream, uint8_t *buf, size_t count);
 295
 296 :stream:        Input stream to read from.
 297 :buf:           Buffer to store the data to, or NULL to just read data without storing it anywhere.
 298 :count:         Number of bytes to read.
 299 :returns:       True on success, false if *stream->bytes_left* is less than *count* or if an IO error occurs.
 300
 301 End of file is signalled by *stream->bytes_left* being zero after pb_read returns false.
 302
 303 pb_decode_varint
 304 ----------------
 305 Read and decode a varint_ encoded integer. ::
 306
 307     bool pb_decode_varint(pb_istream_t *stream, uint64_t *dest);
 308
 309 :stream:        Input stream to read from. 1-10 bytes will be read.
 310 :dest:          Storage for the decoded integer. Value is undefined on error.
 311 :returns:       True on success, false if value exceeds uint64_t range or an IO error happens.
 312
 313 pb_skip_varint
 314 --------------
 315 Skip a varint_ encoded integer without decoding it. ::
 316
 317     bool pb_skip_varint(pb_istream_t *stream);
 318
 319 :stream:        Input stream to read from. Will read 1 byte at a time until the MSB is clear.
 320 :returns:       True on success, false on IO error.
 321
 322 pb_skip_string
 323 --------------
 324 Skip a varint-length-prefixed string. This means skipping a value with wire type PB_WT_STRING. ::
 325
 326     bool pb_skip_string(pb_istream_t *stream);
 327
 328 :stream:        Input stream to read from.
 329 :returns:       True on success, false on IO error or length exceeding uint32_t.
 330
 331 pb_decode
 332 ---------
 333 Read and decode all fields of a structure. Reads until EOF on input stream. ::
 334
 335     bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
 336
 337 :stream:        Input stream to read from.
 338 :fields:        A field description array. Usually autogenerated.
 339 :dest_struct:   Pointer to structure where data will be stored.
 340 :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.
 341
 342 In Protocol Buffers binary format, EOF is only allowed between fields. If it happens anywhere else, pb_decode will return *false*.
 343
 344 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.
 345
 346 For optional fields, this function applies the default value and sets *has_<field>* to false if the field is not present.
 347
 348 Because of memory concerns, the detection of missing required fields is not perfect if the structure contains more than 32 fields.
 349
 350 .. sidebar:: Field decoders
 351
 352     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.
 353
 354     Each field decoder reads and decodes a single value. For arrays, the decoder is called repeatedly.
 355
 356     You can use the decoders from your callbacks.
 357
 358 pb_dec_varint
 359 -------------
 360 Field decoder for PB_LTYPE_VARINT. ::
 361
 362     bool pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest)
 363
 364 :stream:        Input stream to read from. 1-10 bytes will be read.
 365 :field:         Field description structure. Only *field->data_size* matters.
 366 :dest:          Pointer to destination integer. Must have size of *field->data_size* bytes.
 367 :returns:       True on success, false on IO errors or if `pb_decode_varint`_ fails.
 368
 369 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.
 370
 371 pb_dec_svarint
 372 --------------
 373 Field decoder for PB_LTYPE_SVARINT. Similar to `pb_dec_varint`_, except that it performs zigzag-decoding on the value. ::
 374
 375     bool pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest);
 376
 377 (parameters are the same as `pb_dec_varint`_)
 378
 379 pb_dec_fixed
 380 ------------
 381 Field decoder for PB_LTYPE_FIXED. ::
 382
 383     bool pb_dec_fixed(pb_istream_t *stream, const pb_field_t *field, void *dest);
 384
 385 (parameters are the same as `pb_dec_varint`_)
 386
 387 This function reads *field->data_size* bytes from the input stream.
 388 On big endian architectures, it then reverses the order of the bytes.
 389 Finally, it writes the bytes to *dest*.
 390
 391 pb_dec_bytes
 392 ------------
 393 Field decoder for PB_LTYPE_BYTES. Reads a length-prefixed block of bytes. ::
 394
 395     bool pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest);
 396
 397 :stream:        Input stream to read from.
 398 :field:         Field description structure. Only *field->data_size* matters.
 399 :dest:          Pointer to a structure similar to pb_bytes_array_t.
 400 :returns:       True on success, false on IO error or if length exceeds the array size.
 401
 402 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*.
 403
 404 pb_dec_string
 405 -------------
 406 Field decoder for PB_LTYPE_STRING. Reads a length-prefixed string. ::
 407
 408     bool pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest);
 409
 410 :stream:        Input stream to read from.
 411 :field:         Field description structure. Only *field->data_size* matters.
 412 :dest:          Pointer to a character array of size *field->data_size*.
 413 :returns:       True on success, false on IO error or if length exceeds the array size.
 414
 415 This function null-terminates the string when successful. On error, the contents of the destination array is undefined.
 416
 417 pb_dec_submessage
 418 -----------------
 419 Field decoder for PB_LTYPE_SUBMESSAGE. Calls `pb_decode`_ to perform the actual decoding. ::
 420
 421     bool pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest)
 422
 423 :stream:        Input stream to read from.
 424 :field:         Field description structure. Only *field->ptr* matters.
 425 :dest:          Pointer to the destination structure.
 426 :returns:       True on success, false on IO error or if `pb_decode`_ fails.
 427
 428 The *field->ptr* should be a pointer to *pb_field_t* array describing the submessage.
 429