mirror of
https://github.com/obgm/libcoap.git
synced 2026-11-08 10:32:53 +03:00
Jon Shallow
8238f628b9
Added in a new landing page for Main Page doc/main.md (new) Enabled Tree View of whats available Disable Related Pages TAB as it fills up with the man pages - updated doc/Doxyfile.in Get a2x to also generate html man pages which are then included. These html files are updated to correct the lowercasing of NAME and SYNOPSIS. The SEE ALSO references to other man pages are made hyper links. - done by doc/build_man_files.sh (new) Created a new TAB Manual Pages Created a new TAB Depricated Items - done by modifing DoxygenLayout.xml file using doc/build_man_files.sh Updated .gitignore to ignore additional files and autogen.sh to clean them up man/coap*txt.in updated to display as expected in Doxygen. This only updates documentation .gitignore Makefile.am autogen.sh doc/Doxyfile.in doc/Makefile.am doc/build_man_files.sh (New) doc/main.md (New) include/coap/debug.h include/coap/encode.h include/coap/option.h include/coap/pdu.h include/coap/prng.h man/Makefile.am man/coap.txt.in man/coap_attribute.txt.in man/coap_context.txt.in man/coap_encryption.txt.in man/coap_handler.txt.in man/coap_logging.txt.in man/coap_observe.txt.in man/coap_pdu_setup.txt.in man/coap_recovery.txt.in man/coap_resource.txt.in man/coap_session.txt.in man/coap_tls_library.txt.in
97 lines
3.1 KiB
C
97 lines
3.1 KiB
C
/*
|
|
* encode.h -- encoding and decoding of CoAP data types
|
|
*
|
|
* Copyright (C) 2010-2012 Olaf Bergmann <bergmann@tzi.org>
|
|
*
|
|
* This file is part of the CoAP library libcoap. Please see README for terms
|
|
* of use.
|
|
*/
|
|
|
|
#ifndef _COAP_ENCODE_H_
|
|
#define _COAP_ENCODE_H_
|
|
|
|
#if (BSD >= 199103) || defined(WITH_CONTIKI) || defined(_WIN32)
|
|
# include <string.h>
|
|
#else
|
|
# include <strings.h>
|
|
#endif
|
|
|
|
#include <stdint.h>
|
|
|
|
#define Nn 8 /* duplicate definition of N if built on sky motes */
|
|
#define ENCODE_HEADER_SIZE 4
|
|
#define HIBIT (1 << (Nn - 1))
|
|
#define EMASK ((1 << ENCODE_HEADER_SIZE) - 1)
|
|
#define MMASK ((1 << Nn) - 1 - EMASK)
|
|
#define MAX_VALUE ( (1 << Nn) - (1 << ENCODE_HEADER_SIZE) ) * (1 << ((1 << ENCODE_HEADER_SIZE) - 1))
|
|
|
|
#define COAP_PSEUDOFP_DECODE_8_4(r) (r < HIBIT ? r : (r & MMASK) << (r & EMASK))
|
|
|
|
#ifndef HAVE_FLS
|
|
/* include this only if fls() is not available */
|
|
extern int coap_fls(unsigned int i);
|
|
#else
|
|
#define coap_fls(i) fls(i)
|
|
#endif
|
|
|
|
#ifndef HAVE_FLSLL
|
|
/* include this only if flsll() is not available */
|
|
extern int coap_flsll(long long i);
|
|
#else
|
|
#define coap_flsll(i) flsll(i)
|
|
#endif
|
|
|
|
/* ls and s must be integer variables */
|
|
#define COAP_PSEUDOFP_ENCODE_8_4_DOWN(v,ls) (v < HIBIT ? v : (ls = coap_fls(v) - Nn, (v >> ls) & MMASK) + ls)
|
|
#define COAP_PSEUDOFP_ENCODE_8_4_UP(v,ls,s) (v < HIBIT ? v : (ls = coap_fls(v) - Nn, (s = (((v + ((1<<ENCODE_HEADER_SIZE<<ls)-1)) >> ls) & MMASK)), s == 0 ? HIBIT + ls + 1 : s + ls))
|
|
|
|
/**
|
|
* Decodes multiple-length byte sequences. @p buf points to an input byte
|
|
* sequence of length @p length. Returns the decoded value.
|
|
*
|
|
* @param buf The input byte sequence to decode from
|
|
* @param length The length of the input byte sequence
|
|
*
|
|
* @return The decoded value
|
|
*/
|
|
unsigned int coap_decode_var_bytes(const uint8_t *buf, unsigned int length);
|
|
|
|
/**
|
|
* Encodes multiple-length byte sequences. @p buf points to an output buffer of
|
|
* sufficient length to store the encoded bytes. @p value is the value to
|
|
* encode.
|
|
* Returns the number of bytes used to encode @p value or 0 on error.
|
|
*
|
|
* @param buf The output buffer to decode into
|
|
* @param length The output buffer size to encode into (must be sufficient)
|
|
* @param value The value to encode into the buffer
|
|
*
|
|
* @return The number of bytes used to encode @p value or @c 0 on error.
|
|
*/
|
|
unsigned int coap_encode_var_safe(uint8_t *buf,
|
|
size_t length,
|
|
unsigned int value);
|
|
|
|
/**
|
|
* @deprecated Use coap_encode_var_safe() instead.
|
|
* Provided for backward compatability. As @p value has a
|
|
* maximum value of 0xffffffff, and buf is usually defined as an array, it
|
|
* is unsafe to continue to use this variant if buf[] is less than buf[4].
|
|
*
|
|
* For example
|
|
* char buf[1],oops;
|
|
* ..
|
|
* coap_encode_var_bytes(buf, 0xfff);
|
|
* would cause oops to get overwritten. This error can only be found by code
|
|
* inspection.
|
|
* coap_encode_var_safe(buf, sizeof(buf), 0xfff);
|
|
* would catch this error at run-time and should be used instead.
|
|
*/
|
|
COAP_STATIC_INLINE COAP_DEPRECATED int
|
|
coap_encode_var_bytes(uint8_t *buf, unsigned int value
|
|
) {
|
|
return coap_encode_var_safe(buf, sizeof(value), value);
|
|
}
|
|
|
|
#endif /* _COAP_ENCODE_H_ */
|