grpc

Documentation

Overview

Package grpc is the grpc transport for plugins/client/orb.

Index

• Constants
• func CodeToHTTPStatus(code codes.Code) int
• func NewTransport(name string, network string) func(logger log.Logger, cfg *orb.Config) (orb.TransportType, error)
• type Transport
  • func (t *Transport) Name() string
  • func (t *Transport) Request(ctx context.Context, infos client.RequestInfos, req any, result any, ...) error
  • func (t *Transport) Start() error
  • func (t *Transport) Stop(_ context.Context) error
  • func (t *Transport) Stream(ctx context.Context, infos client.RequestInfos, opts *client.CallOptions) (client.StreamIface[any, any], error)

Constants

const Name = "grpc"

Name is the transports name.

Functions

func CodeToHTTPStatus

func CodeToHTTPStatus(code codes.Code) int

CodeToHTTPStatus maps gRPC codes to HTTP status codes.

Falls back to http.StatusInternalServerError if the code is unrecognized.

func NewTransport

func NewTransport(name string, network string) func(logger log.Logger, cfg *orb.Config) (orb.TransportType, error)

NewTransport creates a Transport.

Types

type Transport

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

Transport is a go-orb/plugins/client/orb compatible transport.

func (*Transport) Name

func (t *Transport) Name() string

Name returns the name of this transport.

func (*Transport) Request

func (t *Transport) Request(ctx context.Context, infos client.RequestInfos, req any, result any, opts *client.CallOptions) error

Request does the actual rpc request to the server.

func (*Transport) Start

func (t *Transport) Start() error

Start starts the transport.

func (*Transport) Stop

func (t *Transport) Stop(_ context.Context) error

Stop stop the transport.

func (*Transport) Stream

func (t *Transport) Stream(ctx context.Context, infos client.RequestInfos, opts *client.CallOptions) (client.StreamIface[any, any], error)

Stream creates a bidirectional gRPC stream to the service endpoint.