pbssinternalconnect

Documentation

Index

• Constants
• func NewSubstreamsHandler(svc SubstreamsHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type SubstreamsClient
  • func NewSubstreamsClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) SubstreamsClient
• type SubstreamsHandler
• type UnimplementedSubstreamsHandler
  • func (UnimplementedSubstreamsHandler) ProcessRange(context.Context, *connect.Request[v2.ProcessRangeRequest], ...) error

Constants

const (
	// SubstreamsName is the fully-qualified name of the Substreams service.
	SubstreamsName = "sf.substreams.internal.v2.Substreams"
)

const (
	// SubstreamsProcessRangeProcedure is the fully-qualified name of the Substreams's ProcessRange RPC.
	SubstreamsProcessRangeProcedure = "/sf.substreams.internal.v2.Substreams/ProcessRange"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

Functions

func NewSubstreamsHandler

func NewSubstreamsHandler(svc SubstreamsHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewSubstreamsHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type SubstreamsClient

type SubstreamsClient interface {
	ProcessRange(context.Context, *connect.Request[v2.ProcessRangeRequest]) (*connect.ServerStreamForClient[v2.ProcessRangeResponse], error)
}

SubstreamsClient is a client for the sf.substreams.internal.v2.Substreams service.

func NewSubstreamsClient

func NewSubstreamsClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) SubstreamsClient

NewSubstreamsClient constructs a client for the sf.substreams.internal.v2.Substreams service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type SubstreamsHandler

type SubstreamsHandler interface {
	ProcessRange(context.Context, *connect.Request[v2.ProcessRangeRequest], *connect.ServerStream[v2.ProcessRangeResponse]) error
}

SubstreamsHandler is an implementation of the sf.substreams.internal.v2.Substreams service.

type UnimplementedSubstreamsHandler

type UnimplementedSubstreamsHandler struct{}

UnimplementedSubstreamsHandler returns CodeUnimplemented from all methods.

func (UnimplementedSubstreamsHandler) ProcessRange

func (UnimplementedSubstreamsHandler) ProcessRange(context.Context, *connect.Request[v2.ProcessRangeRequest], *connect.ServerStream[v2.ProcessRangeResponse]) error