Roxen.git/ server/ base_server/ prototypes.pike

Branch: Tag:

2007-09-20

2007-09-20 10:29:17 by Henrik Grubbström (Grubba) <grubba@grubba.org>

Added prototypes and documentation for CacheKey.invalid{ate,p}().

Rev: server/base_server/prototypes.pike:1.195

6:   #include <module.h>   #include <variables.h>   #include <module_constants.h> - constant cvs_version="$Id: prototypes.pike,v 1.194 2007/08/15 11:05:13 mast Exp $"; + constant cvs_version="$Id: prototypes.pike,v 1.195 2007/09/20 10:29:17 grubba Exp $";      #ifdef DAV_DEBUG   #define DAV_WERROR(X...) werror(X)
691:   //! @appears CacheKey   //!   //! Used as @expr{id->misc->cachekey@}. Every request that might be - //! cacheable has an instance, and the protocol cache which store the + //! cacheable has an instance, and the protocol cache which stores the   //! result of the request checks that this object still exists before   //! using the cache entry. Thus other subsystems that provide data to   //! the result can keep track of this object and destruct it whenever
701:   //! directly, but instead call @[add_activation_cb]. That avoids   //! unnecessary garbage (see below).   //! + //! There is also the option to have cache keys with an intermediate + //! stale state. The semantics of those is that the protocol cache + //! will continue to send cached results for stale cache objects until + //! they get destructed, but subsystems that rely on valid data may + //! use @[roxen.invalidp()] to check whether the data is stale or not. + //! + //! @[roxen.invalidate()] is used to force a cache key into the stale + //! state. + //!   //! A cache implementation must call @[activate] before storing the   //! cache key. At that point the functions registered with   //! @[add_activation_cb] are called, and the key gets added in the
731:    if (!activate_immediately) activation_cbs = ({});    }    +  int invalidp(); +  //! Has this cache key been invalidated. +  //! +  //! @note +  //! If this function does not exist, the key is assumed +  //! to be valid for as long as it hasn't been destructed. +  //! +  //! @seealso +  //! @[roxen.invalidp()], @[invalidate()] +  +  void invalidate(); +  //! Invalidation callback. +  //! +  //! Callback used for invalidating the cache key. +  //! +  //! @note +  //! If this function does not exist, invalidation is done +  //! by destructing the cache key. +  //! +  //! @seealso +  //! @[roxen.invalidate()], @[invalidp()] +     void add_activation_cb (CacheActivationCB cb, mixed... args)    //! Register a callback that will be called if and when this cache    //! key is used in a cache, i.e. is activated. The callback gets