client

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 10, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Overview

Package client provides a sample implementation of a Locksmith client.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client interface {
	Acquire(lockTag string) error
	Release(lockTag string) error
	Connect() error
	Close()
}

Client provides a simple interface for a Locksmith client.

func New added in v0.5.2

func New(options *Opts) Client

New creates a new Client with the given options.

type Opts added in v0.5.2

type Opts struct {
	Host           string
	Port           uint16
	TLSConfig      *tls.Config
	OnAcquired     func(lockTag string)
	OnDisconnected func()
}

Opts to provide at client instantiation.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL