Returns a specification to start this module under a supervisor.

See Supervisor.

@spec clear() :: :ok

Clears all cached data.

Examples

:ok = SnmpKit.SnmpLib.Cache.clear()

@spec delete(cache_key()) :: :ok

Removes a specific key from the cache.

Examples

:ok = SnmpKit.SnmpLib.Cache.delete("device_1:sysDescr")

@spec get(cache_key()) :: {:ok, cache_value()} | :miss

Retrieves a value from the cache.

Returns

• {:ok, value}: Cache hit with the stored value
• :miss: Cache miss, value not found or expired

Examples

case SnmpKit.SnmpLib.Cache.get("device_1:sysDescr") do
  {:ok, description} ->
    Logger.debug("Cache hit for system description")
    description
  :miss ->
    Logger.debug("Cache miss, performing SNMP query")
    perform_snmp_get(device, [1,3,6,1,2,1,1,1,0])
end

@spec get_stats() :: cache_stats()

Gets comprehensive cache performance statistics.

Returns

Statistics including hit rates, memory usage, and performance metrics.

Examples

cache_stats = SnmpKit.SnmpLib.Cache.get_stats()
IO.puts "Cache hit rate: " <> Float.to_string(Float.round(cache_stats.hit_rate * 100, 2)) <> "%"
IO.puts "Memory usage: " <> Float.to_string(Float.round(cache_stats.memory_usage_mb, 2)) <> " MB"

@spec invalidate_by_tag(atom()) :: :ok

Invalidates cache entries by tag.

Examples

SnmpKit.SnmpLib.Cache.invalidate_by_tag(:routing_data)

@spec invalidate_pattern(binary()) :: :ok

Invalidates multiple cache entries matching a pattern.

Supports wildcards (*) for pattern matching.

Examples

# Invalidate all data for a device
SnmpKit.SnmpLib.Cache.invalidate_pattern("device_1:*")

# Invalidate all interface data
SnmpKit.SnmpLib.Cache.invalidate_pattern("*:ifTable")

# Invalidate by tag
SnmpKit.SnmpLib.Cache.invalidate_by_tag(:interface_data)

@spec put(cache_key(), cache_value(), cache_opts()) :: :ok

Stores a value in the cache with specified options.

Parameters

• key: Unique cache key
• value: Data to cache
• opts: Caching options

Options

• ttl: Time-to-live in milliseconds (default: 300,000)
• strategy: Caching strategy (default: :time_based)
• volatility: Data change frequency (default: :medium)
• compress: Force compression for this entry (default: auto)
• dependencies: Keys that invalidate this entry when changed
• tags: Metadata tags for grouping and invalidation

Examples

# Simple time-based caching
:ok = SnmpKit.SnmpLib.Cache.put("device_1:sysDescr", "Cisco Router", ttl: 600_000)

# Adaptive caching based on volatility
:ok = SnmpKit.SnmpLib.Cache.put("device_1:ifTable", interface_data,
  strategy: :volatility_based,
  volatility: :high,
  tags: [:interface_data]
)

# Dependency-based caching
:ok = SnmpKit.SnmpLib.Cache.put("device_1:route_summary", summary_data,
  dependencies: ["device_1:routeTable", "device_1:arpTable"]
)

@spec put_adaptive(cache_key(), cache_value(), cache_ttl(), volatility()) :: :ok

Stores a value with adaptive TTL based on observed volatility.

The cache automatically adjusts TTL based on how frequently the data changes.

Parameters

• key: Cache key
• value: Data to cache
• base_ttl: Starting TTL value
• volatility: Expected change frequency

Examples

# Interface counters change frequently
SnmpKit.SnmpLib.Cache.put_adaptive("device_1:ifInOctets", counter_data,
  base_ttl: 30_000,
  volatility: :high
)

# System description rarely changes
SnmpKit.SnmpLib.Cache.put_adaptive("device_1:sysDescr", description,
  base_ttl: 3_600_000,
  volatility: :low
)

@spec start_link(keyword()) :: {:ok, pid()} | {:error, any()}

Starts the cache manager with specified configuration.

Options

• max_size: Maximum number of cache entries (default: 100,000)
• cleanup_interval: Cleanup frequency in milliseconds (default: 60,000)
• compression_enabled: Enable compression for large values (default: true)
• adaptive_ttl_enabled: Enable adaptive TTL based on volatility (default: true)
• predictive_enabled: Enable predictive caching (default: false)

Examples

# Start with defaults
{:ok, _pid} = SnmpKit.SnmpLib.Cache.start_link()

# Start with custom configuration
{:ok, _pid} = SnmpKit.SnmpLib.Cache.start_link(
  max_size: 50_000,
  compression_enabled: true,
  predictive_enabled: true
)

@spec warm_cache(binary(), [binary()] | :auto, keyword()) :: :ok

Pre-loads cache with expected data to improve response times.

Parameters

• device_id: Target device identifier
• oids: List of OIDs to pre-load
• strategy: Warming strategy (:immediate, :scheduled, :predictive)

Examples

# Immediate cache warming
SnmpKit.SnmpLib.Cache.warm_cache("device_1",
  ["1.3.6.1.2.1.1.1.0", "1.3.6.1.2.1.1.3.0"],
  strategy: :immediate
)

# Predictive warming based on historical access
SnmpKit.SnmpLib.Cache.warm_cache("device_1", :auto,
  strategy: :predictive
)