dist

Documentation

Overview

Copyright 2023 The acquirecloud Authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func New(path string) *kvsLockProvider
• type LockProvider
  • func NewKvsLockProvider(kvs kvs.Storage, path string) LockProvider

Functions

func New

func New(path string) *kvsLockProvider

New allows to create new instance of kvsLockProvider. It expects instance of kv.Storage and a prefix key for the lockers key-space

Types

type LockProvider

type LockProvider interface {
	sync.LockProvider
	linker.Shutdowner
}

LockProvider helper interface to indicate that the object has a lifecyle, which should be supported if created and used outside of linker

func NewKvsLockProvider

func NewKvsLockProvider(kvs kvs.Storage, path string) LockProvider

NewKvsLockProvider returns implementation of the LockProvider The resulted object has lifecycle (Shutdown must be called), so the function just indicates this fact. Prefer to use New(), instead of the object and let the linker does its job by supporting the object lifecycle.