grpc

Documentation

Index

• func NewClientWithAuthForward[T any](ctx context.Context, addr string, requireTransportSecurity bool, ...) (*grpc.ClientConn, T, error)
• func NewClientWithInsecure[T any](ctx context.Context, addr string, ...) (*grpc.ClientConn, T, error)
• func NewClientWithInsecureAuth[T any](ctx context.Context, addr, authToken string, ...) (*grpc.ClientConn, T, error)
• func NewForwardedOauthAccess(requireTransportSecurity bool) credentials.PerRPCCredentials
• func NewOauthAccessWithoutTransportSecurity(token *oauth2.Token) credentials.PerRPCCredentials
• type GrpcConnectionFactory
  • func NewGrpcConnectionFactory(url string) *GrpcConnectionFactory
  • func NewGrpcConnectionFactoryWithInsecure(url string) *GrpcConnectionFactory
  • func (factory *GrpcConnectionFactory) Connect(ctx context.Context) (*grpc.ClientConn, error)
  • func (factory *GrpcConnectionFactory) ConnectWithTimeout(ctx context.Context, timeout time.Duration) (*grpc.ClientConn, error)
  • func (factory *GrpcConnectionFactory) WithBlock() *GrpcConnectionFactory
  • func (factory *GrpcConnectionFactory) WithInsecure() *GrpcConnectionFactory
  • func (factory *GrpcConnectionFactory) WithOSCaTransportCredentials() *GrpcConnectionFactory
  • func (factory *GrpcConnectionFactory) WithOpenTelemetry() *GrpcConnectionFactory
  • func (factory *GrpcConnectionFactory) WithPerRPCCredentials(creds credentials.PerRPCCredentials) *GrpcConnectionFactory
  • func (factory *GrpcConnectionFactory) WithRetry() *GrpcConnectionFactory
  • func (factory *GrpcConnectionFactory) WithTransportCredentials(creds credentials.TransportCredentials) *GrpcConnectionFactory
• type Server
  • func NewServer(name string, keepAlive bool, opt ...grpc.ServerOption) *Server
  • func NewServerWithOpts(name string, keepAlive bool, ...) *Server
  • func (s *Server) RegisterService(f func(grpc.ServiceRegistrar))
  • func (s *Server) Serve(apiAddr, metricsAddr string) error
  • func (s *Server) ServeFromListener(apiLis net.Listener, metricsLis net.Listener) error
  • func (s *Server) Shutdown()

Functions

func NewClientWithAuthForward

func NewClientWithAuthForward[T any](ctx context.Context, addr string, requireTransportSecurity bool, clientFactory func(cc grpc.ClientConnInterface) T) (*grpc.ClientConn, T, error)

NewClientWithAuthForward creates a new gRPC client which forwards the authentication bearer token received from the client (TLS optional)

func NewClientWithInsecure

func NewClientWithInsecure[T any](ctx context.Context, addr string, clientFactory func(cc grpc.ClientConnInterface) T) (*grpc.ClientConn, T, error)

NewClientWithInsecure creates a new gRPC client which connects without TLS

func NewClientWithInsecureAuth

func NewClientWithInsecureAuth[T any](ctx context.Context, addr, authToken string, clientFactory func(cc grpc.ClientConnInterface) T) (*grpc.ClientConn, T, error)

NewClientWithInsecureAuth (USE ONLY IF SECURED BY SERVICE MESH OR SIMILAR) creates a new gRPC client which sends the auth token without TLS

func NewForwardedOauthAccess

func NewForwardedOauthAccess(requireTransportSecurity bool) credentials.PerRPCCredentials

NewForwardedOauthAccess constructs the PerRPCCredentials which forwards the authorization from header

func NewOauthAccessWithoutTransportSecurity

func NewOauthAccessWithoutTransportSecurity(token *oauth2.Token) credentials.PerRPCCredentials

NewOauthAccessWithoutTransportSecurity constructs the PerRPCCredentials using a given token for test purposes where no TLS necessary.

Types

type GrpcConnectionFactory

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

func NewGrpcConnectionFactory

func NewGrpcConnectionFactory(url string) *GrpcConnectionFactory

NewGrpcConnectionFactory creates a new factory for gRPC connections.

func NewGrpcConnectionFactoryWithInsecure

func NewGrpcConnectionFactoryWithInsecure(url string) *GrpcConnectionFactory

NewGrpcConnectionFactoryWithInsecure creates a new factory for gRPC connections and adds the following dial options: WithInsecure, WithBlock.

func (*GrpcConnectionFactory) Connect

func (factory *GrpcConnectionFactory) Connect(ctx context.Context) (*grpc.ClientConn, error)

Connect creates a client connection based on the factory.

func (*GrpcConnectionFactory) ConnectWithTimeout

func (factory *GrpcConnectionFactory) ConnectWithTimeout(ctx context.Context, timeout time.Duration) (*grpc.ClientConn, error)

ConnectWithTimeout creates a client connection based on the factory with a given timeout.

func (*GrpcConnectionFactory) WithBlock

func (factory *GrpcConnectionFactory) WithBlock() *GrpcConnectionFactory

WithBlock adds a DialOption which makes caller of Dial blocks until the underlying connection is up. Without this, Dial returns immediately and connecting the server happens in background.

func (*GrpcConnectionFactory) WithInsecure

func (factory *GrpcConnectionFactory) WithInsecure() *GrpcConnectionFactory

WithInsecure adds a DialOption which disables transport security for this connection. Note that transport security is required unless WithInsecure is set.

func (*GrpcConnectionFactory) WithOSCaTransportCredentials

func (factory *GrpcConnectionFactory) WithOSCaTransportCredentials() *GrpcConnectionFactory

WithOSCaTransportCredentials adds a DialOption which configures a connection level security credentials (e.g., TLS/SSL) using the CAs known to the OS.

func (*GrpcConnectionFactory) WithOpenTelemetry

func (factory *GrpcConnectionFactory) WithOpenTelemetry() *GrpcConnectionFactory

WithOpenTelemetry adds a DialOption which adds OpenTelemetry to the client.

func (*GrpcConnectionFactory) WithPerRPCCredentials

func (factory *GrpcConnectionFactory) WithPerRPCCredentials(creds credentials.PerRPCCredentials) *GrpcConnectionFactory

WithPerRPCCredentials adds a DialOption which sets credentials and places auth state on each outbound RPC.

func (*GrpcConnectionFactory) WithRetry

func (factory *GrpcConnectionFactory) WithRetry() *GrpcConnectionFactory

WithRetry adds retrying with exponential backoff using the default retryable codes from grpc_retry.DefaultRetriableCodes.

func (*GrpcConnectionFactory) WithTransportCredentials

func (factory *GrpcConnectionFactory) WithTransportCredentials(creds credentials.TransportCredentials) *GrpcConnectionFactory

Connect creates a client connection based on the factory.

type Server

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

Server is the implementation of an API Server

func NewServer

func NewServer(name string, keepAlive bool, opt ...grpc.ServerOption) *Server

NewServer returns a new configured instance of Server

func NewServerWithOpts

func NewServerWithOpts(name string, keepAlive bool, unaryServerInterceptors []grpc.UnaryServerInterceptor, streamServerInterceptors []grpc.StreamServerInterceptor, opt ...grpc.ServerOption) *Server

NewServerWithOpts returns a new configured instance of Server with additional interceptors specified

func (*Server) RegisterService

func (s *Server) RegisterService(f func(grpc.ServiceRegistrar))

RegisterService registers your gRPC service implementation with the server

func (*Server) Serve

func (s *Server) Serve(apiAddr, metricsAddr string) error

Serve starts the api listeners of the Server

func (*Server) ServeFromListener

func (s *Server) ServeFromListener(apiLis net.Listener, metricsLis net.Listener) error

ServeFromListener starts the api listeners of the Server

func (*Server) Shutdown

func (s *Server) Shutdown()

Tell the server to shutdown