Documentation
¶
Overview ¶
Package grpc provides gRPC utility functions, complementing the more common ones in the github.com/grpc/grpc-go package
Index ¶
- func NewGRPCClientConn(ctx context.Context, opts *Options, other ...grpc.DialOption) (*grpc.ClientConn, error)
- func NewHealthCheckServer() grpc_health.HealthServer
- func WaitForReady(ctx context.Context, cc *grpc.ClientConn, timeout time.Duration) error
- type CachedOutboundGRPClientConn
- type Options
- type OutboundOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewGRPCClientConn ¶
func NewGRPCClientConn(ctx context.Context, opts *Options, other ...grpc.DialOption) (*grpc.ClientConn, error)
NewGRPCClientConn returns a new gRPC pomerium service client connection.
func NewHealthCheckServer ¶ added in v0.15.0
func NewHealthCheckServer() grpc_health.HealthServer
NewHealthCheckServer returns a basic health checker
func WaitForReady ¶ added in v0.17.3
WaitForReady waits for the connection to be ready.
Types ¶
type CachedOutboundGRPClientConn ¶ added in v0.15.6
type CachedOutboundGRPClientConn struct {
// contains filtered or unexported fields
}
CachedOutboundGRPClientConn keeps a cached outbound gRPC client connection open based on options.
func (*CachedOutboundGRPClientConn) Get ¶ added in v0.15.6
func (cache *CachedOutboundGRPClientConn) Get(ctx context.Context, opts *OutboundOptions) (*grpc.ClientConn, error)
Get gets the cached outbound gRPC client, or creates a new one if the options have changed.
type Options ¶
type Options struct {
// Address is the location of the service. e.g. "service.corp.example:8443"
Address string
// InstallationID specifies the installation id for telemetry exposition.
InstallationID string
// ServiceName specifies the service name for telemetry exposition
ServiceName string
// SignedJWTKey is the JWT key to use for signing a JWT attached to metadata.
SignedJWTKey []byte
}
Options contains options for connecting to a pomerium rpc service.
type OutboundOptions ¶ added in v0.15.6
type OutboundOptions struct {
// OutboundPort is the port for the outbound gRPC listener.
OutboundPort string
// InstallationID specifies the installation id for telemetry exposition.
InstallationID string
// ServiceName specifies the service name for telemetry exposition
ServiceName string
// SignedJWTKey is the JWT key to use for signing a JWT attached to metadata.
SignedJWTKey []byte
}
OutboundOptions are the options for the outbound gRPC client.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package config contains protobuf definitions for config.
|
Package config contains protobuf definitions for config. |
|
Package crypt contains cryptographic protobuf messages.
|
Package crypt contains cryptographic protobuf messages. |
|
Package databroker contains databroker protobuf definitions.
|
Package databroker contains databroker protobuf definitions. |
|
mock_databroker
Package mock_databroker is a generated GoMock package.
|
Package mock_databroker is a generated GoMock package. |
|
Package device contains protobuf types for devices.
|
Package device contains protobuf types for devices. |
|
Package identity contains protobuf types for identity management.
|
Package identity contains protobuf types for identity management. |
|
Package session contains protobuf types for sessions.
|
Package session contains protobuf types for sessions. |
|
Package user contains protobuf types for users.
|
Package user contains protobuf types for users. |
Click to show internal directories.
Click to hide internal directories.