server

Documentation

Overview

This file contains the ldlm lock server. It exposes functions, not ports. For networking see the net package.

Index

• Variables
• type Lock
• type LockServer
  • func New(c *LockServerConfig) (*LockServer, func(), error)
  • func (l *LockServer) CreateSession(ctx context.Context, sessionInfo map[string]any) (string, context.Context)
  • func (l *LockServer) DestroySession(ctx context.Context) (sessionId string)
  • func (l *LockServer) Lock(ctx context.Context, name string, size *int32, lockTimeoutSeconds *int32, ...) (*Lock, error)
  • func (l *LockServer) Locks() []cl.Lock
  • func (l *LockServer) RefreshLock(ctx context.Context, name string, key string, lockTimeoutSeconds int32) (*Lock, error)
  • func (l *LockServer) SessionId(ctx context.Context) (string, bool)
  • func (l *LockServer) TryLock(ctx context.Context, name string, size *int32, lockTimeoutSeconds *int32) (*Lock, error)
  • func (l *LockServer) Unlock(ctx context.Context, name string, key string) (bool, error)
• type LockServerConfig

Variables

var (
	ErrEmptyName                    = errors.New("lock name cannot be empty")
	ErrLockWaitTimeout              = errors.New("timeout waiting to acquire lock")
	ErrLockDoesNotExistOrInvalidKey = errors.New("lock does not exist or invalid key")
	ErrSessionDoesNotExist          = errors.New("session does not exist")
	ErrInvalidLockTimeout           = errors.New("lock timeout must be greater than 0")
	ErrInvalidWaitTimeout           = errors.New("wait timeout must be greater than 0")
)

Types

type Lock

type Lock struct {
	Name   string
	Key    string
	Locked bool
}

Type returned by server's locking functions

type LockServer

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

Lock server

func New

func New(c *LockServerConfig) (*LockServer, func(), error)

New creates a new lock server.

It initializes a lock manager, session manager, and lock timer manager. It loads locks from the session manager and tries to lock all loaded locks. It starts the IPC server and returns the lock server instance and a closer function.

Parameters:

• c: a pointer to a LockServerConfig struct containing configuration options for the lock server.

Returns:

• a pointer to a LockServer struct representing the lock server.
• a function that closes the lock server.
• an error if there was an issue creating the lock server.

func (*LockServer) CreateSession

func (l *LockServer) CreateSession(ctx context.Context, sessionInfo map[string]any) (string, context.Context)

CreateSession creates a new session

func (*LockServer) DestroySession

func (l *LockServer) DestroySession(ctx context.Context) (sessionId string)

DestroySession destroys the session

func (*LockServer) Lock

func (l *LockServer) Lock(ctx context.Context, name string, size *int32, lockTimeoutSeconds *int32, waitTimeoutSeconds *int32) (*Lock, error)

Lock blocks until the lock is obtained or is canceled / timed out by context

func (*LockServer) Locks

func (l *LockServer) Locks() []cl.Lock

Locks returns a list of client locks.

func (*LockServer) RefreshLock

func (l *LockServer) RefreshLock(ctx context.Context, name string, key string, lockTimeoutSeconds int32) (*Lock, error)

RefreshLock refreshes a lock timer

func (*LockServer) SessionId

func (l *LockServer) SessionId(ctx context.Context) (string, bool)

SessionId returns the session ID from the context.

func (*LockServer) TryLock

func (l *LockServer) TryLock(ctx context.Context, name string, size *int32, lockTimeoutSeconds *int32) (*Lock, error)

TryLock attempts to acquire the lock and immediately fails or succeeds

func (*LockServer) Unlock

func (l *LockServer) Unlock(ctx context.Context, name string, key string) (bool, error)

Unlock surprisingly, unlocks a lock...

type LockServerConfig

type LockServerConfig struct {
	Shards              uint32        `desc:"Number of lock shards to use" default:"16"`
	LockGcInterval      time.Duration `desc:"Interval at which to garbage collect unused locks." default:"30m" short:"g"`
	LockGcMinIdle       time.Duration `` /* 133-byte string literal not displayed */
	DefaultLockTimeout  time.Duration `desc:"Lock timeout to use when loading locks from state file on startup" default:"10m" short:"d"`
	NoClearOnDisconnect bool          `desc:"Do not clear locks on client disconnect" default:"false" short:"n"`
	ipc.IPCConfig
	session.SessionConfig
}