client

Documentation

Index

• type Client
  • func NewClient(host string) (Client, error)
• type CompatClient
  • func (c CompatClient) CheckCompatibility(ctx context.Context, tocheck string) (*pb.Response, error)
  • func (c *CompatClient) Close() error
  • func (c *CompatClient) Connected() bool
  • func (c *CompatClient) GetHost() string

Types

type Client

type Client interface {
	CheckCompatibility(ctx context.Context, tocheck string) (*pb.Response, error)
}

Client interface defines functions required for a valid client

func NewClient

func NewClient(host string) (Client, error)

NewClient creates a new RainbowClient

type CompatClient

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

CompatClient interacts with a compatibility server

func (CompatClient) CheckCompatibility

func (c CompatClient) CheckCompatibility(ctx context.Context, tocheck string) (*pb.Response, error)

Check compatibility of an artifact against the known service database toCheck can be either a URI (to download from a registry) or the path to a json file. Right now I'm assuming the json path.

func (*CompatClient) Close

func (c *CompatClient) Close() error

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

func (*CompatClient) Connected

func (c *CompatClient) Connected() bool

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

func (*CompatClient) GetHost

func (c *CompatClient) GetHost() string

GetHost returns the private hostn name