grpcutil

Documentation

Overview

Package grpcutil contains gRPC lazy codecs, messages and a buf-based listener.

Index

• Constants
• func NewUnsecureSimpleAuthAccess(scheme, token string) credentials.PerRPCCredentials
• type BufListener
  • func NewBufListener(ctx context.Context, sz int) *BufListener
  • func (bl *BufListener) NewClientConn(opts ...grpc.DialOption) (*grpc.ClientConn, error)
• type LazyClient
  • func NewLazyClient(cc *grpc.ClientConn) *LazyClient
  • func (lc *LazyClient) InvokeStream(ctx context.Context, desc *LazyMethodDesc, in *LazyMessage, ...) (*LazyStream, error)
  • func (lc *LazyClient) InvokeUnary(ctx context.Context, desc *LazyMethodDesc, in *LazyMessage, ...) (out *LazyMessage, err error)
• type LazyCodec
  • func NewLazyCodec() *LazyCodec
  • func (lc *LazyCodec) Marshal(value interface{}) ([]byte, error)
  • func (lc *LazyCodec) Name() string
  • func (lc *LazyCodec) String() string
  • func (*LazyCodec) Unmarshal(buf []byte, value interface{}) error
• type LazyMessage
  • func NewLazyMessage() *LazyMessage
  • func (m *LazyMessage) Base64() string
  • func (m *LazyMessage) Bytes() []byte
  • func (m *LazyMessage) FromBase64(b64 string) (lm *LazyMessage, err error)
  • func (m *LazyMessage) FromBytes(buf []byte) *LazyMessage
  • func (m *LazyMessage) ProtoMessage()
  • func (m *LazyMessage) Reset()
  • func (m *LazyMessage) String() string
• type LazyMethodDesc
• type LazyStream
  • func (s *LazyStream) Close() (err error)
  • func (s *LazyStream) ID() uint64
  • func (s *LazyStream) RecvMsg(out proto.Message) (err error)
  • func (s *LazyStream) SendMsg(in proto.Message) (err error)
• type Listener
  • func Listen(maddr ma.Multiaddr) (Listener, error)
• type Server
  • func (s *Server) Close() error
  • func (s *Server) Serve(l Listener) error

Constants

const (
	P_GRPC           = BertyCustomPrefix + 0x0002 //nolint:revive
	P_GRPC_WEB       = BertyCustomPrefix + 0x0004 //nolint:revive
	P_GRPC_WEBSOCKET = BertyCustomPrefix + 0x0008 //nolint:revive
	P_GRPC_GATEWAY   = BertyCustomPrefix + 0x0016 //nolint:revive
)

const BertyCustomPrefix = 0xbe00

BertyCustomPrefix is a multiformat custom prefix

Functions

func NewUnsecureSimpleAuthAccess

func NewUnsecureSimpleAuthAccess(scheme, token string) credentials.PerRPCCredentials

NewUnsecureSimpleAuthAccess constructs the PerRPCCredentials using a given token.

Types

type BufListener

type BufListener struct {
	*bufconn.Listener
	// contains filtered or unexported fields
}

func NewBufListener

func NewBufListener(ctx context.Context, sz int) *BufListener

func (*BufListener) NewClientConn

func (bl *BufListener) NewClientConn(opts ...grpc.DialOption) (*grpc.ClientConn, error)

type LazyClient

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

func NewLazyClient

func NewLazyClient(cc *grpc.ClientConn) *LazyClient

func (*LazyClient) InvokeStream

func (lc *LazyClient) InvokeStream(ctx context.Context, desc *LazyMethodDesc, in *LazyMessage, copts ...grpc.CallOption) (*LazyStream, error)

func (*LazyClient) InvokeUnary

func (lc *LazyClient) InvokeUnary(ctx context.Context, desc *LazyMethodDesc, in *LazyMessage, copts ...grpc.CallOption) (out *LazyMessage, err error)

type LazyCodec

type LazyCodec struct{}

LazyCodec is basically a no-op grpc.Codec use to pass LazyMessage through grpc

func NewLazyCodec

func NewLazyCodec() *LazyCodec

func (*LazyCodec) Marshal

func (lc *LazyCodec) Marshal(value interface{}) ([]byte, error)

func (*LazyCodec) Name

func (lc *LazyCodec) Name() string

func (*LazyCodec) String

func (lc *LazyCodec) String() string

func (*LazyCodec) Unmarshal

func (*LazyCodec) Unmarshal(buf []byte, value interface{}) error

type LazyMessage

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

LazyMessage is basically a no-op `proto.Message` used to pass serialized message through grpc

func NewLazyMessage

func NewLazyMessage() *LazyMessage

func (*LazyMessage) Base64

func (m *LazyMessage) Base64() string

func (*LazyMessage) Bytes

func (m *LazyMessage) Bytes() []byte

func (*LazyMessage) FromBase64

func (m *LazyMessage) FromBase64(b64 string) (lm *LazyMessage, err error)

func (*LazyMessage) FromBytes

func (m *LazyMessage) FromBytes(buf []byte) *LazyMessage

func (*LazyMessage) ProtoMessage

func (m *LazyMessage) ProtoMessage()

func (*LazyMessage) Reset

func (m *LazyMessage) Reset()

func (*LazyMessage) String

func (m *LazyMessage) String() string

type LazyMethodDesc

type LazyMethodDesc struct {
	Name          string
	ClientStreams bool
	ServerStreams bool
}

type LazyStream

type LazyStream struct {
	// used to close the stream
	context.CancelFunc
	grpc.ClientStream
	// contains filtered or unexported fields
}

func (*LazyStream) Close

func (s *LazyStream) Close() (err error)

func (*LazyStream) ID

func (s *LazyStream) ID() uint64

func (*LazyStream) RecvMsg

func (s *LazyStream) RecvMsg(out proto.Message) (err error)

func (*LazyStream) SendMsg

func (s *LazyStream) SendMsg(in proto.Message) (err error)

type Listener

type Listener interface {
	manet.Listener

	GRPCMultiaddr() ma.Multiaddr
}

func Listen

func Listen(maddr ma.Multiaddr) (Listener, error)

type Server

type Server struct {
	GRPCServer *grpc.Server
	GatewayMux *grpcgw.ServeMux
	// contains filtered or unexported fields
}

func (*Server) Close

func (s *Server) Close() error

func (*Server) Serve

func (s *Server) Serve(l Listener) error