io.envoyproxy.controlplane.cache

Interface SnapshotCache<T>

All Superinterfaces:

Cache<T>, ConfigWatcher

All Known Implementing Classes:

SimpleCache

public interface SnapshotCache<T>
extends Cache<T>

Method Summary

Modifier and Type	Method and Description
boolean	clearSnapshot(T group) Clears the most recently set Snapshot and associated metadata for the given node group.
Snapshot	getSnapshot(T group) Returns the most recently set Snapshot for the given node group.
void	setSnapshot(T group, Snapshot snapshot) Set the Snapshot for the given node group.

Methods inherited from interface io.envoyproxy.controlplane.cache.Cache

groups, statusInfo

Methods inherited from interface io.envoyproxy.controlplane.cache.ConfigWatcher

createWatch

Method Detail

clearSnapshot

boolean clearSnapshot(T group)

Clears the most recently set Snapshot and associated metadata for the given node group.

Should only be called when the Snapshot will no longer be needed, e.g. when there are no open watches for the group.

Implementations are free to ignore this call should it possibly leave the cache in a bad state, e.g. causing watches to hang waiting for Snapshot options that will never happen.

Parameters:

group - group identifier

Returns:

true if the snapshot was cleared, false otherwise

getSnapshot

Snapshot getSnapshot(T group)

Returns the most recently set Snapshot for the given node group.

Parameters:

group - group identifier

Returns:

latest snapshot

setSnapshot

void setSnapshot(T group,
                 Snapshot snapshot)

Set the Snapshot for the given node group. Snapshots should have distinct versions and be internally consistent (i.e. all referenced resources must be included in the snapshot).

Parameters:

group - group identifier

snapshot - a versioned collection of node config data