123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452 |
- /**
- * Copyright (C) 2014 SINTEF <nicolas.harrand@gmail.com>
- *
- * Licensed under the GNU LESSER GENERAL PUBLIC LICENSE, Version 3, 29 June 2007;
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.gnu.org/licenses/lgpl-3.0.txt
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
- #ifndef heads_msgpck_h
- #define heads_msgpck_h
- #include "Arduino.h"
- // ************************** Look up *****************************/
- /**
- * Function: msgpck_what_next
- * Description: Look at Stream s's buffer and return the type of the first data in it.
- *
- * Parameter: Stream * s : input stream.
- *
- * return: type among:
- * - msgpck_empty 0xff
- * - msgpck_nil 0xc0
- * - msgpck_bool 0xc2
- * - msgpck_uint 0xcc
- * - msgpck_sint 0xd0
- * - msgpck_float 0xca
- * - msgpck_string 0xd9
- * - msgpck_bin 0xc4
- * - msgpck_ext 0xc7
- * - msgpck_array 0xdc
- * - msgpck_map 0xde
- * - msgpck_unknown 0x00
- *
- */
- uint8_t msgpck_what_next(Stream * s);
- /**
- * Function: msgpck_nil_next
- * Description: Look at Stream s's buffer and return the type of the first data in it.
- *
- * Parameter: Stream * s : input stream.
- *
- * return: true if next data is nil, false if not
- *
- */
- bool msgpck_nil_next(Stream * s);
- /**
- * Function: msgpck_bool_next
- * Description: Look at Stream s's buffer and return the type of the first data in it.
- *
- * Parameter: Stream * s : input stream.
- *
- * return: true if next data is a bool, false if not
- *
- */
- bool msgpck_bool_next(Stream * s);
- /**
- * Function: msgpck_integer_next
- * Description: Look at Stream s's buffer and return the type of the first data in it.
- *
- * Parameter: Stream * s : input stream.
- *
- * return: true if next data is an integer (signed or not), false if not
- *
- */
- bool msgpck_integer_next(Stream * s);
- /**
- * Function: msgpck_signed_next
- * Description: Look at Stream s's buffer and return the type of the first data in it.
- *
- * Parameter: Stream * s : input stream.
- *
- * return: true if next data is a signed integer, false if not
- *
- */
- bool msgpck_signed_next(Stream * s);
- /**
- * Function: msgpck_float_next
- * Description: Look at Stream s's buffer and return the type of the first data in it.
- *
- * Parameter: Stream * s : input stream.
- *
- * return: true if next data is a float (on 4 bytes), false if not
- *
- */
- bool msgpck_float_next(Stream * s);
- /**
- * Function: msgpck_string_next
- * Description: Look at Stream s's buffer and return the type of the first data in it.
- *
- * Parameter: Stream * s : input stream.
- *
- * return: true if next data is a String, false if not
- *
- */
- bool msgpck_string_next(Stream * s);
- /**
- * Function: msgpck_bin_next
- * Description: Look at Stream s's buffer and return the type of the first data in it.
- *
- * Parameter: Stream * s : input stream.
- *
- * return: true if next data is a binary format, false if not
- *
- */
- bool msgpck_bin_next(Stream * s);
- /**
- * Function: msgpck_array_next
- * Description: Look at Stream s's buffer and return the type of the first data in it.
- *
- * Parameter: Stream * s : input stream.
- *
- * return: true if next data is an array, false if not
- *
- */
- bool msgpck_array_next(Stream * s);
- /**
- * Function: msgpck_map_next
- * Description: Look at Stream s's buffer and return the type of the first data in it.
- *
- * Parameter: Stream * s : input stream.
- *
- * return: true if next data is a map, false if not
- *
- */
- bool msgpck_map_next(Stream * s);
- // ************************** Readers *****************************/
- /**
- * Function: msgpck_read_nil
- * Description: Read the first data of Stream s's buffer if it is a nil.
- *
- * Parameter: Stream * s : input stream.
- *
- * return: true if next data has been read correctly, false if not
- *
- */
- bool msgpck_read_nil(Stream * s);
- /**
- * Function: msgpck_read_bool
- * Description: Read the first data of Stream s's buffer if it is a bool.
- *
- * Parameter: Stream * s : input stream.
- * bool * b: pointer to the read value.
- *
- * return: true if next data has been read correctly, false if not
- *
- */
- bool msgpck_read_bool(Stream * s, bool *b);
- /**
- * Function: msgpck_read_integer
- * Description: Read the first data of Stream s's buffer if it is an integer.
- *
- * Parameter: Stream * s : input stream.
- * byte * b: pointer to the read value.
- * uint8_t max_size: max size in byte of the expected value.
- *
- * return: true if next data has been read correctly, false if not
- *
- */
- bool msgpck_read_integer(Stream * s, byte *b, uint8_t max_size);
- /**
- * Function: msgpck_read_float
- * Description: Read the first data of Stream s's buffer if it is a float.
- *
- * Parameter: Stream * s : input stream.
- * float * f: pointer to the read value.
- *
- * return: true if next data has been read correctly, false if not
- *
- */
- bool msgpack_read_float(Stream * s, float *f);
- /**
- * Function: msgpck_read_string
- * Description: Read the first data of Stream s's buffer if it is a string.
- *
- * Parameter: Stream * s : input stream.
- * char * str: pointer to the read value.
- * uint32_t max_size: max size in byte of the expected value.
- * uint32_t *str_size: pointer to the actual size of the read string
- *
- * return: true if next data has been read correctly, false if not
- *
- */
- bool msgpck_read_string(Stream * s, char * str, uint32_t max_size, uint32_t *str_size);
- /**
- * Function: msgpck_read_string
- * Description: Read the first data of Stream s's buffer if it is a string.
- *
- * Parameter: Stream * s : input stream.
- * char * str: pointer to the read value.
- * uint32_t max_size: max size in byte of the expected value.
- *
- * return: true if next data has been read correctly, false if not
- *
- */
- bool msgpck_read_string(Stream * s, char * str, uint32_t max_size);
- /**
- * Function: msgpck_read_bin
- * Description: Read the first data of Stream s's buffer if it is a bin.
- *
- * Parameter: Stream * s : input stream.
- * byte * bin: pointer to the read value.
- * uint32_t max_size: max size in byte of the expected value.
- * uint32_t *str_size: pointer to the actual size of the read bin
- *
- * return: true if next data has been read correctly, false if not
- *
- */
- bool msgpck_read_bin(Stream * s, byte * bin, uint32_t max_size, uint32_t *bin_size);
- /**
- * Function: msgpck_read_bin
- * Description: Read the first data of Stream s's buffer if it is a bin.
- *
- * Parameter: Stream * s : input stream.
- * byte * bin: pointer to the read value.
- * uint32_t max_size: max size in byte of the expected value.
- *
- * return: true if next data has been read correctly, false if not
- *
- */
- bool msgpck_read_bin(Stream * s, byte * bin, uint32_t max_size);
- /**
- * Function: msgpck_read_array_size
- * Description: Read the header of the incoming array.
- *
- * Parameter: Stream * s : input stream.
- * uint32_t * array_size: pointer to the read size of the incoming array
- *
- * return: true if next data has been read correctly, false if not
- *
- */
- bool msgpck_read_array_size(Stream * s, uint32_t * array_size);
- /**
- * Function: msgpck_read_map_size
- * Description: Read the header of the incoming map.
- *
- * Parameter: Stream * s : input stream.
- * uint32_t * map_size: pointer to the read size of the incoming map
- *
- * Warning: map_size will contain the number of pair (key, element)
- *
- * return: true if next data has been read correctly, false if not
- *
- */
- bool msgpck_read_map_size(Stream * s, uint32_t * map_size);
- // ************************** Writers *****************************/
- /**
- * Function: msgpck_write_nil
- * Description: Write nil on the output stream
- *
- * Parameter: Stream * s : output stream.
- *
- */
- void msgpck_write_nil(Stream * s);
- /**
- * Function: msgpck_write_bool
- * Description: Write a bool data on the output stream
- *
- * Parameter: Stream * s : output stream.
- * bool b: bool value to write
- *
- */
- void msgpck_write_bool(Stream * s, bool b);
- /**
- * Function: msgpck_write_integer
- * Description: Write an integer data on the output stream
- *
- * Parameter: Stream * s : output stream.
- * uint8_t u: integer value to write
- *
- */
- void msgpck_write_integer(Stream * s, uint8_t u);
- /**
- * Function: msgpck_write_integer
- * Description: Write an integer data on the output stream
- *
- * Parameter: Stream * s : output stream.
- * uint16_t u: integer value to write
- *
- */
- void msgpck_write_integer(Stream * s, uint16_t u);
- /**
- * Function: msgpck_write_integer
- * Description: Write an integer data on the output stream
- *
- * Parameter: Stream * s : output stream.
- * uint32_t u: integer value to write
- *
- */
- void msgpck_write_integer(Stream * s, uint32_t u);
- /**
- * Function: msgpck_write_integer
- * Description: Write an integer data on the output stream
- *
- * Parameter: Stream * s : output stream.
- * uint64_t u: integer value to write
- *
- */
- void msgpck_write_integer(Stream * s, uint64_t u);
- /**
- * Function: msgpck_write_integer
- * Description: Write an integer data on the output stream
- *
- * Parameter: Stream * s : output stream.
- * int8_t i: integer value to write
- *
- */
- void msgpck_write_integer(Stream * s, int8_t i);
- /**
- * Function: msgpck_write_integer
- * Description: Write an integer data on the output stream
- *
- * Parameter: Stream * s : output stream.
- * int16_t i: integer value to write
- *
- */
- void msgpck_write_integer(Stream * s, int16_t i);
- /**
- * Function: msgpck_write_integer
- * Description: Write an integer data on the output stream
- *
- * Parameter: Stream * s : output stream.
- * int32_t i: integer value to write
- *
- */
- void msgpck_write_integer(Stream * s, int32_t i);
- /**
- * Function: msgpck_write_integer
- * Description: Write an integer data on the output stream
- *
- * Parameter: Stream * s : output stream.
- * int64_t i: integer value to write
- *
- */
- void msgpck_write_integer(Stream * s, int64_t i);
- /**
- * Function: msgpck_write_float
- * Description: Write a float data on the output stream
- *
- * Parameter: Stream * s : output stream.
- * float f: float value to write
- *
- */
- void msgpck_write_float(Stream *s, float f);
- /**
- * Function: msgpck_write_string
- * Description: Write string on the output stream
- *
- * Parameter: Stream * s : output stream.
- * char * str: a string to write
- * uint32_t str_size: size of the string to write
- *
- */
- void msgpck_write_string(Stream * s, char * str, uint32_t str_size);
- /**
- * Function: msgpck_write_string
- * Description: Write a string on the output stream
- *
- * Parameter: Stream * s : output stream.
- * String str: string to write
- *
- */
- void msgpck_write_string(Stream * s, String str);
- /**
- * Function: msgpck_write_bin
- * Description: Write a bin data on the output stream
- *
- * Parameter: Stream * s : output stream.
- * byte * b: bin to write
- * uint32_t bin_size: size of the bin to write
- *
- */
- void msgpck_write_bin(Stream * s, byte * b, uint32_t bin_size);
- /**
- * Function: msgpck_write_array_header
- * Description: Write the header of an array on the output stream
- *
- * Parameter: Stream * s : output stream.
- * uint32_t ar_size: numder of element in the array
- *
- */
- void msgpck_write_array_header(Stream * s, uint32_t ar_size);
- /**
- * Function: msgpck_write_map_header
- * Description: Write the header of a map on the output stream
- *
- * Parameter: Stream * s : output stream.
- * uint32_t ar_size: numder of pair (key, element) in the map
- *
- */
- void msgpck_write_map_header(Stream * s, uint32_t map_size);
- /**
- * Function: msgpck_to_json
- * Description: read messagepack data on the input and write json on the ouput
- *
- * Parameter: Stream * output : output stream.
- * Stream * input : input stream.
- *
- */
- void msgpck_to_json(Stream * output, Stream * input);
- #endif
|