app

Documentation

Overview

Package app contains all logic needed for communication and interaction with app.

Index

• type Options
• type ViamClient
  • func CreateViamClientWithAPIKey(ctx context.Context, options Options, apiKey, apiKeyID string, ...) (*ViamClient, error)
  • func CreateViamClientWithOptions(ctx context.Context, options Options, logger logging.Logger) (*ViamClient, error)
  • func (c *ViamClient) Close() error

Types

type Options

type Options struct {
	// contains filtered or unexported fields
}

Options has the options necessary to connect through gRPC.

type ViamClient

type ViamClient struct {
	// contains filtered or unexported fields
}

ViamClient is a gRPC client for method calls to Viam app.

func CreateViamClientWithAPIKey

func CreateViamClientWithAPIKey(
	ctx context.Context, options Options, apiKey, apiKeyID string, logger logging.Logger,
) (*ViamClient, error)

CreateViamClientWithAPIKey creates a ViamClient with an API key.

func CreateViamClientWithOptions

func CreateViamClientWithOptions(ctx context.Context, options Options, logger logging.Logger) (*ViamClient, error)

CreateViamClientWithOptions creates a ViamClient with an Options struct.

func (*ViamClient) Close

func (c *ViamClient) Close() error

Close closes the gRPC connection.