mirror of
https://source.quilibrium.com/quilibrium/ceremonyclient.git
synced 2024-11-11 02:35:18 +00:00
56 lines
2.0 KiB
Go
56 lines
2.0 KiB
Go
|
package event
|
||
|
|
|
||
|
|
import (
|
||
|
|
"github.com/libp2p/go-libp2p/core/network"
|
||
|
|
"github.com/libp2p/go-libp2p/core/peer"
|
||
|
|
)
|
||
|
|
|
||
|
|
// EvtPeerConnectednessChanged should be emitted every time the "connectedness" to a
|
||
|
|
// given peer changes. Specifically, this event is emitted in the following
|
||
|
|
// cases:
|
||
|
|
//
|
||
|
|
// - Connectedness = Connected: Every time we transition from having no
|
||
|
|
// connections to a peer to having at least one connection to the peer.
|
||
|
|
// - Connectedness = NotConnected: Every time we transition from having at least
|
||
|
|
// one connection to a peer to having no connections to the peer.
|
||
|
|
//
|
||
|
|
// Additional connectedness states may be added in the future. This list should
|
||
|
|
// not be considered exhaustive.
|
||
|
|
//
|
||
|
|
// Take note:
|
||
|
|
//
|
||
|
|
// - It's possible to have _multiple_ connections to a given peer.
|
||
|
|
// - Both libp2p and networks are asynchronous.
|
||
|
|
//
|
||
|
|
// This means that all the following situations are possible:
|
||
|
|
//
|
||
|
|
// A connection is cut and is re-established:
|
||
|
|
//
|
||
|
|
// - Peer A observes a transition from Connected -> NotConnected -> Connected
|
||
|
|
// - Peer B observes a transition from Connected -> NotConnected -> Connected
|
||
|
|
//
|
||
|
|
// Explanation: Both peers observe the connection die. This is the "nice" case.
|
||
|
|
//
|
||
|
|
// A connection is cut and is re-established.
|
||
|
|
//
|
||
|
|
// - Peer A observes a transition from Connected -> NotConnected -> Connected.
|
||
|
|
// - Peer B observes no transition.
|
||
|
|
//
|
||
|
|
// Explanation: Peer A re-establishes the dead connection. Peer B observes the
|
||
|
|
// new connection form before it observes the old connection die.
|
||
|
|
//
|
||
|
|
// A connection is cut:
|
||
|
|
//
|
||
|
|
// - Peer A observes no transition.
|
||
|
|
// - Peer B observes no transition.
|
||
|
|
//
|
||
|
|
// Explanation: There were two connections and one was cut. This connection
|
||
|
|
// might have been in active use but neither peer will observe a change in
|
||
|
|
// "connectedness". Peers should always make sure to retry network requests.
|
||
|
|
type EvtPeerConnectednessChanged struct {
|
||
|
|
// Peer is the remote peer whose connectedness has changed.
|
||
|
|
Peer peer.ID
|
||
|
|
// Connectedness is the new connectedness state.
|
||
|
|
Connectedness network.Connectedness
|
||
|
|
}
|