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, consensus consensus.Backend, ...) (api.Backend, error)
• type Option
  • func WithBackendOverride(nodeID signature.PublicKey, backend api.Backend) Option

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,
	opts ...Option,
) (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,
	opts ...Option,
) (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,
	consensus consensus.Backend,
	runtime registry.RuntimeDescriptorProvider,
	opts ...Option,
) (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,
	consensus consensus.Backend,
	nodeID signature.PublicKey,
	opts ...Option,
) (api.Backend, error)

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

This is mostly useful for tests.

Types

type Option

type Option func(b *storageClientBackend)

Option is a storage client option.

func WithBackendOverride

func WithBackendOverride(nodeID signature.PublicKey, backend api.Backend) Option

WithBackendOverride overrides the storage backend for the specified node. The passed backend is used instead of the gRPC backend when performing storage requests.