cache

Documentation

Overview

Copyright 2022 VMware, Inc. SPDX-License-Identifier: Apache-2.0

Copyright 2022 VMware, Inc. SPDX-License-Identifier: Apache-2.0

Index

• Constants
• type Client
  • func GetClient(config *v1alpha1.Cache) (Client, error)
  • func NewRedisClient(c *v1alpha1.Cache) Client

Constants

const (
	// DialConnectionTimeout defines timeout for connecting to redis server.
	DialConnectionTimeout = 5 * time.Second
	// DialReadTimeout defines timeout for reading command.
	DialReadTimeout = 5 * time.Second
	// DialWriteTimeout defines timeout for writing command.
	DialWriteTimeout = 5 * time.Second
)

const (
	// ClientKindRedis represents redis cache kind.
	ClientKindRedis = "Redis"
)

Types

type Client

type Client interface {
	data.Reader
	data.Writer
}

Client for caching data.

func GetClient

func GetClient(config *v1alpha1.Cache) (Client, error)

GetClient is a cache client factory method. Init cache client based on the config provided.

func NewRedisClient

func NewRedisClient(c *v1alpha1.Cache) Client

NewRedisClient news a Redis cache client based on the provided configurations.