constants

Documentation

Index

• type CacheType
• type CompressionLibraryType
• type RedisType

Types

type CacheType

type CacheType int32

CacheType is the type of cache to use for Heimdall

const (
	// CustomCacheType allows the user to BYOC (Bring your own cache) as long as the user's cache client
	// implements the ClientAPIs interface
	CustomCacheType CacheType = iota + 1
	// RedisCacheType uses redis as a cache. It currently supports a single redis instance or a cluster.
	// Under the hood, it uses the go-redis library. The user has to pass in required attributes to connect
	// to redis itself. Supports redis 7.
	RedisCacheType
)

type CompressionLibraryType

type CompressionLibraryType int32

const (
	// NoCompression will disable compression and uncompressed values are stored in the cache.
	NoCompressionType CompressionLibraryType = iota
	// GzipCompression will enable compression and values are compressed with the GZIP library and stored in the cache.
	GzipCompressionType
	// SnappyCompression will enable compression and values are compressed with the Snappy library and stored in the cache.
	SnappyCompressionType
)

type RedisType

type RedisType int32

RedisType is the type of redis server configuration the user is using.

const (
	// SingularRedisType is a default redis server.
	SingularRedisType RedisType = iota + 1
	// ClusterRedisType is a redis server that is set up in cluster mode.
	ClusterRedisType
)