grpcconfig

Documentation

Overview

Code generated from Pkl module `GrpcConfig`. DO NOT EDIT.

Code generated from Pkl module `GrpcConfig`. DO NOT EDIT.

Code generated from Pkl module `GrpcConfig`. DO NOT EDIT.

Code generated from Pkl module `GrpcConfig`. DO NOT EDIT.

Code generated from Pkl module `GrpcConfig`. DO NOT EDIT.

Index

• type GrpcConfig
  • func Load(ctx context.Context, evaluator pkl.Evaluator, source *pkl.ModuleSource) (*GrpcConfig, error)
  • func LoadFromPath(ctx context.Context, path string) (ret *GrpcConfig, err error)
• type KeepAlive
• type KeepAliveEnforcementPolicy
• type KeepAliveServerParameter

Types

type GrpcConfig

type GrpcConfig struct {
	// Service GRPC Name
	ServiceName string `pkl:"serviceName"`

	// Service GRPC Domain
	Domain string `pkl:"domain"`

	// Service GRPC Host
	Host string `pkl:"host"`

	// Service GRPC Port
	Port int `pkl:"port"`

	// Service GRPC Keep Alive Configuration
	KeepAlive *KeepAlive `pkl:"keepAlive"`
}

func Load

func Load(ctx context.Context, evaluator pkl.Evaluator, source *pkl.ModuleSource) (*GrpcConfig, error)

Load loads the pkl module at the given source and evaluates it with the given evaluator into a GrpcConfig

func LoadFromPath

func LoadFromPath(ctx context.Context, path string) (ret *GrpcConfig, err error)

LoadFromPath loads the pkl module at the given path and evaluates it into a GrpcConfig

type KeepAlive

type KeepAlive struct {
	Enabled bool `pkl:"enabled"`

	Policy *KeepAliveEnforcementPolicy `pkl:"policy"`

	Parameter *KeepAliveServerParameter `pkl:"parameter"`
}

Service GRPC Keep Alive configuration

type KeepAliveEnforcementPolicy

type KeepAliveEnforcementPolicy struct {
	// If a client pings more than once every X seconds, terminate the connection
	MinTime int `pkl:"minTime"`

	// Allow pings even when there are no active streams
	PermitWithoutStream bool `pkl:"permitWithoutStream"`
}

Service GRPC Keep Alive Enforcement Policy

type KeepAliveServerParameter

type KeepAliveServerParameter struct {
	// If a client is idle for X seconds, send a GOAWAY
	MaxConnectionIdle int `pkl:"maxConnectionIdle"`

	// If any connection is alive for more than X seconds, send a GOAWAY
	MaxConnectionAge int `pkl:"maxConnectionAge"`

	// Allow X seconds for pending RPCs to complete before forcibly closing connections
	MaxConnectionAgeGrace int `pkl:"maxConnectionAgeGrace"`

	// Ping the client if it is idle for X seconds to ensure the connection is still active
	Time int `pkl:"time"`

	// Wait X second for the ping ack before assuming the connection is dead
	Timeout int `pkl:"timeout"`
}

Service GRPC Keep Alive Server Parameters