client

package

v0.0.0-...-9b29f16 Latest Latest Go to latest Published: Apr 15, 2024 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/converged-computing/ensemble-operator

Documentation ¶

Index ¶

type Client
- func NewClient(host string) (Client, error)
type EnsembleClient

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client interface {

	// Ensemble interactions
	RequestStatus(ctx context.Context, in *pb.StatusRequest, opts ...grpc.CallOption) (*pb.Response, error)
	RequestAction(ctx context.Context, in *pb.ActionRequest, opts ...grpc.CallOption) (*pb.Response, error)
}

Client interface defines functions required for a valid client

func NewClient ¶

func NewClient(host string) (Client, error)

NewClient creates a new EnsembleClient

type EnsembleClient ¶

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

EnsembleClient interacts with client endpoints

func (*EnsembleClient) Close ¶

func (c *EnsembleClient) Close() error

Close closes the created resources (e.g. connection).

func (*EnsembleClient) Connected ¶

func (c *EnsembleClient) Connected() bool

Connected returns true if we are connected and the connection is ready

func (*EnsembleClient) GetHost ¶

func (c *EnsembleClient) GetHost() string

GetHost returns the private hostn name

func (*EnsembleClient) RequestAction ¶

func (c *EnsembleClient) RequestAction(
	ctx context.Context,
	in *pb.ActionRequest,
	opts ...grpc.CallOption,
) (*pb.Response, error)

func (*EnsembleClient) RequestStatus ¶

func (c *EnsembleClient) RequestStatus(
	ctx context.Context,
	in *pb.StatusRequest,
	opts ...grpc.CallOption,
) (*pb.Response, error)

RequestStatus gets the queue and jobs status. This is primarily for scaling/termination

Source Files ¶

View all Source files

client.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL