client

Documentation

Index

• type Connector
  • func (c *Connector) Connect(opts ...grpc.DialOption) (*grpc.ClientConn, error)
  • func (c *Connector) ContextWithDeadline() (context.Context, context.CancelFunc)
• type TokenAuth
  • func (t TokenAuth) GetRequestMetadata(ctx context.Context, in ...string) (map[string]string, error)
  • func (TokenAuth) RequireTransportSecurity() bool

Types

type Connector

type Connector struct {
	Host       string
	Port       int
	SSLName    string
	SSLCrtFile string
	// Deadline in seconds
	Deadline int
	// Token string in headers
	Token string
	// TokenKey default = "authorization"
	TokenKey string
}

Connector with gRPC dial option

func (*Connector) Connect

func (c *Connector) Connect(opts ...grpc.DialOption) (*grpc.ClientConn, error)

Connect for gRPC client those dial option has include in connect - WithTransportCredentials if SSLName and SSLCrtFile is valid value - WithInsecure if SSLName and SSLCrtFile is empty value - WithPerRPCCredentials (Token and custom token key only)

func (*Connector) ContextWithDeadline

func (c *Connector) ContextWithDeadline() (context.Context, context.CancelFunc)

ContextWithDeadline TL;DR

type TokenAuth

type TokenAuth struct {
	Token    string
	TokenKey string
}

func (TokenAuth) GetRequestMetadata

func (t TokenAuth) GetRequestMetadata(ctx context.Context, in ...string) (map[string]string, error)

Return value is mapped to request headers.

func (TokenAuth) RequireTransportSecurity

func (TokenAuth) RequireTransportSecurity() bool