Documentation ¶
Index ¶
- func DefaultOpts() []grpc.ServerOption
- type GRPC
- type GRPCAUTH
- type GRPCAUTHV3
- type GRPCAgent
- type GRPCRLS
- type GRPCRLSV3
- type HTTP
- type RLSResponse
- func (r *RLSResponse) AddHeader(a bool, k, v string)
- func (r *RLSResponse) GetHTTPHeaderMap() *http.Header
- func (r *RLSResponse) GetOverallCode() pb.RateLimitResponse_Code
- func (r *RLSResponse) GetResponse() *pb.RateLimitResponse
- func (r *RLSResponse) SetBody(s string)
- func (r *RLSResponse) SetOverallCode(code pb.RateLimitResponse_Code)
- type RLSResponseV3
- func (r *RLSResponseV3) AddHeader(a bool, k, v string)
- func (r *RLSResponseV3) GetHTTPHeaderMap() *http.Header
- func (r *RLSResponseV3) GetOverallCode() pb.RateLimitResponse_Code
- func (r *RLSResponseV3) GetResponse() *pb.RateLimitResponse
- func (r *RLSResponseV3) SetBody(s string)
- func (r *RLSResponseV3) SetOverallCode(code pb.RateLimitResponse_Code)
- type Response
- type ResponseV3
- type Service
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type GRPC ¶
type GRPC struct { Port int16 Backend string SecurePort int16 SecureBackend string Cert string Key string }
GRPC server object (all fields are required).
func (*GRPC) Echo ¶
func (g *GRPC) Echo(ctx context.Context, r *pb.EchoRequest) (*pb.EchoResponse, error)
Echo returns the an object with the HTTP context of the request.
type GRPCAUTH ¶
type GRPCAUTH struct { Port int16 Backend string SecurePort int16 SecureBackend string Cert string Key string ProtocolVersion string }
GRPCAUTH server object (all fields are required).
func (*GRPCAUTH) Check ¶
func (g *GRPCAUTH) Check(ctx context.Context, r *pb.CheckRequest) (*pb.CheckResponse, error)
Check checks the request object.
type GRPCAUTHV3 ¶
type GRPCAUTHV3 struct { Port int16 Backend string SecurePort int16 SecureBackend string Cert string Key string ProtocolVersion string }
GRPCAUTHV3 server object (all fields are required).
func (*GRPCAUTHV3) Check ¶
func (g *GRPCAUTHV3) Check(ctx context.Context, r *pb.CheckRequest) (*pb.CheckResponse, error)
Check checks the request object.
type GRPCRLS ¶
type GRPCRLS struct { Port int16 Backend string SecurePort int16 SecureBackend string Cert string Key string ProtocolVersion string }
GRPCRLS server object (all fields are required).
func (*GRPCRLS) ShouldRateLimit ¶
func (g *GRPCRLS) ShouldRateLimit(ctx context.Context, r *pb.RateLimitRequest) (*pb.RateLimitResponse, error)
Check checks the request object.
type GRPCRLSV3 ¶
type GRPCRLSV3 struct { Port int16 Backend string SecurePort int16 SecureBackend string Cert string Key string ProtocolVersion string }
GRPCRLSV3 server object (all fields are required).
func (*GRPCRLSV3) ShouldRateLimit ¶
func (g *GRPCRLSV3) ShouldRateLimit(ctx context.Context, r *pb.RateLimitRequest) (*pb.RateLimitResponse, error)
Check checks the request object.
type HTTP ¶
type HTTP struct { Port int16 Backend string SecurePort int16 SecureBackend string Cert string Key string TLSVersion string }
HTTP server object (all fields are required).
type RLSResponse ¶
type RLSResponse struct {
// contains filtered or unexported fields
}
RLSResponse constructs an rls response object.
func (*RLSResponse) AddHeader ¶
func (r *RLSResponse) AddHeader(a bool, k, v string)
AddHeader adds a header to the response. When append param is true, Envoy will append the value to an existent request header instead of overriding it.
func (*RLSResponse) GetHTTPHeaderMap ¶
func (r *RLSResponse) GetHTTPHeaderMap() *http.Header
GetHTTPHeaderMap returns HTTP header mapping of the response header-options.
func (*RLSResponse) GetOverallCode ¶
func (r *RLSResponse) GetOverallCode() pb.RateLimitResponse_Code
GetOverallCode returns the rls response HTTP status code.
func (*RLSResponse) GetResponse ¶
func (r *RLSResponse) GetResponse() *pb.RateLimitResponse
GetResponse returns the gRPC rls response object.
func (*RLSResponse) SetBody ¶
func (r *RLSResponse) SetBody(s string)
SetBody sets the rls response message body.
func (*RLSResponse) SetOverallCode ¶
func (r *RLSResponse) SetOverallCode(code pb.RateLimitResponse_Code)
SetOverallCode sets the rls response HTTP status code.
type RLSResponseV3 ¶
type RLSResponseV3 struct {
// contains filtered or unexported fields
}
RLSResponseV3 constructs an rls response object.
func (*RLSResponseV3) AddHeader ¶
func (r *RLSResponseV3) AddHeader(a bool, k, v string)
AddHeader adds a header to the response. When append param is true, Envoy will append the value to an existent request header instead of overriding it.
func (*RLSResponseV3) GetHTTPHeaderMap ¶
func (r *RLSResponseV3) GetHTTPHeaderMap() *http.Header
GetHTTPHeaderMap returns HTTP header mapping of the response header-options.
func (*RLSResponseV3) GetOverallCode ¶
func (r *RLSResponseV3) GetOverallCode() pb.RateLimitResponse_Code
GetOverallCode returns the rls response HTTP status code.
func (*RLSResponseV3) GetResponse ¶
func (r *RLSResponseV3) GetResponse() *pb.RateLimitResponse
GetResponse returns the gRPC rls response object.
func (*RLSResponseV3) SetBody ¶
func (r *RLSResponseV3) SetBody(s string)
SetBody sets the rls response message body.
func (*RLSResponseV3) SetOverallCode ¶
func (r *RLSResponseV3) SetOverallCode(code pb.RateLimitResponse_Code)
SetOverallCode sets the rls response HTTP status code.
type Response ¶
type Response struct {
// contains filtered or unexported fields
}
Response constructs an authorization response object.
func (*Response) AddHeader ¶
AddHeader adds a header to the response. When append param is true, Envoy will append the value to an existent request header instead of overriding it.
func (*Response) GetHTTPHeaderMap ¶
GetHTTPHeaderMap returns HTTP header mapping of the response header-options.
func (*Response) GetResponse ¶
func (r *Response) GetResponse() *pb.CheckResponse
GetResponse returns the gRPC authorization response object.
type ResponseV3 ¶
type ResponseV3 struct {
// contains filtered or unexported fields
}
ResponseV3 constructs an authorization response object.
func (*ResponseV3) AddHeader ¶
func (r *ResponseV3) AddHeader(a bool, k, v string)
AddHeader adds a header to the response. When append param is true, Envoy will append the value to an existent request header instead of overriding it.
func (*ResponseV3) GetHTTPHeaderMap ¶
func (r *ResponseV3) GetHTTPHeaderMap() *http.Header
GetHTTPHeaderMap returns HTTP header mapping of the response header-options.
func (*ResponseV3) GetResponse ¶
func (r *ResponseV3) GetResponse() *pb.CheckResponse
GetResponse returns the gRPC authorization response object.
func (*ResponseV3) GetStatus ¶
func (r *ResponseV3) GetStatus() uint32
GetStatus returns the authorization response HTTP status code.
func (*ResponseV3) SetBody ¶
func (r *ResponseV3) SetBody(s string)
SetBody sets the authorization response message body.