View Source Plausible.Shield.IPRuleCache (Plausible v0.0.1)

Allows retrieving IP Rules by domain and IP

Summary

Functions

child_spec(opts)

get(key, opts \\ [])

get_or_store(key, fallback_fn, opts \\ [])

hit_rate(cache_name \\ name())

See Plausible.Cache.Stats.hit_rate/1.

merge_items(new_items, opts \\ [])

ready?(cache_name \\ name())

Ensures the cache has non-zero size unless no items exist. Useful for orchestrating app startup to prevent the service going up asynchronously with an empty cache.

refresh_all(opts \\ [])

refresh_updated_recently(opts \\ [])

size(cache_name \\ name())

See Plausible.Cache.Adapter.size/1.

telemetry_event_refresh(cache_name \\ name(), mode)

Functions

child_spec(opts)

@spec child_spec(Keyword.t()) :: Supervisor.child_spec()

get(key, opts \\ [])

@spec get(any(), Keyword.t()) :: any() | nil

get_or_store(key, fallback_fn, opts \\ [])

@spec get_or_store(any(), (-> any()), Keyword.t()) :: any() | nil

hit_rate(cache_name \\ name())

See Plausible.Cache.Stats.hit_rate/1.

merge_items(new_items, opts \\ [])

@spec merge_items(new_items :: [any()], opts :: Keyword.t()) :: :ok

ready?(cache_name \\ name())

@spec ready?(atom()) :: boolean()

Ensures the cache has non-zero size unless no items exist. Useful for orchestrating app startup to prevent the service going up asynchronously with an empty cache.

refresh_all(opts \\ [])

@spec refresh_all(Keyword.t()) :: :ok

refresh_updated_recently(opts \\ [])

@spec refresh_updated_recently(Keyword.t()) :: :ok

size(cache_name \\ name())

See Plausible.Cache.Adapter.size/1.

telemetry_event_refresh(cache_name \\ name(), mode)

@spec telemetry_event_refresh(atom(), atom()) :: [atom()]