pgrpc

README

go-libp2p-grpc

The grpc transport over libp2p

Documentation

Index

• Variables
• func Dial(transport Transport, id peer.ID, dialOpts ...grpc.DialOption) (*grpc.ClientConn, error)
• func PeerID(addr net.Addr) (peer.ID, error)
• func Serve(transport Transport, options ...grpc.ServerOption) *grpc.Server
• type Option
• type Transport
  • func New(ctx context.Context, host host.Host, options ...Option) Transport

Variables

var (
	ErrInternal = errors.New("the internal error", errors.WithVendor(errVendor), errors.WithCode(-1))
	ErrAddr     = errors.New("invalid libp2p net.addr", errors.WithVendor(errVendor), errors.WithCode(-2))
	ErrClosed   = errors.New("transport closed", errors.WithVendor(errVendor), errors.WithCode(-3))
)

errors

Functions

func Dial

func Dial(transport Transport, id peer.ID, dialOpts ...grpc.DialOption) (*grpc.ClientConn, error)

Dial connect to grpc Server with libp2p transport

func PeerID

func PeerID(addr net.Addr) (peer.ID, error)

PeerID cast net.Addr to peer.ID

func Serve

func Serve(transport Transport, options ...grpc.ServerOption) *grpc.Server

Serve create and run grpc.Server with libp2p transport

Types

type Option

type Option func(transport *libp2pTransport)

Option transport create option

type Transport

type Transport grpcservice.Provider

Transport the grpc transport over libp2p

func New

func New(ctx context.Context, host host.Host, options ...Option) Transport

New create transport object for grpc over libp2p