services

package
v1.13.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 11, 2021 License: Apache-2.0 Imports: 35 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultOpts 

func DefaultOpts() []grpc.ServerOption

DefaultOpts sets gRPC service options.

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.

func (*GRPC) Start 

func (g *GRPC) Start() <-chan bool

Start initializes the gRPC server.

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.

func (*GRPCAUTH) Start 

func (g *GRPCAUTH) Start() <-chan bool

Start initializes the HTTP server.

type GRPCAUTHV3 added in v1.13.0 

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 added in v1.13.0 

func (g *GRPCAUTHV3) Check(ctx context.Context, r *pb.CheckRequest) (*pb.CheckResponse, error)

Check checks the request object.

func (*GRPCAUTHV3) Start added in v1.13.0 

func (g *GRPCAUTHV3) Start() <-chan bool

Start initializes the HTTP server.

type GRPCAgent added in v1.13.0 

type GRPCAgent struct {
	Port int16
}

func (*GRPCAgent) Start added in v1.13.0 

func (a *GRPCAgent) Start() <-chan bool

type GRPCRLS added in v1.8.0 

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 added in v1.8.0 

func (g *GRPCRLS) ShouldRateLimit(ctx context.Context, r *pb.RateLimitRequest) (*pb.RateLimitResponse, error)

Check checks the request object.

func (*GRPCRLS) Start added in v1.8.0 

func (g *GRPCRLS) Start() <-chan bool

Start initializes the HTTP server.

type GRPCRLSV3 added in v1.13.0 

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 added in v1.13.0 

func (g *GRPCRLSV3) ShouldRateLimit(ctx context.Context, r *pb.RateLimitRequest) (*pb.RateLimitResponse, error)

Check checks the request object.

func (*GRPCRLSV3) Start added in v1.13.0 

func (g *GRPCRLSV3) Start() <-chan bool

Start initializes the HTTP server.

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).

func (*HTTP) Start 

func (h *HTTP) Start() <-chan bool

Start initializes the HTTP server.

type RLSResponse added in v1.8.0 

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

RLSResponse constructs an rls response object.

func (*RLSResponse) AddHeader added in v1.8.0 

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 added in v1.8.0 

func (r *RLSResponse) GetHTTPHeaderMap() *http.Header

GetHTTPHeaderMap returns HTTP header mapping of the response header-options.

func (*RLSResponse) GetOverallCode added in v1.8.0 

func (r *RLSResponse) GetOverallCode() pb.RateLimitResponse_Code

GetOverallCode returns the rls response HTTP status code.

func (*RLSResponse) GetResponse added in v1.8.0 

func (r *RLSResponse) GetResponse() *pb.RateLimitResponse

GetResponse returns the gRPC rls response object.

func (*RLSResponse) SetBody added in v1.8.0 

func (r *RLSResponse) SetBody(s string)

SetBody sets the rls response message body.

func (*RLSResponse) SetOverallCode added in v1.8.0 

func (r *RLSResponse) SetOverallCode(code pb.RateLimitResponse_Code)

SetOverallCode sets the rls response HTTP status code.

type RLSResponseV3 added in v1.13.0 

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

RLSResponseV3 constructs an rls response object.

func (*RLSResponseV3) AddHeader added in v1.13.0 

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 added in v1.13.0 

func (r *RLSResponseV3) GetHTTPHeaderMap() *http.Header

GetHTTPHeaderMap returns HTTP header mapping of the response header-options.

func (*RLSResponseV3) GetOverallCode added in v1.13.0 

func (r *RLSResponseV3) GetOverallCode() pb.RateLimitResponse_Code

GetOverallCode returns the rls response HTTP status code.

func (*RLSResponseV3) GetResponse added in v1.13.0 

func (r *RLSResponseV3) GetResponse() *pb.RateLimitResponse

GetResponse returns the gRPC rls response object.

func (*RLSResponseV3) SetBody added in v1.13.0 

func (r *RLSResponseV3) SetBody(s string)

SetBody sets the rls response message body.

func (*RLSResponseV3) SetOverallCode added in v1.13.0 

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 

func (r *Response) 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 (*Response) GetHTTPHeaderMap 

func (r *Response) GetHTTPHeaderMap() *http.Header

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.

func (*Response) GetStatus 

func (r *Response) GetStatus() uint32

GetStatus returns the authorization response HTTP status code.

func (*Response) SetBody 

func (r *Response) SetBody(s string)

SetBody sets the authorization response message body.

func (*Response) SetStatus 

func (r *Response) SetStatus(s string)

SetStatus sets the authorization response HTTP status code.

type ResponseV3 added in v1.13.0 

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

ResponseV3 constructs an authorization response object.

func (*ResponseV3) AddHeader added in v1.13.0 

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 added in v1.13.0 

func (r *ResponseV3) GetHTTPHeaderMap() *http.Header

GetHTTPHeaderMap returns HTTP header mapping of the response header-options.

func (*ResponseV3) GetResponse added in v1.13.0 

func (r *ResponseV3) GetResponse() *pb.CheckResponse

GetResponse returns the gRPC authorization response object.

func (*ResponseV3) GetStatus added in v1.13.0 

func (r *ResponseV3) GetStatus() uint32

GetStatus returns the authorization response HTTP status code.

func (*ResponseV3) SetBody added in v1.13.0 

func (r *ResponseV3) SetBody(s string)

SetBody sets the authorization response message body.

func (*ResponseV3) SetStatus added in v1.13.0 

func (r *ResponseV3) SetStatus(s string)

SetStatus sets the authorization response HTTP status code.

type Service 

type Service interface {
	Start() <-chan bool
}

Service defines a KAT backend service interface.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.