ratelimiter

Documentation

Index

• type Client
  • func New(ctx context.Context, cc grpc.ClientConnInterface, config config.Config) *Client
  • func (c *Client) AcquireResource(ctx context.Context, coordinationNodePath string, resourcePath string, ...) (err error)
  • func (c *Client) AlterResource(ctx context.Context, coordinationNodePath string, ...) (err error)
  • func (c *Client) Close(ctx context.Context) error
  • func (c *Client) CreateResource(ctx context.Context, coordinationNodePath string, ...) (err error)
  • func (c *Client) DescribeResource(ctx context.Context, coordinationNodePath string, resourcePath string) (resource *ratelimiter.Resource, err error)
  • func (c *Client) DropResource(ctx context.Context, coordinationNodePath string, resourcePath string) (err error)
  • func (c *Client) ListResource(ctx context.Context, coordinationNodePath string, resourcePath string, ...) (list []string, _ error)

Types

type Client

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

func New

func New(ctx context.Context, cc grpc.ClientConnInterface, config config.Config) *Client

func (*Client) AcquireResource

func (c *Client) AcquireResource(
	ctx context.Context,
	coordinationNodePath string,
	resourcePath string,
	amount uint64,
	opts ...options.AcquireOption,
) (err error)

func (*Client) AlterResource

func (c *Client) AlterResource(
	ctx context.Context,
	coordinationNodePath string,
	resource ratelimiter.Resource,
) (err error)

func (*Client) Close

func (c *Client) Close(ctx context.Context) error

func (*Client) CreateResource

func (c *Client) CreateResource(
	ctx context.Context,
	coordinationNodePath string,
	resource ratelimiter.Resource,
) (err error)

func (*Client) DescribeResource

func (c *Client) DescribeResource(
	ctx context.Context,
	coordinationNodePath string,
	resourcePath string,
) (resource *ratelimiter.Resource, err error)

func (*Client) DropResource

func (c *Client) DropResource(
	ctx context.Context,
	coordinationNodePath string,
	resourcePath string,
) (err error)

func (*Client) ListResource

func (c *Client) ListResource(
	ctx context.Context,
	coordinationNodePath string,
	resourcePath string,
	recursive bool,
) (list []string, _ error)