Contiki-NG
coap-observe.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013, Institute for Pervasive Computing, ETH Zurich
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the Institute nor the names of its contributors
14  * may be used to endorse or promote products derived from this software
15  * without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * This file is part of the Contiki operating system.
30  */
31 
32 /**
33  * \file
34  * CoAP module for observing resources (draft-ietf-core-observe-11).
35  * \author
36  * Matthias Kovatsch <kovatsch@inf.ethz.ch>
37  */
38 
39 /**
40  * \addtogroup coap
41  * @{
42  */
43 
44 #ifndef COAP_OBSERVE_H_
45 #define COAP_OBSERVE_H_
46 
47 #include "coap.h"
48 #include "coap-transactions.h"
49 #include "coap-engine.h"
50 
51 #define COAP_OBSERVER_URL_LEN 20
52 
53 typedef struct coap_observer {
54  struct coap_observer *next; /* for LIST */
55 
56  char url[COAP_OBSERVER_URL_LEN];
57  coap_endpoint_t endpoint;
58  uint8_t token_len;
59  uint8_t token[COAP_TOKEN_LEN];
60  uint16_t last_mid;
61 
62  int32_t obs_counter;
63 
64  coap_timer_t retrans_timer;
65  uint8_t retrans_counter;
66 } coap_observer_t;
67 
68 void coap_remove_observer(coap_observer_t *o);
69 int coap_remove_observer_by_client(const coap_endpoint_t *ep);
70 int coap_remove_observer_by_token(const coap_endpoint_t *ep,
71  uint8_t *token, size_t token_len);
72 int coap_remove_observer_by_uri(const coap_endpoint_t *ep,
73  const char *uri);
74 int coap_remove_observer_by_mid(const coap_endpoint_t *ep,
75  uint16_t mid);
76 
77 void coap_notify_observers(coap_resource_t *resource);
78 void coap_notify_observers_sub(coap_resource_t *resource, const char *subpath);
79 
80 void coap_observe_handler(coap_resource_t *resource, coap_message_t *request,
81  coap_message_t *response);
82 
83 uint8_t coap_has_observers(char *path);
84 
85 #endif /* COAP_OBSERVE_H_ */
86 /** @} */
CoAP engine implementation.
CoAP module for reliable transport
An implementation of the Constrained Application Protocol (RFC 7252).