network

Documentation

Index

• Variables
• type ConnManager
• type GraphSyncNetwork
  • func NewFromLibp2pHost(host host.Host) GraphSyncNetwork
• type MessageSender
• type MessageSenderOpts
• type Receiver

Variables

var (
	// ProtocolGraphsync is the protocol identifier for graphsync messages
	ProtocolGraphsync protocol.ID = "/ipfs/graphsync/1.0.0"
)

Types

type ConnManager

type ConnManager interface {
	Protect(peer.ID, string)
	Unprotect(peer.ID, string) bool
}

ConnManager provides the methods needed to protect and unprotect connections

type GraphSyncNetwork

type GraphSyncNetwork interface {

	// SendMessage sends a GraphSync message to a peer.
	SendMessage(
		context.Context,
		peer.ID,
		gsmsg.GraphSyncMessage) error

	// SetDelegate registers the Receiver to handle messages received from the
	// network.
	SetDelegate(Receiver)

	// ConnectTo establishes a connection to the given peer
	ConnectTo(context.Context, peer.ID) error

	NewMessageSender(context.Context, peer.ID, MessageSenderOpts) (MessageSender, error)

	ConnectionManager() ConnManager
}

GraphSyncNetwork provides network connectivity for GraphSync.

func NewFromLibp2pHost

func NewFromLibp2pHost(host host.Host) GraphSyncNetwork

NewFromLibp2pHost returns a GraphSyncNetwork supported by underlying Libp2p host.

type MessageSender

type MessageSender interface {
	SendMsg(context.Context, gsmsg.GraphSyncMessage) error
	Close() error
	Reset() error
}

MessageSender is an interface to send messages to a peer

type MessageSenderOpts

type MessageSenderOpts struct {
	SendTimeout time.Duration
}

MessageSenderOpts sets parameters for a message sender

type Receiver

type Receiver interface {
	ReceiveMessage(
		ctx context.Context,
		sender peer.ID,
		incoming gsmsg.GraphSyncMessage)

	ReceiveError(p peer.ID, err error)

	Connected(p peer.ID)
	Disconnected(p peer.ID)
}

Receiver is an interface for receiving messages from the GraphSyncNetwork.