client

package

v1.5.5 Latest Latest Go to latest Published: Apr 17, 2024 License: Apache-2.0 Imports: 19 Imported by: 21

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/streamingfast/substreams

Links

Open Source Insights

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, ...)
type InternalClientFactory
- func NewInternalClientFactory(config *SubstreamsClientConfig) InternalClientFactory
type SubstreamsClientConfig
- func NewSubstreamsClientConfig(endpoint string, authToken string, authType AuthType, insecure bool, ...) *SubstreamsClientConfig

Constants ¶

View Source

const ApiKeyHeader = "x-api-key"

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AuthType ¶ added in v1.3.6

type AuthType int

const (
	None AuthType = iota
	JWT
	ApiKey
)

type Headers ¶ added in v1.3.6

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 ¶ added in v1.0.2

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

func (Headers) Append ¶ added in v1.3.6

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

func (Headers) IsSet ¶ added in v1.3.6

func (h Headers) IsSet() bool

func (Headers) ToArray ¶ added in v1.3.6

func (h Headers) ToArray() []string

type InternalClientFactory ¶ added in v1.0.2

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

func NewInternalClientFactory ¶ added in v1.0.2

func NewInternalClientFactory(config *SubstreamsClientConfig) InternalClientFactory

type SubstreamsClientConfig ¶ added in v0.0.21

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

func NewSubstreamsClientConfig ¶ added in v0.0.21

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

func (*SubstreamsClientConfig) AuthToken ¶ added in v1.3.6

func (c *SubstreamsClientConfig) AuthToken() string

func (*SubstreamsClientConfig) AuthType ¶ added in v1.3.6

func (c *SubstreamsClientConfig) AuthType() AuthType

func (*SubstreamsClientConfig) Endpoint ¶ added in v0.1.0

func (c *SubstreamsClientConfig) Endpoint() string

func (*SubstreamsClientConfig) Insecure ¶ added in v0.1.0

func (c *SubstreamsClientConfig) Insecure() bool

func (*SubstreamsClientConfig) MarshalLogObject ¶ added in v1.1.3

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

func (*SubstreamsClientConfig) PlainText ¶ added in v0.1.0

func (c *SubstreamsClientConfig) PlainText() bool

Source Files ¶

View all Source files

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