Cascade
Loading...
Searching...
No Matches
Buzzware.Cascade.IBlobCache Interface Reference

Defines a cache for storing and retrieving blob data in a Cascade data layer. More...

Inheritance diagram for Buzzware.Cascade.IBlobCache:
Buzzware.Cascade.FileBlobCache

Public Member Functions

Task ClearAll (bool exceptHeld, DateTime? olderThan)
 Clears all entries from the cache, with options to retain certain entries.
Task< OpResponseFetch (RequestOp requestOp)
 Attempts to retrieve an operation response from the cache based on a request operation.
Task< OpResponseStore (OpResponse opResponse)
 Stores a specific operation response in the cache.
Task NotifyBlobIsFresh (string blobPath, long arrivedAtMs)
string GetAbsoluteFilePath (string blobPath)
 Get the absolute file system path for a given blob path.
Task Clear (string blobPath)

Properties

CascadeDataLayer Cascade [get, set]
 the Cascade instance this cache is associated with.
bool SupportsGetAbsoluteFilePath [get]
 Is this able to provide file paths for blobs ?

Detailed Description

Defines a cache for storing and retrieving blob data in a Cascade data layer.

Member Function Documentation

◆ ClearAll()

Task Buzzware.Cascade.IBlobCache.ClearAll ( bool exceptHeld,
DateTime? olderThan )

Clears all entries from the cache, with options to retain certain entries.

Parameters
exceptHeldIndicates whether to retain entries held in cache even after clearing.
olderThanOptional parameter specifying a date. Clears only entries older than this date.

Implemented in Buzzware.Cascade.FileBlobCache.

◆ Fetch()

Task< OpResponse > Buzzware.Cascade.IBlobCache.Fetch ( RequestOp requestOp)

Attempts to retrieve an operation response from the cache based on a request operation.

Parameters
requestOpThe request operation used to query the cache.
Returns
An OpResponse if found in the cache; otherwise, may generate a cache miss.

Implemented in Buzzware.Cascade.FileBlobCache.

◆ GetAbsoluteFilePath()

string Buzzware.Cascade.IBlobCache.GetAbsoluteFilePath ( string blobPath)

Get the absolute file system path for a given blob path.

Parameters
blobPath
Returns

Implemented in Buzzware.Cascade.FileBlobCache.

◆ Store()

Task< OpResponse > Buzzware.Cascade.IBlobCache.Store ( OpResponse opResponse)

Stores a specific operation response in the cache.

Parameters
opResponseThe operation response to store in the cache.

Implemented in Buzzware.Cascade.FileBlobCache.

Property Documentation

◆ Cascade

CascadeDataLayer Buzzware.Cascade.IBlobCache.Cascade
getset

the Cascade instance this cache is associated with.

Implemented in Buzzware.Cascade.FileBlobCache.

◆ SupportsGetAbsoluteFilePath

bool Buzzware.Cascade.IBlobCache.SupportsGetAbsoluteFilePath
get

Is this able to provide file paths for blobs ?

Implemented in Buzzware.Cascade.FileBlobCache.


The documentation for this interface was generated from the following file:
  • Buzzware.Cascade/interfaces/IBlobCache.cs