rpc

Documentation

Overview

Package rpc implements a rate-limited RPC service.

Index

• func New() pb.DemoServer
• type Demo
  • func (*Demo) GlobalQuotaReset(ctx context.Context, _ *emptypb.Empty) (*emptypb.Empty, error)
  • func (*Demo) GlobalRateLimit(ctx context.Context, _ *emptypb.Empty) (*emptypb.Empty, error)
  • func (*Demo) PerUserQuotaReset(ctx context.Context, _ *emptypb.Empty) (*emptypb.Empty, error)
  • func (*Demo) PerUserRateLimit(ctx context.Context, _ *emptypb.Empty) (*emptypb.Empty, error)

Functions

func New

func New() pb.DemoServer

New returns a new pb.DemoServer.

Types

type Demo

type Demo struct {
}

Demo implements pb.DemoServer. Requires a quotaconfig.Interface in the context for all method calls.

func (*Demo) GlobalQuotaReset

func (*Demo) GlobalQuotaReset(ctx context.Context, _ *emptypb.Empty) (*emptypb.Empty, error)

GlobalQuotaReset resets quota for calling GlobalRateLimit. Always succeeds, returning an *emptypb.Empty.

func (*Demo) GlobalRateLimit

func (*Demo) GlobalRateLimit(ctx context.Context, _ *emptypb.Empty) (*emptypb.Empty, error)

GlobalRateLimit is globally limited to one request every 60 seconds. This quota can be reset at any time by calling GlobalQuotaReset. On success, returns an *emptypb.Empty, and on failure returns a codes.ResourceExhausted gRPC error.

func (*Demo) PerUserQuotaReset

func (*Demo) PerUserQuotaReset(ctx context.Context, _ *emptypb.Empty) (*emptypb.Empty, error)

PerUserQuotaReset resets the caller's own quota for calling PerUserRateLimit. Always succeeds, returning an *emptypb.Empty.

func (*Demo) PerUserRateLimit

func (*Demo) PerUserRateLimit(ctx context.Context, _ *emptypb.Empty) (*emptypb.Empty, error)

PerUserRateLimit is limited to two requests every 60 seconds for a given user. This quota can be reset at any time by calling PerUserQuotaReset. On success, returns an *emptypb.Empty, and on failure returns a codes.ResourceExhausted gRPC error.