TrueCloudLab/neoneo-go
7
0
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity

network: fix outdated Peer interface comments

Browse source
This commit is contained in:
Roman Khimov 2022-10-12 10:16:07 +03:00
parent 8b26d9475b
commit e1d5f18ff4
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
pkg/network/peer.go
View file

@ -20,8 +20,8 @@ type Peer interface {
PeerAddr() net.Addr PeerAddr() net.Addr
Disconnect(error) Disconnect(error)
// EnqueueMessage is a temporary wrapper that sends a message via // EnqueueMessage is a blocking packet enqueuer similar to EnqueueP2PMessage,
// EnqueuePacket if there is no error in serializing it. // but using the lowest priority queue.
EnqueueMessage(*Message) error EnqueueMessage(*Message) error
// BroadcastPacket is a context-bound packet enqueuer, it either puts the // BroadcastPacket is a context-bound packet enqueuer, it either puts the
@ -43,7 +43,7 @@ type Peer interface {
// EnqueueP2PPacket is a blocking packet enqueuer, it doesn't return until // EnqueueP2PPacket is a blocking packet enqueuer, it doesn't return until
// it puts the given packet into the queue. It accepts a slice of bytes that // it puts the given packet into the queue. It accepts a slice of bytes that
// can be shared with other queues (so that message marshalling can be // can be shared with other queues (so that message marshalling can be
// done once for all peers). It does nothing if the peer has not yet // done once for all peers). It returns an error if the peer has not yet
// completed handshaking. This queue is intended to be used for unicast // completed handshaking. This queue is intended to be used for unicast
// peer to peer communication that is more important than broadcasts // peer to peer communication that is more important than broadcasts
// (handled by BroadcastPacket) but less important than high-priority // (handled by BroadcastPacket) but less important than high-priority