hank_client

Documentation

Index

• Constants
• Variables
• func GetClientMetadata() (*hank.ClientMetadata, error)
• func NewHankSmartClientOptions() *hankSmartClientOptions
• type ConnectionSet
• type Entry
• type EnvironmentValue
• type HankCacheResponse
• type HankSmartClient
  • func New(coordinator iface.Coordinator, ringGroupName string, ...) (*HankSmartClient, error)
  • func (p *HankSmartClient) Get(domainName string, key []byte) (*HankCacheResponse, error)
  • func (p *HankSmartClient) OnChange(path string)
  • func (p *HankSmartClient) Stop()
• type HostConnection
  • func NewHostConnection(host iface.Host, tryLockTimeoutMs int32, establishConnectionTimeoutMs int32, ...) (*HostConnection, error)
  • func (p *HostConnection) Disconnect() error
  • func (p *HostConnection) Get(id iface.DomainID, key []byte, isLockHeld bool) (*hank.HankResponse, error)
  • func (p *HostConnection) IsDisconnected() bool
  • func (p *HostConnection) IsOffline() bool
  • func (p *HostConnection) IsServing() bool
  • func (p *HostConnection) Lock()
  • func (p *HostConnection) OnDataChange(newVal interface{}, path string) (err error)
  • func (p *HostConnection) TryImmediateLock() bool
  • func (p *HostConnection) TryLockWithTimeout() bool
  • func (p *HostConnection) Unlock()
• type HostConnectionPool
  • func CreateHostConnectionPool(connections []*HostConnection, hostShuffleSeed int64, preferredHosts []string) (*HostConnectionPool, error)
  • func NewHostConnectionPool(connectionsByHost map[string][]*HostConnection, hostShuffleSeed int64, ...) (*HostConnectionPool, error)
  • func (p *HostConnectionPool) Get(domain iface.Domain, key []byte, maxNumTries int32, keyHash int32) (*hank.HankResponse, error)
  • func (p *HostConnectionPool) GetConnectionLoad() (numConnections int64, numLockedConnections int64)
  • func (p *HostConnectionPool) GetConnections() []*HostConnection
• type IndexedHostConnection
• type QueryFailedErr
  • func (e *QueryFailedErr) Error() string
• type RequestCounters
  • func NewRequestCounters() *RequestCounters

Constants

const NO_HASH = -1

const NO_SEED = -1

const NumStatSamples = 3

const SampleSleepTime = time.Second

const StatInterval = time.Second * 30

Variables

var AssignmentsRegex = regexp.MustCompile(fmt.Sprintf("hosts/[-0-9]+/%v", zk_coordinator.ASSIGNMENTS_PATH))

we don't want to rebuild each time an updating host updates a version of a partition. we'll catch it when it switches back to active.

var SkipRebuildPaths = []*regexp.Regexp{AssignmentsRegex}

Functions

func GetClientMetadata

func GetClientMetadata() (*hank.ClientMetadata, error)

func NewHankSmartClientOptions

func NewHankSmartClientOptions() *hankSmartClientOptions

Types

type ConnectionSet

type ConnectionSet struct {
	// contains filtered or unexported fields
}

type Entry

type Entry struct {
	// contains filtered or unexported fields
}

type EnvironmentValue

type EnvironmentValue struct {
	Key   string
	Value string
}

type HankCacheResponse

type HankCacheResponse struct {
	*hank.HankResponse
	Cached bool
}

type HankSmartClient

type HankSmartClient struct {
	// contains filtered or unexported fields
}

func New

func New(
	coordinator iface.Coordinator,
	ringGroupName string,
	options *hankSmartClientOptions) (*HankSmartClient, error)

func (*HankSmartClient) Get

func (p *HankSmartClient) Get(domainName string, key []byte) (*HankCacheResponse, error)

func (*HankSmartClient) OnChange

func (p *HankSmartClient) OnChange(path string)

func (*HankSmartClient) Stop

func (p *HankSmartClient) Stop()

type HostConnection

type HostConnection struct {
	// contains filtered or unexported fields
}

func NewHostConnection

func NewHostConnection(
	host iface.Host,
	tryLockTimeoutMs int32,
	establishConnectionTimeoutMs int32,
	establishConnectionRetries int32,
	queryTimeoutMs int32,
	bulkQueryTimeoutMs int32,
) (*HostConnection, error)

func (*HostConnection) Disconnect

func (p *HostConnection) Disconnect() error

func (*HostConnection) Get

func (p *HostConnection) Get(id iface.DomainID, key []byte, isLockHeld bool) (*hank.HankResponse, error)

func (*HostConnection) IsDisconnected

func (p *HostConnection) IsDisconnected() bool

func (*HostConnection) IsOffline

func (p *HostConnection) IsOffline() bool

func (*HostConnection) IsServing

func (p *HostConnection) IsServing() bool

func (*HostConnection) Lock

func (p *HostConnection) Lock()

func (*HostConnection) OnDataChange

func (p *HostConnection) OnDataChange(newVal interface{}, path string) (err error)

func (*HostConnection) TryImmediateLock

func (p *HostConnection) TryImmediateLock() bool

func (*HostConnection) TryLockWithTimeout

func (p *HostConnection) TryLockWithTimeout() bool

func (*HostConnection) Unlock

func (p *HostConnection) Unlock()

type HostConnectionPool

type HostConnectionPool struct {
	// contains filtered or unexported fields
}

func CreateHostConnectionPool

func CreateHostConnectionPool(connections []*HostConnection, hostShuffleSeed int64, preferredHosts []string) (*HostConnectionPool, error)

func NewHostConnectionPool

func NewHostConnectionPool(connectionsByHost map[string][]*HostConnection, hostShuffleSeed int64, preferredHosts []string) (*HostConnectionPool, error)

func (*HostConnectionPool) Get

func (p *HostConnectionPool) Get(domain iface.Domain, key []byte, maxNumTries int32, keyHash int32) (*hank.HankResponse, error)

func (*HostConnectionPool) GetConnectionLoad

func (p *HostConnectionPool) GetConnectionLoad() (numConnections int64, numLockedConnections int64)

func (*HostConnectionPool) GetConnections

func (p *HostConnectionPool) GetConnections() []*HostConnection

type IndexedHostConnection

type IndexedHostConnection struct {
	// contains filtered or unexported fields
}

type QueryFailedErr

type QueryFailedErr struct {
	Msg string
}

QueryFailedErr is a classification of errors that are returned when a query is attempted on a Hank server but the query fails.

func (*QueryFailedErr) Error

func (e *QueryFailedErr) Error() string

type RequestCounters

type RequestCounters struct {
	// contains filtered or unexported fields
}

func NewRequestCounters

func NewRequestCounters() *RequestCounters