upnphandler.h

Go to the documentation of this file.

/*
** Copyright (C) 2004 Russell Leighton
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/




#ifndef __AWHANDLER_UPNP__
#define __AWHANDLER_UPNP__

#include "sysnet.h" 
#include "trie.h" 
#include "regexmatch.h"
#include "monitor.h"
#include "wire.h"

/****
     moved below comment out of above because the "wire"
     interface does not allow you to set these currently
****/
/*
Options:
<ul>
<li> AW_UPNPHANDLER_GROUP : Watch a group of devices defined by
matching the regex. Only send 'up' events when the first
match appears and only send 'down' events when the last match disappears.
<li> AW_UPNPHANDLER_COUNTONCHANGE : Only send 'count' events when the
count of the devicees matching the regex changes. By default, the
'count' events are generated every cycle. This option is useful is you
are interested in notification if the number of devices gets
below or above a certain number (used with the rfilterhandler).
</ul>
*/

/*
Changes:

03/12/04 Russell Leighton
Port to handler
*/


/* ip and port defined in standard */
#define UPNP_MCAST_GROUP "239.255.255.250"
#define UPNP_MCAST_PORT 1900


typedef enum {

  AW_UPNPHANDLER_GROUP = 0x1,         /* only send 'up'/'down' events based on whole group */
  AW_UPNPHANDLER_COUNTONCHANGE = 0x2, /* only send 'count' events when count changes */

} aw_upnphandler_flag_t;

#define AW_UPNPHANDLER_DEFAULT_FLAGS (AW_UPNPHANDLER_COUNTONCHANGE)

typedef struct {

  aw_event_sig_t
   up,               /* regex matched and device is noticed up */
   down,             /* regex matched and device is noticed down */
   count;            /* count of regex matched devices */

} aw_upnphandler_events_t;


typedef enum {

  AW_UPNPHANDLER_IDLE,               /* not doing anything */
  AW_UPNPHANDLER_WAIT_READ,          /* waiting on a read() */

} aw_upnphandler_state_cd_t;

typedef struct aw_upnphandler_devlist_s {

  /* list */
  struct aw_upnphandler_devlist_s
   *next;

  /* calculated from CACHE-CONTROL: */
  aw_timestamp_t
   expires;

  /* 
     this is LOCATION \t SERVER \t USN, unless substituted by regex, where

     LOCATION , is assumed to be a unique URL that points 
     to the device (via IP) and can be used to get detailed info.

     SERVER, is the concatenation of OS name, OS version, UPnP/1.0, 
     product name, and product version. Specified by UPnP vendor. 

     USN, Unique service name
  */
  byte_t
   *name;

  /* unique key to identify this device */
  byte_t
   *key;

} aw_upnphandler_devlist_t;


typedef struct {

  aw_upnphandler_state_cd_t
   state_cd;

  int32_t
    outmcfd, /* to send M-SEARCH messages */
    inmcfd;  /* to listen for alive and byebye */

  /* space to read packets, max size of a UDP packet */
  byte_t
   rx_message[0xffff]; 

  /* set to 1 in start(), back to 0 in handler */
  u_int32_t
   first_handler;

  /* sorted list of devs that were up last poll interval */
  aw_upnphandler_devlist_t
   *up,                            /* the last _complete_ set of up records */
   *new_up;                        /* for accumulating up records during m-search */

  /* used for fast look up of what's in 'up' and 'new_up' */
  aw_trie_t
   *up_index,
   *new_up_index;

  aw_cache_allocator_t
   devlist_factory;

} aw_upnphandler_state_t;

typedef struct {

  aw_upnphandler_flag_t
   flags;

  aw_upnphandler_events_t
    events;

  /* regex string */
  const byte_t
   *regex;

  /* holds substitution string, may be NULL */
  const byte_t
   *subst;

} aw_upnphandler_regex_t;

typedef struct {

  aw_upnphandler_flag_t
   flags;

  aw_upnphandler_events_t
    events;

  /* holds compiled regular expression  */
  regex_t
   pattern;

  /* holds substitution string, may be NULL */
  byte_t
   *subst;

  aw_upnphandler_devlist_t
   *watch;           /* list of devs that are in 'up' that matched regex */

  u_int32_t
   watchcount;       /* length of watch list */

} aw_upnphandler_watcher_t;


typedef struct {

  aw_handler_t 
    handler_header;

  u_int32_t
   nwatchers;

  aw_upnphandler_watcher_t
   *watchers;

  aw_upnphandler_state_t
   state;

  /* address of interface to send multicast packets */
  struct in_addr
   mcast_if_addr;

  /* non-zero if enabling IP_MULTICAST_LOOP */
  u_int32_t
   mcast_loopback;

  /* multicast address to send M-SEARCH packets */
  struct sockaddr_in
   mcast_grp_addr;

  /* schedule for M-SEARCH queries */
  aw_alarm_sched_t
   msearch_sched;

  /* max time allowed to succeed per try */
  aw_timestamp_t
   timeout;

} aw_upnphandler_t ;

aw_upnphandler_t *aw_create_upnphandler(u_int32_t nregexs,
                                        const aw_upnphandler_regex_t *regexs, 
                                        const byte_t *mcinterface,
                                        u_int32_t mcloopback,
                                        const aw_alarm_sched_t *sched,
                                        aw_logger_t *logger
                                        );

void aw_free_upnphandler(aw_upnphandler_t *p);

aw_handler_t *aw_wire_upnphandler(aw_wire_mkhandler_args_t *args);

#endif

Aware 0.11.1 Copyright (C) 1998-2005 Russell Leighton (russ@elegant-software.com)