check

Documentation

Overview

Package check implements a xlist.Checker client and a ready to use service component.

This package is a work in progress and makes no API stability promises.

Index

• Constants
• func ClientBuilder(opt ...ClientOption) apiservice.BuildFn
• func RegisterServer(server *grpc.Server, service *Service)
• func ServiceName() string
• type Client
  • func NewClient(conn *grpc.ClientConn, opt ...ClientOption) *Client
  • func (c *Client) API() string
  • func (c *Client) Check(ctx context.Context, name string, resource xlist.Resource) (xlist.Response, error)
  • func (c *Client) Close() error
  • func (c *Client) Flush()
  • func (c *Client) Ping() error
  • func (c *Client) Resources(ctx context.Context) ([]xlist.Resource, error)
• type ClientOption
  • func CloseConnection(b bool) ClientOption
  • func SetCache(minttl, maxttl int) ClientOption
  • func SetCacheCleanUps(d time.Duration) ClientOption
  • func SetLogger(l yalogi.Logger) ClientOption
• type Service
  • func NewService(checker xlist.Checker, opt ...ServiceOption) *Service
  • func (s *Service) Check(ctx context.Context, in *pb.CheckRequest) (*pb.CheckResponse, error)
  • func (s *Service) Resources(ctx context.Context, in *empty.Empty) (*pb.ResourcesResponse, error)
• type ServiceOption
  • func SetServiceLogger(l yalogi.Logger) ServiceOption

Constants

const (
	APIName    = "luids.xlist"
	APIVersion = "v1"
	APIService = "Check"
)

Constants for api description

Functions

func ClientBuilder

func ClientBuilder(opt ...ClientOption) apiservice.BuildFn

ClientBuilder returns builder function

func RegisterServer

func RegisterServer(server *grpc.Server, service *Service)

RegisterServer registers a service in the grpc server.

func ServiceName

func ServiceName() string

ServiceName returns service name

Types

type Client

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

Client provides a grpc client.

func NewClient

func NewClient(conn *grpc.ClientConn, opt ...ClientOption) *Client

NewClient returns a new Client.

func (*Client) API

func (c *Client) API() string

API returns API service name implemented.

func (*Client) Check

func (c *Client) Check(ctx context.Context, name string, resource xlist.Resource) (xlist.Response, error)

Check implements xlist.Checker interface.

func (*Client) Close

func (c *Client) Close() error

Close the client.

func (*Client) Flush

func (c *Client) Flush()

Flush cache if set.

func (*Client) Ping

func (c *Client) Ping() error

Ping checks connectivity with the api.

func (*Client) Resources

func (c *Client) Resources(ctx context.Context) ([]xlist.Resource, error)

Resources implements xlist.Checker interface.

type ClientOption

type ClientOption func(*clientOpts)

ClientOption encapsules options for client.

func CloseConnection

func CloseConnection(b bool) ClientOption

CloseConnection option closes grpc connection on close.

func SetCache

func SetCache(minttl, maxttl int) ClientOption

SetCache sets cache ttl and negative ttl.

func SetCacheCleanUps

func SetCacheCleanUps(d time.Duration) ClientOption

SetCacheCleanUps sets interval between cache cleanups.

func SetLogger

func SetLogger(l yalogi.Logger) ClientOption

SetLogger option allows set a custom logger.

type Service

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

Service implements a grpc service wrapper.

func NewService

func NewService(checker xlist.Checker, opt ...ServiceOption) *Service

NewService returns a new Service.

func (*Service) Check

func (s *Service) Check(ctx context.Context, in *pb.CheckRequest) (*pb.CheckResponse, error)

Check implements grpc api.

func (*Service) Resources

func (s *Service) Resources(ctx context.Context, in *empty.Empty) (*pb.ResourcesResponse, error)

Resources implements grpc api.

type ServiceOption

type ServiceOption func(*serviceOpts)

ServiceOption is used for service configuration.

func SetServiceLogger

func SetServiceLogger(l yalogi.Logger) ServiceOption

SetServiceLogger option allows set a custom logger.