subscribe.h

Go to the documentation of this file.

/* subscribe.h -- subscription handling for CoAP
 *                see draft-hartke-coap-observe-03
 *
 * 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_SUBSCRIBE_H_
#define _COAP_SUBSCRIBE_H_

#include "config.h"
#include "address.h"

#ifndef COAP_OBS_MAX_NON

#define COAP_OBS_MAX_NON   5
#endif /* COAP_OBS_MAX_NON */

#ifndef COAP_OBS_MAX_FAIL

#define COAP_OBS_MAX_FAIL  3
#endif /* COAP_OBS_MAX_FAIL */

typedef struct coap_subscription_t {
  struct coap_subscription_t *next; 
  coap_address_t subscriber;        
  unsigned int non:1;       
  unsigned int non_cnt:4;   
  unsigned int fail_cnt:2;  
  unsigned int dirty:1;         
  size_t token_length;      
  unsigned char token[8];   
  /* @todo CON/NON flag, block size */
} coap_subscription_t;

void coap_subscription_init(coap_subscription_t *);

#if 0
#include "uthash.h"
#include "uri.h"
#include "list.h"
#include "pdu.h"
#include "net.h"

#if 0
typedef unsigned long coap_key_t;

#define COAP_INVALID_HASHKEY ((coap_key_t)-1)

typedef struct {
  coap_uri_t *uri;      /* unique identifier; memory is released by coap_delete_resource() */
  UT_hash_handle hh;        
  str *name;            /* display name of the resource */
  unsigned char mediatype;  /* media type for resource representation */
  unsigned int dirty:1;     /* set to 1 if resource has changed */
  unsigned int writable:1;  /* set to 1 if resource can be changed using PUT */

  /* cache-control */
  unsigned char etag[4];        /* version identifier for this resource
                 * (zero terminated, first byte is zero if not set). */
  unsigned int maxage;      /* maximum cache time (zero means no Max-age option) */

  int (*data)(coap_uri_t *uri, unsigned char *mediatype, unsigned int offset, unsigned char *buf, unsigned int *buflen, int *finished);
} coap_resource_t;
#endif

typedef struct {
  coap_key_t resource;      /* hash key for subscribed resource */
  time_t expires;       /* expiry time of subscription */

  coap_address_t subscriber;    
  str token;            
} coap_subscription_t;

#define COAP_RESOURCE(node) ((coap_resource_t *)(node)->data)
#define COAP_SUBSCRIPTION(node) ((coap_subscription_t *)(node)->data)

void coap_check_resource_list(coap_context_t *context);

void coap_check_subscriptions(coap_context_t *context);

#if 0

coap_key_t coap_add_resource(coap_context_t *context, coap_resource_t *);

int coap_delete_resource(coap_context_t *context, coap_key_t key);
#endif

coap_subscription_t *coap_new_subscription(coap_context_t *context,
                       const coap_uri_t *resource,
                       const struct sockaddr *subscriber,
                       socklen_t addrlen,
                       time_t expiry);

coap_key_t coap_add_subscription(coap_context_t *context,
                 coap_subscription_t *subscription);

coap_subscription_t * coap_find_subscription(coap_context_t *context,
                         coap_key_t hashkey,
                         struct sockaddr *subscriber,
                         str *token);
int coap_delete_subscription(coap_context_t *context,
                 coap_key_t hashkey,
                 struct sockaddr *subscriber);

coap_key_t coap_uri_hash(const coap_uri_t *uri);


coap_key_t coap_subscription_hash(coap_subscription_t *subscription);
#if 0

coap_resource_t *coap_get_resource_from_key(coap_context_t *ctx, coap_key_t key);

coap_resource_t *coap_get_resource(coap_context_t *ctx, coap_uri_t *uri);
#endif

#endif

#endif /* _COAP_SUBSCRIBE_H_ */