vtctlclient

Documentation

Overview

Package vtctlclient contains the generic client side of the remote vtctl protocol.

Index

• func RegisterFactory(name string, factory Factory)
• func RegisterFlags(fs *pflag.FlagSet)
• func RunCommandAndWait(ctx context.Context, server string, args []string, recv func(*logutilpb.Event)) error
• type Factory
• type VtctlClient
  • func New(ctx context.Context, addr string) (VtctlClient, error)

Functions

func RegisterFactory

func RegisterFactory(name string, factory Factory)

RegisterFactory allows a client implementation to register itself.

func RegisterFlags

func RegisterFlags(fs *pflag.FlagSet)

func RunCommandAndWait

func RunCommandAndWait(ctx context.Context, server string, args []string, recv func(*logutilpb.Event)) error

RunCommandAndWait executes a single command on a given vtctld and blocks until the command did return or timed out. Output from vtctld is streamed as logutilpb.Event messages which have to be consumed by the caller who has to specify a "recv" function.

Types

type Factory

type Factory func(ctx context.Context, addr string) (VtctlClient, error)

Factory functions are registered by client implementations

type VtctlClient

type VtctlClient interface {
	// ExecuteVtctlCommand will execute the command remotely
	ExecuteVtctlCommand(ctx context.Context, args []string, actionTimeout time.Duration) (logutil.EventStream, error)

	// Close will terminate the connection. This object won't be
	// used after this.
	Close()
}

VtctlClient defines the interface used to send remote vtctl commands

func New

func New(ctx context.Context, addr string) (VtctlClient, error)

New allows a user of the client library to get its implementation.