Documentation

Documentation

Includes

stdint.h

#include <stdint.h>
#include 

str.h

#include "str.h"
#include "str.h"

Macros

Marco COAP_URI_H_

#define COAP_URI_H_


      

Marco COAP_URI_SCHEME_SECURE_MASK

#define COAP_URI_SCHEME_SECURE_MASK 1
/** This mask can be used to check if a parsed URI scheme is secure. */

Functions

Func coap_split_uri

int coap_split_uri(const uint8_t *str_var, size_t len, coap_uri_t *uri);
/**
 * Parses a given string into URI components. The identified syntactic
 * components are stored in the result parameter @p uri. Optional URI
 * components that are not specified will be set to { 0, 0 }, except for the
 * port which is set to @c COAP_DEFAULT_PORT. This function returns @p 0 if
 * parsing succeeded, a value less than zero otherwise.
 *
 * @param str_var The string to split up.
 * @param len     The actual length of @p str_var
 * @param uri     The coap_uri_t object to store the result.
 * @return        @c 0 on success, or < 0 on error.
 *
 */

Func coap_split_path

int coap_split_path(const uint8_t *s,
                   size_t length,
                   unsigned char *buf,
                   size_t *buflen);
/**
 * Splits the given URI path into segments. Each segment is preceded
 * by an option pseudo-header with delta-value 0 and the actual length
 * of the respective segment after percent-decoding.
 *
 * @param s      The path string to split.
 * @param length The actual length of @p s.
 * @param buf    Result buffer for parsed segments.
 * @param buflen Maximum length of @p buf. Will be set to the actual number
 *               of bytes written into buf on success.
 *
 * @return       The number of segments created or @c -1 on error.
 */

Func coap_split_query

int coap_split_query(const uint8_t *s,
                    size_t length,
                    unsigned char *buf,
                    size_t *buflen);
/**
 * Splits the given URI query into segments. Each segment is preceded
 * by an option pseudo-header with delta-value 0 and the actual length
 * of the respective query term.
 *
 * @param s      The query string to split.
 * @param length The actual length of @p s.
 * @param buf    Result buffer for parsed segments.
 * @param buflen Maximum length of @p buf. Will be set to the actual number
 *               of bytes written into buf on success.
 *
 * @return       The number of segments created or @c -1 on error.
 *
 * @bug This function does not reserve additional space for delta > 12.
 */

Vars

Variable coap_pdu_t

struct coap_pdu_t;


      

Variable coap_uri_t

coap_uri_t *coap_new_uri(const uint8_t *uri, unsigned int length);
/**
 * Creates a new coap_uri_t object from the specified URI. Returns the new
 * object or NULL on error. The memory allocated by the new coap_uri_t
 * must be released using coap_free().
 *
 * @param uri The URI path to copy.
 * @param length The length of uri.
 *
 * @return New URI object or NULL on error.
 */

Variable coap_uri_t

coap_uri_t *coap_clone_uri(const coap_uri_t *uri);
/**
 * Clones the specified coap_uri_t object. Thie function allocates sufficient
 * memory to hold the coap_uri_t structure and its contents. The object must
 * be released with coap_free(). */

Variable coap_string_t

coap_string_t *coap_get_query(const struct coap_pdu_t *request);
/**
 * Extract query string from request PDU according to escape rules in 6.5.8.
 * @param request Request PDU.
 * @return        Reconstructed and escaped query string part.
 */

Variable coap_string_t

coap_string_t *coap_get_uri_path(const struct coap_pdu_t *request);
/**
 * Extract uri_path string from request PDU
 * @param request Request PDU.
 * @return        Reconstructed and escaped uri path string part.
 */

Consts

Types

Typedefs

Typedef coap_uri_t;

typedef struct {
 coap_str_const_t host; /**< host part of the URI */
 uint16_t port;         /**< The port in host byte order */
 coap_str_const_t path; /**< Beginning of the first path segment.
                           Use coap_split_path() to create Uri-Path options */
 coap_str_const_t query; /**<  The query part if present */

 /** The parsed scheme specifier. */
 enum coap_uri_scheme_t scheme;
} coap_uri_t;
/**
 * Representation of parsed URI. Components may be filled from a string with
 * coap_split_uri() and can be used as input for option-creation functions.
 */