client

Documentation

Overview

Package client provides helper methods and types for communicating with the GAPIS service.

Index

• Constants
• func New(c service.GapidClient) service.Service
• type Client
  • func Bind(conn *grpc.ClientConn) Client
  • func Connect(ctx context.Context, cfg Config) (Client, error)
• type Config

Constants

const (
	BinaryName = "gapis"
)

Functions

func New

func New(c service.GapidClient) service.Service

New creates a new client using c for communication.

Types

type Client

type Client interface {
	service.Service

	// Close closes the client connection.
	Close() error
}

Client is the interface used for service calls.

func Bind

func Bind(conn *grpc.ClientConn) Client

Bind creates a new rpc client using conn for communication.

func Connect

func Connect(ctx context.Context, cfg Config) (Client, error)

Connect attempts to connect to a GAPIS process. If port is zero, a new GAPIS server will be started, otherwise a connection will be made to the specified port.

type Config

type Config struct {
	Path  *file.Path
	Port  int
	Args  []string
	Token auth.Token
}