From 892dde64aae50000aeb77f9213a0b3c1032bfb45 Mon Sep 17 00:00:00 2001 From: Tobe O Date: Sun, 1 Apr 2018 21:49:35 -0400 Subject: [PATCH] Documentation --- lib/src/cache.dart | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/lib/src/cache.dart b/lib/src/cache.dart index 7d481706..d1d16f16 100644 --- a/lib/src/cache.dart +++ b/lib/src/cache.dart @@ -8,13 +8,29 @@ final DateFormat _fmt = new DateFormat('EEE, d MMM yyyy HH:mm:ss'); /// Formats a date (converted to UTC), ex: `Sun, 03 May 2015 23:02:37 GMT`. String _formatDateForHttp(DateTime dt) => _fmt.format(dt.toUtc()) + ' GMT'; +/// A flexible response cache for Angel. +/// +/// Use this to improve real and perceived response of Web applications, +/// as well as to memoize expensive responses. class ResponseCache { + /// A set of [Patterns] for which responses will be cached. + /// + /// For example, you can pass a `Glob` matching `**/*.png` files to catch all PNG images. final List patterns = []; + + /// An optional timeout, after which a given response will be removed from the cache, and the contents refreshed. final Duration timeout; + final Map _cache = {}; + final Map _writeLocks = {}; ResponseCache({this.timeout}); + /// Closes all internal write-locks, and closes the cache. + Future close() async { + _writeLocks.forEach((_, p) => p.close()); + } + /// Removes an entry from the response cache. void invalidate(String path) => _cache.remove(path);