Home | History | Annotate | Download | only in avahi-core 
      1 #ifndef foocachehfoo
      2 #define foocachehfoo
      3 
      4 /***
      5   This file is part of avahi.
      6 
      7   avahi is free software; you can redistribute it and/or modify it
      8   under the terms of the GNU Lesser General Public License as
      9   published by the Free Software Foundation; either version 2.1 of the
     10   License, or (at your option) any later version.
     11 
     12   avahi is distributed in the hope that it will be useful, but WITHOUT
     13   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
     14   or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
     15   Public License for more details.
     16 
     17   You should have received a copy of the GNU Lesser General Public
     18   License along with avahi; if not, write to the Free Software
     19   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
     20   USA.
     21 ***/
     22 
     23 typedef struct AvahiCache AvahiCache;
     24 
     25 #include <avahi-common/llist.h>
     26 #include "prioq.h"
     27 #include "internal.h"
     28 #include "timeeventq.h"
     29 #include "hashmap.h"
     30 
     31 typedef enum {
     32     AVAHI_CACHE_VALID,
     33     AVAHI_CACHE_EXPIRY1,
     34     AVAHI_CACHE_EXPIRY2,
     35     AVAHI_CACHE_EXPIRY3,
     36     AVAHI_CACHE_EXPIRY_FINAL,
     37     AVAHI_CACHE_POOF,       /* Passive observation of failure */
     38     AVAHI_CACHE_POOF_FINAL,
     39     AVAHI_CACHE_GOODBYE_FINAL,
     40     AVAHI_CACHE_REPLACE_FINAL
     41 } AvahiCacheEntryState;
     42 
     43 typedef struct AvahiCacheEntry AvahiCacheEntry;
     44 
     45 struct AvahiCacheEntry {
     46     AvahiCache *cache;
     47     AvahiRecord *record;
     48     struct timeval timestamp;
     49     struct timeval poof_timestamp;
     50     struct timeval expiry;
     51     int cache_flush;
     52     int poof_num;
     53 
     54     AvahiAddress origin;
     55 
     56     AvahiCacheEntryState state;
     57     AvahiTimeEvent *time_event;
     58 
     59     AvahiAddress poof_address;
     60 
     61     AVAHI_LLIST_FIELDS(AvahiCacheEntry, by_key);
     62     AVAHI_LLIST_FIELDS(AvahiCacheEntry, entry);
     63 };
     64 
     65 struct AvahiCache {
     66     AvahiServer *server;
     67 
     68     AvahiInterface *interface;
     69 
     70     AvahiHashmap *hashmap;
     71 
     72     AVAHI_LLIST_HEAD(AvahiCacheEntry, entries);
     73 
     74     unsigned n_entries;
     75 
     76     int last_rand;
     77     time_t last_rand_timestamp;
     78 };
     79 
     80 AvahiCache *avahi_cache_new(AvahiServer *server, AvahiInterface *interface);
     81 void avahi_cache_free(AvahiCache *c);
     82 
     83 void avahi_cache_update(AvahiCache *c, AvahiRecord *r, int cache_flush, const AvahiAddress *a);
     84 
     85 int avahi_cache_dump(AvahiCache *c, AvahiDumpCallback callback, void* userdata);
     86 
     87 typedef void* AvahiCacheWalkCallback(AvahiCache *c, AvahiKey *pattern, AvahiCacheEntry *e, void* userdata);
     88 void* avahi_cache_walk(AvahiCache *c, AvahiKey *pattern, AvahiCacheWalkCallback cb, void* userdata);
     89 
     90 int avahi_cache_entry_half_ttl(AvahiCache *c, AvahiCacheEntry *e);
     91 
     92 /** Start the "Passive observation of Failure" algorithm for all
     93  * records of the specified key. The specified address is  */
     94 void avahi_cache_start_poof(AvahiCache *c, AvahiKey *key, const AvahiAddress *a);
     95 
     96 /* Stop a previously started POOF algorithm for a record. (Used for response suppresions records */
     97 void avahi_cache_stop_poof(AvahiCache *c, AvahiRecord *record, const AvahiAddress *a);
     98 
     99 void avahi_cache_flush(AvahiCache *c);
    100 
    101 #endif
    102