client

Documentation

Overview

Package client implements a client for Oasis storage nodes. The client connects to nodes as directed by the node watcher.

Index

• Constants
• Variables
• func NewForNodes(ctx context.Context, ident *identity.Identity, ...) (api.Backend, error)
• func NewForNodesClient(ctx context.Context, client grpc.NodesClient, ...) (api.Backend, error)
• func NewForPublicStorage(ctx context.Context, namespace common.Namespace, ident *identity.Identity, ...) (api.Backend, error)
• func NewStatic(ctx context.Context, ident *identity.Identity, ...) (api.Backend, error)

Constants

const BackendName = "client"

BackendName is the name of this implementation.

Variables

var ErrStorageNotAvailable = errors.New("storage/client: storage not available")

ErrStorageNotAvailable is the error returned when no storage node is available.

Functions

func NewForNodes

func NewForNodes(
	ctx context.Context,
	ident *identity.Identity,
	nodes nodes.NodeDescriptorLookup,
	runtime registry.RuntimeDescriptorProvider,
) (api.Backend, error)

NewForNodes creates a new storage client that connects to nodes watched by the provided nodes lookup.

func NewForNodesClient

func NewForNodesClient(
	ctx context.Context,
	client grpc.NodesClient,
	runtime registry.RuntimeDescriptorProvider,
) (api.Backend, error)

NewForNodesClient creates a new storage client that connects to nodes watched by the provided nodes gRPC client.

func NewForPublicStorage

func NewForPublicStorage(
	ctx context.Context,
	namespace common.Namespace,
	ident *identity.Identity,
	registryBackend registry.Backend,
	runtime registry.RuntimeDescriptorProvider,
) (api.Backend, error)

NewForPublicStorage creates a new storage client that automatically follows a given runtime's storage nodes which have public storage RPC enabled.

func NewStatic

func NewStatic(
	ctx context.Context,
	ident *identity.Identity,
	registryBackend registry.Backend,
	nodeID signature.PublicKey,
) (api.Backend, error)

NewStatic creates a new storage client that only follows a specific storage node.

This is mostly useful for tests.