protocol

Documentation

Index

• Constants
• Variables
• func DeleteNodeID(node *noise.Node)
• func DeletePeerID(peer *noise.Peer)
• func DeleteSharedKey(peer *noise.Peer)
• func HasPeerID(peer *noise.Peer) bool
• func HasSharedKey(peer *noise.Peer) bool
• func LoadSharedKey(peer *noise.Peer) []byte
• func MustSharedKey(peer *noise.Peer) []byte
• func Peer(node *noise.Node, id ID) *noise.Peer
• func SetNodeID(node *noise.Node, id ID)
• func SetPeerID(peer *noise.Peer, id ID)
• func SetSharedKey(peer *noise.Peer, sharedKey []byte)
• type Block
• type ID
  • func NodeID(node *noise.Node) ID
  • func PeerID(peer *noise.Peer) ID
• type Protocol
  • func New() *Protocol
  • func (p *Protocol) Enforce(node *noise.Node)
  • func (p *Protocol) Register(blk Block) *Protocol

Constants

const (
	KeySharedKey = "identity.shared_key"
	KeyID        = "node.id"
	KeyPeerID    = "peer.id"
)

const (
	KeyProtocolCurrentBlockIndex = "protocol.current_block_index"
	KeyProtocolEnforceOnce       = "protocol.enforce_once"
)

Variables

var (
	DisconnectPeer = errors.New("peer disconnect requested")
)

Functions

func DeleteNodeID

func DeleteNodeID(node *noise.Node)

func DeletePeerID

func DeletePeerID(peer *noise.Peer)

func DeleteSharedKey

func DeleteSharedKey(peer *noise.Peer)

func HasPeerID

func HasPeerID(peer *noise.Peer) bool

func HasSharedKey

func HasSharedKey(peer *noise.Peer) bool

func LoadSharedKey

func LoadSharedKey(peer *noise.Peer) []byte

func MustSharedKey

func MustSharedKey(peer *noise.Peer) []byte

func Peer

func Peer(node *noise.Node, id ID) *noise.Peer

func SetNodeID

func SetNodeID(node *noise.Node, id ID)

func SetPeerID

func SetPeerID(peer *noise.Peer, id ID)

func SetSharedKey

func SetSharedKey(peer *noise.Peer, sharedKey []byte)

Types

type Block

type Block interface {
	OnRegister(p *Protocol, node *noise.Node)
	OnBegin(p *Protocol, peer *noise.Peer, node *noise.Node) error
	OnEnd(p *Protocol, peer *noise.Peer) error
}

type ID

type ID interface {
	fmt.Stringer
	noise.Message

	Equals(other ID) bool

	PublicKey() []byte
	Hash() []byte
}

func NodeID

func NodeID(node *noise.Node) ID

func PeerID

func PeerID(peer *noise.Peer) ID

type Protocol

type Protocol struct {
	// contains filtered or unexported fields
}

func New

func New() *Protocol

func (*Protocol) Enforce

func (p *Protocol) Enforce(node *noise.Node)

Enforce enforces that all peers of a node follow the given protocol.

func (*Protocol) Register

func (p *Protocol) Register(blk Block) *Protocol

Register registers a block to this protocol sequentially.