clients

Documentation

Index

• func FromExtension[T any](ctx context.Context, client managementv1.ManagementClient, serviceName string, ...) (T, error)
• func NewManagementClient(ctx context.Context, opts ...ManagementClientOption) (managementv1.ManagementClient, error)
• type ConnStats
  • func (c *ConnStats) DeliveryRate() uint64
  • func (c *ConnStats) HumanizedBytesReceived() string
  • func (c *ConnStats) HumanizedBytesSent() string
  • func (c *ConnStats) RTT() time.Duration
• type ConnStatsQuerier
• type GatewayClient
  • func NewGatewayClient(ctx context.Context, address string, ip ident.Provider, kr keyring.Keyring, ...) (GatewayClient, error)
• type Locker
  • func NewLocker[T any](cc grpc.ClientConnInterface, builder func(grpc.ClientConnInterface) T) Locker[T]
• type ManagementClientOption
  • func WithAddress(addr string) ManagementClientOption
  • func WithDialOptions(options ...grpc.DialOption) ManagementClientOption
• type ManagementClientOptions
  • func (o *ManagementClientOptions) Apply(opts ...ManagementClientOption)

Functions

func FromExtension

func FromExtension[T any](
	ctx context.Context,
	client managementv1.ManagementClient,
	serviceName string,
	constructor func(grpc.ClientConnInterface) T,
) (T, error)

func NewManagementClient

func NewManagementClient(ctx context.Context, opts ...ManagementClientOption) (managementv1.ManagementClient, error)

Types

type ConnStats

type ConnStats struct {
	Timestamp time.Time
	Raw       unix.TCPInfo
}

func (*ConnStats) DeliveryRate

func (c *ConnStats) DeliveryRate() uint64

Returns the socket throughput in bytes per second

func (*ConnStats) HumanizedBytesReceived

func (c *ConnStats) HumanizedBytesReceived() string

func (*ConnStats) HumanizedBytesSent

func (c *ConnStats) HumanizedBytesSent() string

func (*ConnStats) RTT

func (c *ConnStats) RTT() time.Duration

type ConnStatsQuerier

type ConnStatsQuerier interface {
	QueryConnStats() (ConnStats, error)
}

Experimental on darwin systems

type GatewayClient

type GatewayClient interface {
	grpc.ServiceRegistrar
	ConnStatsQuerier
	// credentials.PerRPCCredentials
	// Connect returns a ClientConnInterface connected to the streaming server.
	// The connection remains active until the provided context is canceled.
	Connect(context.Context) (grpc.ClientConnInterface, future.Future[error])
	RegisterSplicedStream(cc grpc.ClientConnInterface, name string)
	ClientConn() grpc.ClientConnInterface
}

func NewGatewayClient

func NewGatewayClient(
	ctx context.Context,
	address string,
	ip ident.Provider,
	kr keyring.Keyring,
	trustStrategy trust.Strategy,
) (GatewayClient, error)

type Locker

type Locker[T any] interface {
	// Use obtains exclusive ownership of the client, then calls the provided
	// function with the client. Ownership of the client is maintained until the
	// function returns.
	// It is safe to call Use if the Locker is nil; it will simply return false.
	Use(func(T)) bool
	// Close releases the client. After Close is called, Use() will return false.
	Close()
}

func NewLocker

func NewLocker[T any](cc grpc.ClientConnInterface, builder func(grpc.ClientConnInterface) T) Locker[T]

type ManagementClientOption

type ManagementClientOption func(*ManagementClientOptions)

func WithAddress

func WithAddress(addr string) ManagementClientOption

func WithDialOptions

func WithDialOptions(options ...grpc.DialOption) ManagementClientOption

type ManagementClientOptions

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

func (*ManagementClientOptions) Apply

func (o *ManagementClientOptions) Apply(opts ...ManagementClientOption)