err.no Git - sope/blob - sope-appserver/NGObjWeb/WebDAV/SoSubscription.h

   1 /*
   2   Copyright (C) 2000-2005 SKYRIX Software AG
   3
   4   This file is part of SOPE.
   5
   6   SOPE is free software; you can redistribute it and/or modify it under
   7   the terms of the GNU Lesser General Public License as published by the
   8   Free Software Foundation; either version 2, or (at your option) any
   9   later version.
  10
  11   SOPE is distributed in the hope that it will be useful, but WITHOUT ANY
  12   WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
  14   License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public
  17   License along with SOPE; see the file COPYING.  If not, write to the
  18   Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19   02111-1307, USA.
  20 */
  21
  22 #ifndef __NGObjWeb_SoSubscription_H__
  23 #define __NGObjWeb_SoSubscription_H__
  24
  25 #import <Foundation/NSObject.h>
  26 #import <Foundation/NSDate.h>
  27
  28 /*
  29   SoSubscription
  30
  31   This class holds the information of a single subscription. Usually you
  32   will never access SoSubscription objects directly.
  33
  34   Subscription Types:
  35     update
  36     delete
  37     move
  38     any
  39     update/newmember
  40     pragma/<http...newmail>
  41 */
  42
  43 @class NSString, NSURL, NSMutableDictionary;
  44
  45 @interface SoSubscription : NSObject
  46 {
  47   NSString       *sid;
  48   NSURL          *object;
  49   BOOL           trackChildren; /* depth header */
  50   NSURL          *observer;
  51
  52   NSTimeInterval delay;
  53   NSTimeInterval lifetime;
  54   NSDate         *expireDate;   /* now + lifetime */
  55   NSString       *subscriptionType;
  56
  57   unsigned       pending; /* keeps the number of events since last POLL */
  58 }
  59
  60 - (id)initWithID:(NSString *)_sid
  61   url:(NSURL *)_url observer:(NSURL *)_callback
  62   type:(NSString *)_type delay:(NSTimeInterval)_delay
  63   lifetime:(NSTimeInterval)_lifetime;
  64
  65 /* accessors */
  66
  67 - (NSDate *)expirationDate;
  68 - (NSString *)subscriptionID;
  69 - (BOOL)hasEventsPending;
  70
  71 /* operations */
  72
  73 - (BOOL)isValidForURL:(NSURL *)_url;
  74 - (BOOL)isExpired;
  75 - (BOOL)renewSubscription;
  76 - (void)resetEvents;
  77
  78 @end
  79
  80 #endif /* __NGObjWeb_SoSubscription_H__ */