grpcsvc

package

v0.0.0-...-b7c645d Latest Latest Go to latest Published: May 23, 2022 License: MIT Imports: 27 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/plexsysio/go-msuite

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Client(c config.Config) fx.Option
func JaegerTracerOptions(tracer opentracing.Tracer) grpc.UnaryServerInterceptor
func Metrics() *grpc_prometheus.ServerMetrics
func MetricsRegister(reg *prometheus.Registry, s *grpc.Server, ...)
func Middleware(c config.Config) fx.Option
func New(lc fx.Lifecycle, params GrpcServerParams) (*grpc.Server, error)
func NewMuxedListener(ctx context.Context, lc fx.Lifecycle, in MuxIn, tm *taskmanager.TaskManager) (*grpcmux.Mux, error)
func OptsAggregator(params ServerOptsParams) (outOpts []grpc.ServerOption)
func Recovery() (grpc.UnaryServerInterceptor, grpc.StreamServerInterceptor)
func Transport(c config.Config) fx.Option
func Validator() (grpc.UnaryServerInterceptor, grpc.StreamServerInterceptor)
type AuthInterceptor
- func NewAuthInterceptor(jm auth.JWTManager, am auth.ACL) *AuthInterceptor
- func (interceptor *AuthInterceptor) Stream() grpc.StreamServerInterceptor
- func (interceptor *AuthInterceptor) Unary() grpc.UnaryServerInterceptor
type GrpcServerParams
type JwtAuthOpts
- func JwtAuthOptions(jm auth.JWTManager, am auth.ACL) (params JwtAuthOpts, err error)
type MuxIn
type MuxListenerOut
- func NewP2PListener(h host.Host) (MuxListenerOut, error)
- func NewTCPListener(conf config.Config) (MuxListenerOut, error)
- func NewUDSListener(conf config.Config) (MuxListenerOut, error)
type PrometheusOpts
- func MetricsOpts(c config.Config, grpcMetrics *grpc_prometheus.ServerMetrics) (params PrometheusOpts, err error)
type ServerOptsParams

Constants ¶

This section is empty.

Variables ¶

View Source

var JwtAuth = fx.Options(
	fx.Provide(JwtAuthOptions),
)

View Source

var Module = func(c config.Config) fx.Option {
	return fx.Options(
		Transport(c),
		Middleware(c),
		Client(c),
		fx.Provide(OptsAggregator),
		fx.Provide(New),
	)
}

View Source

var Prometheus = fx.Options(
	fx.Provide(Metrics),
	fx.Provide(MetricsOpts),
	fx.Invoke(MetricsRegister),
)

Functions ¶

func Client ¶

func Client(c config.Config) fx.Option

func JaegerTracerOptions ¶

func JaegerTracerOptions(tracer opentracing.Tracer) grpc.UnaryServerInterceptor

func Metrics ¶

func Metrics() *grpc_prometheus.ServerMetrics

func MetricsRegister ¶

func MetricsRegister(reg *prometheus.Registry, s *grpc.Server, metrics *grpc_prometheus.ServerMetrics)

func Middleware ¶

func Middleware(c config.Config) fx.Option

func New ¶

func New(
	lc fx.Lifecycle,
	params GrpcServerParams,
) (*grpc.Server, error)

func NewMuxedListener ¶

func NewMuxedListener(
	ctx context.Context,
	lc fx.Lifecycle,
	in MuxIn,
	tm *taskmanager.TaskManager,
) (*grpcmux.Mux, error)

func OptsAggregator ¶

func OptsAggregator(params ServerOptsParams) (outOpts []grpc.ServerOption)

func Recovery ¶

func Recovery() (grpc.UnaryServerInterceptor, grpc.StreamServerInterceptor)

func Transport ¶

func Transport(c config.Config) fx.Option

func Validator ¶

func Validator() (grpc.UnaryServerInterceptor, grpc.StreamServerInterceptor)

Types ¶

type AuthInterceptor ¶

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

AuthInterceptor is a server interceptor for authentication and authorization

func NewAuthInterceptor ¶

func NewAuthInterceptor(jm auth.JWTManager, am auth.ACL) *AuthInterceptor

NewAuthInterceptor returns a new auth interceptor

func (*AuthInterceptor) Stream ¶

func (interceptor *AuthInterceptor) Stream() grpc.StreamServerInterceptor

Stream returns a server interceptor function to authenticate and authorize stream RPC

func (*AuthInterceptor) Unary ¶

func (interceptor *AuthInterceptor) Unary() grpc.UnaryServerInterceptor

Unary returns a server interceptor function to authenticate and authorize unary RPC

type GrpcServerParams ¶

type GrpcServerParams struct {
	fx.In

	Opts      []grpc.ServerOption
	Listnr    *grpcmux.Mux
	StManager status.Manager
}

type JwtAuthOpts ¶

type JwtAuthOpts struct {
	fx.Out

	UOut grpc.UnaryServerInterceptor  `group:"unary_opts"`
	SOut grpc.StreamServerInterceptor `group:"stream_opts"`
}

func JwtAuthOptions ¶

func JwtAuthOptions(
	jm auth.JWTManager,
	am auth.ACL,
) (params JwtAuthOpts, err error)

type MuxIn ¶

type MuxIn struct {
	fx.In

	Listeners []grpcmux.MuxListener `group:"listener"`
	StManager status.Manager        `optional:"true"`
}

type MuxListenerOut ¶

type MuxListenerOut struct {
	fx.Out

	Listener grpcmux.MuxListener `group:"listener"`
}

func NewP2PListener ¶

func NewP2PListener(
	h host.Host,
) (MuxListenerOut, error)

func NewTCPListener ¶

func NewTCPListener(conf config.Config) (MuxListenerOut, error)

func NewUDSListener ¶

func NewUDSListener(conf config.Config) (MuxListenerOut, error)

type PrometheusOpts ¶

type PrometheusOpts struct {
	fx.Out

	UOut grpc.UnaryServerInterceptor  `group:"unary_opts"`
	SOut grpc.StreamServerInterceptor `group:"stream_opts"`
}

func MetricsOpts ¶

func MetricsOpts(c config.Config, grpcMetrics *grpc_prometheus.ServerMetrics) (params PrometheusOpts, err error)

type ServerOptsParams ¶

type ServerOptsParams struct {
	fx.In

	UnaryOpts  []grpc.UnaryServerInterceptor  `group:"unary_opts"`
	StreamOpts []grpc.StreamServerInterceptor `group:"stream_opts"`
}

Source Files ¶

View all Source files

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