client

Documentation

Index

• Constants
• type AuthType
• type Headers
  • func NewSubstreamsClient(config *SubstreamsClientConfig) (cli pbsubstreamsrpc.StreamClient, closeFunc func() error, ...)
  • func NewSubstreamsInternalClient(config *SubstreamsClientConfig) (cli pbssinternal.SubstreamsClient, closeFunc func() error, ...)
  • func (h Headers) Append(headers map[string]string) map[string]string
  • func (h Headers) IsSet() bool
  • func (h Headers) ToArray() []string
• type InternalClientFactory
  • func NewInternalClientFactory(config *SubstreamsClientConfig) InternalClientFactory
• type SubstreamsClientConfig
  • func NewSubstreamsClientConfig(endpoint string, authToken string, authType AuthType, insecure bool, ...) *SubstreamsClientConfig
  • func (c *SubstreamsClientConfig) AuthToken() string
  • func (c *SubstreamsClientConfig) AuthType() AuthType
  • func (c *SubstreamsClientConfig) Endpoint() string
  • func (c *SubstreamsClientConfig) Insecure() bool
  • func (c *SubstreamsClientConfig) MarshalLogObject(encoder zapcore.ObjectEncoder) error
  • func (c *SubstreamsClientConfig) PlainText() bool

Constants

const ApiKeyHeader = "x-api-key"

Types

type AuthType

type AuthType int

const (
	None AuthType = iota
	JWT
	ApiKey
)

type Headers

type Headers map[string]string

func NewSubstreamsClient

func NewSubstreamsClient(config *SubstreamsClientConfig) (cli pbsubstreamsrpc.StreamClient, closeFunc func() error, callOpts []grpc.CallOption, headers Headers, err error)

func NewSubstreamsInternalClient

func NewSubstreamsInternalClient(config *SubstreamsClientConfig) (cli pbssinternal.SubstreamsClient, closeFunc func() error, callOpts []grpc.CallOption, headers Headers, err error)

func (Headers) Append

func (h Headers) Append(headers map[string]string) map[string]string

func (Headers) IsSet

func (h Headers) IsSet() bool

func (Headers) ToArray

func (h Headers) ToArray() []string

type InternalClientFactory

type InternalClientFactory = func() (cli pbssinternal.SubstreamsClient, closeFunc func() error, callOpts []grpc.CallOption, headers Headers, err error)

func NewInternalClientFactory

func NewInternalClientFactory(config *SubstreamsClientConfig) InternalClientFactory

type SubstreamsClientConfig

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

func NewSubstreamsClientConfig

func NewSubstreamsClientConfig(endpoint string, authToken string, authType AuthType, insecure bool, plaintext bool) *SubstreamsClientConfig

func (*SubstreamsClientConfig) AuthToken

func (c *SubstreamsClientConfig) AuthToken() string

func (*SubstreamsClientConfig) AuthType

func (c *SubstreamsClientConfig) AuthType() AuthType

func (*SubstreamsClientConfig) Endpoint

func (c *SubstreamsClientConfig) Endpoint() string

func (*SubstreamsClientConfig) Insecure

func (c *SubstreamsClientConfig) Insecure() bool

func (*SubstreamsClientConfig) MarshalLogObject

func (c *SubstreamsClientConfig) MarshalLogObject(encoder zapcore.ObjectEncoder) error

func (*SubstreamsClientConfig) PlainText

func (c *SubstreamsClientConfig) PlainText() bool