client

Documentation

Overview

Package client handles a gRPC connection to a Scribe. Either embedded or remote.

Index

• type EmbeddedScribe
  • func NewEmbeddedScribe(database, path string, metrics metrics.Handler) EmbeddedScribe
  • func (e EmbeddedScribe) Start(ctx context.Context) error
• type RemoteScribe
  • func NewRemoteScribe(httpPort uint16, url string, metrics metrics.Handler) RemoteScribe
  • func (r RemoteScribe) OverrideURL(url string)
• type ScribeClient

Types

type EmbeddedScribe

type EmbeddedScribe struct {
	// ScribeClient is the ScribeClient.
	ScribeClient
	// contains filtered or unexported fields
}

EmbeddedScribe is a ScribeClient that is used locally.

func NewEmbeddedScribe

func NewEmbeddedScribe(database, path string, metrics metrics.Handler) EmbeddedScribe

NewEmbeddedScribe creates a new EmbeddedScribe.

func (EmbeddedScribe) Start

func (e EmbeddedScribe) Start(ctx context.Context) error

Start starts the EmbeddedScribe.

type RemoteScribe

type RemoteScribe struct {
	// ScribeClient is the ScribeClient.
	ScribeClient
}

RemoteScribe is a ScribeClient that is used remotely.

func NewRemoteScribe

func NewRemoteScribe(httpPort uint16, url string, metrics metrics.Handler) RemoteScribe

NewRemoteScribe creates a new RemoteScribe.

func (RemoteScribe) OverrideURL

func (r RemoteScribe) OverrideURL(url string)

OverrideURL overrides the URL for the RemoteScribe.

type ScribeClient

type ScribeClient struct {
	// Port is the port the Scribe is listening on for HTTP requests.
	Port uint16
	// URL is the URL for the connection.
	URL string
	// contains filtered or unexported fields
}

ScribeClient is a gRPC client to a Scribe.