CachingHttpClient class abstract

Abstract HTTP client wrapper that provides response caching capabilities.

Implementers

Constructors

CachingHttpClient({Client? inner, required Duration ttl, required int maxEntrySizeBytes, required int maxSizeBytes, required Duration cacheCheckPeriod, CacheInvalidationStrategy invalidationStrategy = CacheInvalidationStrategy.smart, void onCacheHit(String url, CacheStats stats)?})

Properties

activeInnerClient → Client
Returns active inner HTTP client or throws StateError if missing.
no setter
cacheCheckPeriod ↔ Duration
Interval between automatic cleanup sweeps of expired cache entries.
getter/setter pair
cacheCount → int
Returns the current number of cached entries.
no setter
currentSizeBytes ↔ int
Total size in bytes of all currently cached responses.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
inner ↔ Client?
Underlying HTTP client instance.
getter/setter pair
invalidationStrategy ↔ CacheInvalidationStrategy
Strategy used to invalidate cache when mutating HTTP requests occur.
getter/setter pair
lastCleanupTime ↔ DateTime
Timestamp of the last expired cache entries cleanup sweep.
getter/setter pair
maxEntrySizeBytes ↔ int
Maximum byte size allowed for a single cached response. Responses exceeding this limit will not be cached.
getter/setter pair
maxSizeBytes ↔ int
Maximum total byte size allowed for all cached responses combined.
getter/setter pair
onCacheHit → void Function(String url, CacheStats stats)?
Optional callback triggered when a request hits the cache, passing the request URL and current cache stats.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stats → CacheStats
Statistics for cache operations (hits, misses, ratios).
final
ttl ↔ Duration
Duration for which cached responses remain valid.
getter/setter pair

Methods

clearCache() → Future<void>
Manually clears all cached responses.
close() → void
Closes the client and cleans up any resources associated with it.
delete(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP DELETE request with the given headers to the given URL.
inherited
get(Uri url, {Map<String, String>? headers}) → Future<Response>
Sends an HTTP GET request with the given headers to the given URL.
inherited
Sends an HTTP HEAD request with the given headers to the given URL.
inherited
invalidateUrl(String urlOrPrefix) → void
Removes a specific URL or all URLs matching a path prefix from the cache.
isMutatingRequest(BaseRequest request) → bool
Determines if an HTTP request is mutating (writes/updates/deletes data).
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
patch(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP PATCH request with the given headers and body to the given URL.
inherited
post(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP POST request with the given headers and body to the given URL.
inherited
put(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP PUT request with the given headers and body to the given URL.
inherited
read(Uri url, {Map<String, String>? headers}) → Future<String>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a String.
inherited
readBytes(Uri url, {Map<String, String>? headers}) → Future<Uint8List>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a list of bytes.
inherited
send(BaseRequest request) → Future<StreamedResponse>
Sends an HTTP request and asynchronously returns the response.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited