consul

Documentation

Index

• type Client
  • func NewConsulClient(logger log.Logger, config *Config) (*Client, error)
  • func (c *Client) AcquireLock(key string) error
  • func (c *Client) ClearSession() error
  • func (c *Client) SessionID() string
  • func (c *Client) Shutdown()
• type Config
• type Session
• type SessionConfig

Types

type Client

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

Client is a helpful wrapper around consul operations needed by achgateway. This client is not goroutine safe, so concurrnet calls are not supported.

func NewConsulClient

func NewConsulClient(logger log.Logger, config *Config) (*Client, error)

func (*Client) AcquireLock

func (c *Client) AcquireLock(key string) error

func (*Client) ClearSession

func (c *Client) ClearSession() error

ClearSession will attempt to wipe the existing session and create a new one. Often this is done as an attempt to resolve consul or network errors.

func (*Client) SessionID

func (c *Client) SessionID() string

func (*Client) Shutdown

func (c *Client) Shutdown()

type Config

type Config struct {
	Address     string
	Scheme      string
	SessionPath string
	Tags        []string

	Token     string
	TokenFile string

	Datacenter string
	Namespace  string

	Session *SessionConfig

	TLS api.TLSConfig
}

type Session

type Session struct {
	ID   string
	Name string
}

type SessionConfig

type SessionConfig struct {
	CheckInterval time.Duration
}