vole

Documentation

Index

• func DhtGet(ctx context.Context, key []byte, proto protocol.ID, ma multiaddr.Multiaddr) (*recpb.Record, error)
• func DhtGetClosestPeers(ctx context.Context, key []byte, proto protocol.ID, ma multiaddr.Multiaddr) ([]*peer.AddrInfo, error)
• func DhtGetProvs(ctx context.Context, key []byte, proto protocol.ID, ma multiaddr.Multiaddr) ([]*peer.AddrInfo, error)
• func DhtPing(ctx context.Context, proto protocol.ID, ma multiaddr.Multiaddr) error
• func DhtProtocolMessenger(ctx context.Context, proto protocol.ID, ai *peer.AddrInfo) (*dhtpb.ProtocolMessenger, error)
• func DhtPut(ctx context.Context, key, value []byte, proto protocol.ID, ...) error
• func GetBitswapCID(root cid.Cid, ai *peer.AddrInfo) error
• func Ping(ctx context.Context, forceRelay bool, p *peer.AddrInfo) error
• type BsCheckOutput
  • func CheckBitswapCID(ctx context.Context, h host.Host, c cid.Cid, ma multiaddr.Multiaddr, ...) (*BsCheckOutput, error)
  • func (o *BsCheckOutput) MarshalJSON() ([]byte, error)
• type IdentifyInfo
  • func IdentifyRequest(ctx context.Context, maStr string, allowUnknownPeer bool) (*IdentifyInfo, error)

Functions

func DhtGet

func DhtGet(ctx context.Context, key []byte, proto protocol.ID, ma multiaddr.Multiaddr) (*recpb.Record, error)

func DhtGetClosestPeers

func DhtGetClosestPeers(ctx context.Context, key []byte, proto protocol.ID, ma multiaddr.Multiaddr) ([]*peer.AddrInfo, error)

func DhtGetProvs

func DhtGetProvs(ctx context.Context, key []byte, proto protocol.ID, ma multiaddr.Multiaddr) ([]*peer.AddrInfo, error)

func DhtPing

func DhtPing(ctx context.Context, proto protocol.ID, ma multiaddr.Multiaddr) error

func DhtProtocolMessenger

func DhtProtocolMessenger(ctx context.Context, proto protocol.ID, ai *peer.AddrInfo) (*dhtpb.ProtocolMessenger, error)

func DhtPut

func DhtPut(ctx context.Context, key, value []byte, proto protocol.ID, ma multiaddr.Multiaddr) error

func GetBitswapCID

func GetBitswapCID(root cid.Cid, ai *peer.AddrInfo) error

func Ping

func Ping(ctx context.Context, forceRelay bool, p *peer.AddrInfo) error

Types

type BsCheckOutput

type BsCheckOutput struct {
	Found     bool
	Responded bool
	Error     error
}

func CheckBitswapCID

func CheckBitswapCID(ctx context.Context, h host.Host, c cid.Cid, ma multiaddr.Multiaddr, getBlock bool) (*BsCheckOutput, error)

Passing a libp2p host is optional. Otherwise a temporary host will be created. When passing a host, it should be only connceted to the passed multiaddr

func (*BsCheckOutput) MarshalJSON

func (o *BsCheckOutput) MarshalJSON() ([]byte, error)

type IdentifyInfo

type IdentifyInfo struct {
	PeerId          peer.ID
	ProtocolVersion string
	AgentVersion    string
	Addresses       []multiaddr.Multiaddr
	Protocols       []protocol.ID
}

func IdentifyRequest

func IdentifyRequest(ctx context.Context, maStr string, allowUnknownPeer bool) (*IdentifyInfo, error)