locksmith

package
v0.5.4 Latest Latest
Warning

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

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

Documentation

Overview

Package locksmith ties together the Locksmith server logic.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Locksmith

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

Locksmith is the root level object containing the implementation of the Locksmith server.

func New

func New(opts *Opts) (*Locksmith, error)

New creates a new Locksmith instance with the provided options.

func (*Locksmith) Start

func (l *Locksmith) Start(ctx context.Context) error

Start the Locksmith instance. This is a blocking call that can be unblocked by cancelling the provided context.

type Opts added in v0.5.2

type Opts struct {
	// Used for telemetry.
	Version string

	// Port denotes the port which will listen for incoming connections.
	Port uint16

	// QueueType selects the type of queue layer the vault will use.
	QueueType vault.QueueType

	// QueueConcurrency sets the number of synchronization threads, the higher the number the less the chance of congestion.
	QueueConcurrency int

	// QueueCapacity determines the buffer size of each synchronization thread, after the buffer limit is reached, calls
	// to the queue layer will block until the congestion is resolved.
	QueueCapacity int

	// TLSConfig for the TCP acceptor.
	TLSConfig *tls.Config
}

Opts exposes the possible options to pass to a new Locksmith instance.

Jump to

Keyboard shortcuts

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