bcclient

package
v0.8.0 Latest Latest
Warning

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

Go to latest
Published: Jun 24, 2026 License: GPL-3.0, MPL-2.0 Imports: 7 Imported by: 2

Documentation

Overview

Package bcclient provides a client for the Blobcache API.

Index

Constants

View Source
const DefaultEndpoint = "unix:///run/blobcache/blobcache.sock"

DefaultEndpoint is the endpoint assumed if the environment variable defined by EnvBlobcacheAPI (BLOBCACHE_API) is not set.

View Source
const (
	// EnvBlobcacheAPI is the name of the environment variable used
	// as the endpoint for the BLOBCACHE_API
	EnvBlobcacheAPI = "BLOBCACHE_API"
)
View Source
const (
	// EnvBlobcacheNSRoot configures the namespace root.
	// It is expected to be an OID on the local Node.
	EnvBlobcacheNSRoot = "BLOBCACHE_NS_ROOT"
)

Variables

This section is empty.

Functions

func EnvNSRoot added in v0.4.0

func EnvNSRoot() (blobcache.OID, error)

EnvNSRoot parses an OID read from the BLOBCACHE_NS_ROOT If the environment variable does not exist, then it returns the root OID If the variable cannot be parsed into an OID than an error is returned.

func NewClient

func NewClient(endpoint string) blobcache.Service

NewClient creates a Client backed by the server at endpoint

func NewClientFromEnv

func NewClientFromEnv() blobcache.Service

NewClientFromEnv creates a new client from environment variables

func NewNSClientFromEnv added in v0.8.0

func NewNSClientFromEnv() (bcns.Client, error)

NewNSClientFromEnv returns an bcns.Client configured from the environment.

Types

This section is empty.

Jump to

Keyboard shortcuts

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