grpc

package

v1.10.2 Latest Latest Go to latest Published: Jan 10, 2024 License: MIT Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/marcoEgger/genki

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Flags() *pflag.FlagSet
type BasicHealthChecker
- func NewBasicHealthChecker(opts ...Option) *BasicHealthChecker
- func (s *BasicHealthChecker) Check(_ context.Context, req *grpc_health_v1.HealthCheckRequest) (*grpc_health_v1.HealthCheckResponse, error)
- func (s *BasicHealthChecker) Watch(_ *grpc_health_v1.HealthCheckRequest, server grpc_health_v1.Health_WatchServer) error
type MongodbHealthChecker
- func NewMongoDBHealthChecker(db *mongo.Client, opts ...Option) *MongodbHealthChecker
- func (s *MongodbHealthChecker) Check(ctx context.Context, req *grpc_health_v1.HealthCheckRequest) (*grpc_health_v1.HealthCheckResponse, error)
- func (s *MongodbHealthChecker) Watch(_ *grpc_health_v1.HealthCheckRequest, server grpc_health_v1.Health_WatchServer) error
type MySQLHealthChecker
- func NewMySQLHealthChecker(db *sqlx.DB, opts ...Option) *MySQLHealthChecker
- func (s *MySQLHealthChecker) Check(_ context.Context, req *grpc_health_v1.HealthCheckRequest) (*grpc_health_v1.HealthCheckResponse, error)
- func (s *MySQLHealthChecker) Watch(_ *grpc_health_v1.HealthCheckRequest, server grpc_health_v1.Health_WatchServer) error
type Option
type Options
type Server
- func NewServer(opts ...Option) Server

Constants ¶

View Source

const (
	PortConfigKey        = "grpc-port"
	GracePeriodConfigKey = "grpc-grace-period"
)

View Source

const (
	HealthUnknown    = 0
	HealthServing    = 1
	HealthNotServing = 2
)

View Source

const DefaultGracePeriod = 3 * time.Second

View Source

const DefaultHealthEnabled = true

View Source

const DefaultLoggingInterceptor = true

View Source

const DefaultPort = "50051"

View Source

const DefaultPrometheusInterceptor = true

View Source

const DefaultRequestIdInterceptor = true

Variables ¶

This section is empty.

Functions ¶

func Flags ¶

func Flags() *pflag.FlagSet

Flags is a convenience function to quickly add the gRPC server options as CLI flags Implements the cli.FlagProvider type

Types ¶

type BasicHealthChecker ¶ added in v1.1.0

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

func NewBasicHealthChecker ¶ added in v1.1.0

func NewBasicHealthChecker(opts ...Option) *BasicHealthChecker

func (*BasicHealthChecker) Check ¶ added in v1.1.0

func (s *BasicHealthChecker) Check(_ context.Context, req *grpc_health_v1.HealthCheckRequest) (*grpc_health_v1.HealthCheckResponse, error)

func (*BasicHealthChecker) Watch ¶ added in v1.1.0

func (s *BasicHealthChecker) Watch(_ *grpc_health_v1.HealthCheckRequest, server grpc_health_v1.Health_WatchServer) error

type MongodbHealthChecker ¶ added in v1.0.0

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

func NewMongoDBHealthChecker ¶ added in v1.0.0

func NewMongoDBHealthChecker(db *mongo.Client, opts ...Option) *MongodbHealthChecker

func (*MongodbHealthChecker) Check ¶ added in v1.0.0

func (s *MongodbHealthChecker) Check(ctx context.Context, req *grpc_health_v1.HealthCheckRequest) (*grpc_health_v1.HealthCheckResponse, error)

func (*MongodbHealthChecker) Watch ¶ added in v1.0.0

func (s *MongodbHealthChecker) Watch(_ *grpc_health_v1.HealthCheckRequest, server grpc_health_v1.Health_WatchServer) error

type MySQLHealthChecker ¶ added in v1.0.0

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

func NewMySQLHealthChecker ¶ added in v1.0.0

func NewMySQLHealthChecker(db *sqlx.DB, opts ...Option) *MySQLHealthChecker

func (*MySQLHealthChecker) Check ¶ added in v1.0.0

func (s *MySQLHealthChecker) Check(_ context.Context, req *grpc_health_v1.HealthCheckRequest) (*grpc_health_v1.HealthCheckResponse, error)

func (*MySQLHealthChecker) Watch ¶ added in v1.0.0

func (s *MySQLHealthChecker) Watch(_ *grpc_health_v1.HealthCheckRequest, server grpc_health_v1.Health_WatchServer) error

type Option ¶

type Option func(*Options)

func DisableHealthServer ¶

func DisableHealthServer() Option

func DisableLoggingInterceptor ¶

func DisableLoggingInterceptor() Option

func DisablePrometheusInterceptor ¶

func DisablePrometheusInterceptor() Option

func DisableRequestIdInterceptor ¶

func DisableRequestIdInterceptor() Option

func Name ¶

func Name(name string) Option

func Port ¶

func Port(addr string) Option

func ShutdownGracePeriod ¶

func ShutdownGracePeriod(duration time.Duration) Option

type Options ¶

type Options struct {
	Port                string
	Name                string
	ShutdownGracePeriod time.Duration
	HealthServerEnabled bool
	// contains filtered or unexported fields
}

type Server ¶

type Server interface {
	ListenAndServe(ctx context.Context, wg *sync.WaitGroup, healthServer grpc_health_v1.HealthServer)
	Server() *grpc.Server
}

func NewServer ¶

func NewServer(opts ...Option) Server

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
interceptor

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL