VOC / Mbed 2 deprecated Dumb_box_rev2

test

Dependencies:   Nanopb iSerial mbed BaseJpegDecode FatFileSystem SDFileSystem RingBuffer Camera_LS_Y201

Nanopb/pb_encode.h@0:d69efd0ee139, 2014-09-18 (annotated)

Committer:
cgraham
Date:
Thu Sep 18 15:21:47 2014 +0000
Revision:
0:d69efd0ee139
test

Who changed what in which revision?

UserRevisionLine numberNew contents of line
cgraham 0:d69efd0ee139 1 /* pb_encode.h: Functions to encode protocol buffers. Depends on pb_encode.c.
cgraham 0:d69efd0ee139 2 * The main function is pb_encode. You also need an output stream, and the
cgraham 0:d69efd0ee139 3 * field descriptions created by nanopb_generator.py.
cgraham 0:d69efd0ee139 4 */
cgraham 0:d69efd0ee139 5
cgraham 0:d69efd0ee139 6 #ifndef _PB_ENCODE_H_
cgraham 0:d69efd0ee139 7 #define _PB_ENCODE_H_
cgraham 0:d69efd0ee139 8
cgraham 0:d69efd0ee139 9 #include "pb.h"
cgraham 0:d69efd0ee139 10
cgraham 0:d69efd0ee139 11 #ifdef __cplusplus
cgraham 0:d69efd0ee139 12 extern "C" {
cgraham 0:d69efd0ee139 13 #endif
cgraham 0:d69efd0ee139 14
cgraham 0:d69efd0ee139 15 /* Structure for defining custom output streams. You will need to provide
cgraham 0:d69efd0ee139 16 * a callback function to write the bytes to your storage, which can be
cgraham 0:d69efd0ee139 17 * for example a file or a network socket.
cgraham 0:d69efd0ee139 18 *
cgraham 0:d69efd0ee139 19 * The callback must conform to these rules:
cgraham 0:d69efd0ee139 20 *
cgraham 0:d69efd0ee139 21 * 1) Return false on IO errors. This will cause encoding to abort.
cgraham 0:d69efd0ee139 22 * 2) You can use state to store your own data (e.g. buffer pointer).
cgraham 0:d69efd0ee139 23 * 3) pb_write will update bytes_written after your callback runs.
cgraham 0:d69efd0ee139 24 * 4) Substreams will modify max_size and bytes_written. Don't use them
cgraham 0:d69efd0ee139 25 * to calculate any pointers.
cgraham 0:d69efd0ee139 26 */
cgraham 0:d69efd0ee139 27 struct _pb_ostream_t
cgraham 0:d69efd0ee139 28 {
cgraham 0:d69efd0ee139 29 #ifdef PB_BUFFER_ONLY
cgraham 0:d69efd0ee139 30 /* Callback pointer is not used in buffer-only configuration.
cgraham 0:d69efd0ee139 31 * Having an int pointer here allows binary compatibility but
cgraham 0:d69efd0ee139 32 * gives an error if someone tries to assign callback function.
cgraham 0:d69efd0ee139 33 * Also, NULL pointer marks a 'sizing stream' that does not
cgraham 0:d69efd0ee139 34 * write anything.
cgraham 0:d69efd0ee139 35 */
cgraham 0:d69efd0ee139 36 int *callback;
cgraham 0:d69efd0ee139 37 #else
cgraham 0:d69efd0ee139 38 bool (*callback)(pb_ostream_t *stream, const uint8_t *buf, size_t count);
cgraham 0:d69efd0ee139 39 #endif
cgraham 0:d69efd0ee139 40 void *state; /* Free field for use by callback implementation. */
cgraham 0:d69efd0ee139 41 size_t max_size; /* Limit number of output bytes written (or use SIZE_MAX). */
cgraham 0:d69efd0ee139 42 size_t bytes_written; /* Number of bytes written so far. */
cgraham 0:d69efd0ee139 43
cgraham 0:d69efd0ee139 44 #ifndef PB_NO_ERRMSG
cgraham 0:d69efd0ee139 45 const char *errmsg;
cgraham 0:d69efd0ee139 46 #endif
cgraham 0:d69efd0ee139 47 };
cgraham 0:d69efd0ee139 48
cgraham 0:d69efd0ee139 49 /***************************
cgraham 0:d69efd0ee139 50 * Main encoding functions *
cgraham 0:d69efd0ee139 51 ***************************/
cgraham 0:d69efd0ee139 52
cgraham 0:d69efd0ee139 53 /* Encode a single protocol buffers message from C structure into a stream.
cgraham 0:d69efd0ee139 54 * Returns true on success, false on any failure.
cgraham 0:d69efd0ee139 55 * The actual struct pointed to by src_struct must match the description in fields.
cgraham 0:d69efd0ee139 56 * All required fields in the struct are assumed to have been filled in.
cgraham 0:d69efd0ee139 57 *
cgraham 0:d69efd0ee139 58 * Example usage:
cgraham 0:d69efd0ee139 59 * MyMessage msg = {};
cgraham 0:d69efd0ee139 60 * uint8_t buffer[64];
cgraham 0:d69efd0ee139 61 * pb_ostream_t stream;
cgraham 0:d69efd0ee139 62 *
cgraham 0:d69efd0ee139 63 * msg.field1 = 42;
cgraham 0:d69efd0ee139 64 * stream = pb_ostream_from_buffer(buffer, sizeof(buffer));
cgraham 0:d69efd0ee139 65 * pb_encode(&stream, MyMessage_fields, &msg);
cgraham 0:d69efd0ee139 66 */
cgraham 0:d69efd0ee139 67 bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
cgraham 0:d69efd0ee139 68
cgraham 0:d69efd0ee139 69 /* Same as pb_encode, but prepends the length of the message as a varint.
cgraham 0:d69efd0ee139 70 * Corresponds to writeDelimitedTo() in Google's protobuf API.
cgraham 0:d69efd0ee139 71 */
cgraham 0:d69efd0ee139 72 bool pb_encode_delimited(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
cgraham 0:d69efd0ee139 73
cgraham 0:d69efd0ee139 74 /**************************************
cgraham 0:d69efd0ee139 75 * Functions for manipulating streams *
cgraham 0:d69efd0ee139 76 **************************************/
cgraham 0:d69efd0ee139 77
cgraham 0:d69efd0ee139 78 /* Create an output stream for writing into a memory buffer.
cgraham 0:d69efd0ee139 79 * The number of bytes written can be found in stream.bytes_written after
cgraham 0:d69efd0ee139 80 * encoding the message.
cgraham 0:d69efd0ee139 81 *
cgraham 0:d69efd0ee139 82 * Alternatively, you can use a custom stream that writes directly to e.g.
cgraham 0:d69efd0ee139 83 * a file or a network socket.
cgraham 0:d69efd0ee139 84 */
cgraham 0:d69efd0ee139 85 pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize);
cgraham 0:d69efd0ee139 86
cgraham 0:d69efd0ee139 87 /* Pseudo-stream for measuring the size of a message without actually storing
cgraham 0:d69efd0ee139 88 * the encoded data.
cgraham 0:d69efd0ee139 89 *
cgraham 0:d69efd0ee139 90 * Example usage:
cgraham 0:d69efd0ee139 91 * MyMessage msg = {};
cgraham 0:d69efd0ee139 92 * pb_ostream_t stream = PB_OSTREAM_SIZING;
cgraham 0:d69efd0ee139 93 * pb_encode(&stream, MyMessage_fields, &msg);
cgraham 0:d69efd0ee139 94 * printf("Message size is %d\n", stream.bytes_written);
cgraham 0:d69efd0ee139 95 */
cgraham 0:d69efd0ee139 96 #ifndef PB_NO_ERRMSG
cgraham 0:d69efd0ee139 97 #define PB_OSTREAM_SIZING {0,0,0,0,0}
cgraham 0:d69efd0ee139 98 #else
cgraham 0:d69efd0ee139 99 #define PB_OSTREAM_SIZING {0,0,0,0}
cgraham 0:d69efd0ee139 100 #endif
cgraham 0:d69efd0ee139 101
cgraham 0:d69efd0ee139 102 /* Function to write into a pb_ostream_t stream. You can use this if you need
cgraham 0:d69efd0ee139 103 * to append or prepend some custom headers to the message.
cgraham 0:d69efd0ee139 104 */
cgraham 0:d69efd0ee139 105 bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count);
cgraham 0:d69efd0ee139 106
cgraham 0:d69efd0ee139 107
cgraham 0:d69efd0ee139 108 /************************************************
cgraham 0:d69efd0ee139 109 * Helper functions for writing field callbacks *
cgraham 0:d69efd0ee139 110 ************************************************/
cgraham 0:d69efd0ee139 111
cgraham 0:d69efd0ee139 112 /* Encode field header based on type and field number defined in the field
cgraham 0:d69efd0ee139 113 * structure. Call this from the callback before writing out field contents. */
cgraham 0:d69efd0ee139 114 bool pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field);
cgraham 0:d69efd0ee139 115
cgraham 0:d69efd0ee139 116 /* Encode field header by manually specifing wire type. You need to use this
cgraham 0:d69efd0ee139 117 * if you want to write out packed arrays from a callback field. */
cgraham 0:d69efd0ee139 118 bool pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, uint32_t field_number);
cgraham 0:d69efd0ee139 119
cgraham 0:d69efd0ee139 120 /* Encode an integer in the varint format.
cgraham 0:d69efd0ee139 121 * This works for bool, enum, int32, int64, uint32 and uint64 field types. */
cgraham 0:d69efd0ee139 122 bool pb_encode_varint(pb_ostream_t *stream, uint64_t value);
cgraham 0:d69efd0ee139 123
cgraham 0:d69efd0ee139 124 /* Encode an integer in the zig-zagged svarint format.
cgraham 0:d69efd0ee139 125 * This works for sint32 and sint64. */
cgraham 0:d69efd0ee139 126 bool pb_encode_svarint(pb_ostream_t *stream, int64_t value);
cgraham 0:d69efd0ee139 127
cgraham 0:d69efd0ee139 128 /* Encode a string or bytes type field. For strings, pass strlen(s) as size. */
cgraham 0:d69efd0ee139 129 bool pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size);
cgraham 0:d69efd0ee139 130
cgraham 0:d69efd0ee139 131 /* Encode a fixed32, sfixed32 or float value.
cgraham 0:d69efd0ee139 132 * You need to pass a pointer to a 4-byte wide C variable. */
cgraham 0:d69efd0ee139 133 bool pb_encode_fixed32(pb_ostream_t *stream, const void *value);
cgraham 0:d69efd0ee139 134
cgraham 0:d69efd0ee139 135 /* Encode a fixed64, sfixed64 or double value.
cgraham 0:d69efd0ee139 136 * You need to pass a pointer to a 8-byte wide C variable. */
cgraham 0:d69efd0ee139 137 bool pb_encode_fixed64(pb_ostream_t *stream, const void *value);
cgraham 0:d69efd0ee139 138
cgraham 0:d69efd0ee139 139 /* Encode a submessage field.
cgraham 0:d69efd0ee139 140 * You need to pass the pb_field_t array and pointer to struct, just like
cgraham 0:d69efd0ee139 141 * with pb_encode(). This internally encodes the submessage twice, first to
cgraham 0:d69efd0ee139 142 * calculate message size and then to actually write it out.
cgraham 0:d69efd0ee139 143 */
cgraham 0:d69efd0ee139 144 bool pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
cgraham 0:d69efd0ee139 145
cgraham 0:d69efd0ee139 146 #ifdef __cplusplus
cgraham 0:d69efd0ee139 147 } /* extern "C" */
cgraham 0:d69efd0ee139 148 #endif
cgraham 0:d69efd0ee139 149
cgraham 0:d69efd0ee139 150 #endif