locket

README

locket

Note: This repository should be imported as code.cloudfoundry.org/locket.

Locket is a distributed locking service and client libraries to integrate with the service

Reporting issues and requesting features

Please report all issues and feature requests in cloudfoundry/diego-release.

Server

Diego Client for Setting/Fetching Locks and Presence

Client

There is currently one valid client

1. the locket client which can be used with the locket service.

A general overview of the Locket API can be found here. You can learn more about Diego and its components at diego-design-notes.

Documentation

Index

• Constants
• func LockSchemaPath(lockName ...string) string
• func NewClient(logger lager.Logger, config ClientLocketConfig) (models.LocketClient, error)
• func NewClientSkipCertVerify(logger lager.Logger, config ClientLocketConfig) (models.LocketClient, error)
• type ClientLocketConfig

Constants

const DefaultSessionTTL = 15 * time.Second

const DefaultSessionTTLInSeconds int64 = 15

const ExpirationMetricsInterval = 60 * time.Second

const LockSchemaRoot = "v1/locks"

const MonitorRetryTime = 2 * time.Second

const RetryInterval = 5 * time.Second

const SQLRetryInterval = time.Second

Functions

func LockSchemaPath

func LockSchemaPath(lockName ...string) string

func NewClient

func NewClient(logger lager.Logger, config ClientLocketConfig) (models.LocketClient, error)

func NewClientSkipCertVerify

func NewClientSkipCertVerify(logger lager.Logger, config ClientLocketConfig) (models.LocketClient, error)

Types

type ClientLocketConfig

type ClientLocketConfig struct {
	LocketAddress                string `json:"locket_address,omitempty" yaml:"locket_address,omitempty"`
	LocketCACertFile             string `json:"locket_ca_cert_file,omitempty" yaml:"locket_ca_cert_file,omitempty"`
	LocketClientCertFile         string `json:"locket_client_cert_file,omitempty" yaml:"locket_client_cert_file,omitempty"`
	LocketClientKeyFile          string `json:"locket_client_key_file,omitempty" yaml:"locket_client_key_file,omitempty"`
	LocketClientKeepAliveTime    int    `json:"locket_client_keepalive_time,omitempty" yaml:"locket_client_keepalive_time,omitempty"`
	LocketClientKeepAliveTimeout int    `json:"locket_client_keepalive_timeout,omitempty" yaml:"locket_client_keepalive_timeout,omitempty"`
}