quorum/p2p/protocol.go

82 lines
2.6 KiB
Go
Raw Normal View History

2015-07-06 17:54:22 -07:00
// Copyright 2014 The go-ethereum Authors
// This file is part of the go-ethereum library.
2015-07-06 17:54:22 -07:00
//
// The go-ethereum library is free software: you can redistribute it and/or modify
2015-07-06 17:54:22 -07:00
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
2015-07-06 17:54:22 -07:00
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2015-07-06 17:54:22 -07:00
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
2015-07-06 17:54:22 -07:00
2014-10-23 08:57:54 -07:00
package p2p
import (
"fmt"
"github.com/ethereum/go-ethereum/p2p/discover"
)
2015-02-13 14:54:34 -08:00
// Protocol represents a P2P subprotocol implementation.
type Protocol struct {
// Name should contain the official protocol name,
// often a three-letter word.
Name string
2014-11-04 04:21:44 -08:00
// Version should contain the version number of the protocol.
Version uint
2014-11-04 04:21:44 -08:00
// Length should contain the number of message codes used
// by the protocol.
Length uint64
2014-11-04 04:21:44 -08:00
// Run is called in a new groutine when the protocol has been
// negotiated with a peer. It should read and write messages from
// rw. The Payload for each message must be fully consumed.
//
// The peer connection is closed when Start returns. It should return
// any protocol-level error (such as an I/O error) that is
// encountered.
Run func(peer *Peer, rw MsgReadWriter) error
// NodeInfo is an optional helper method to retrieve protocol specific metadata
// about the host node.
NodeInfo func() interface{}
// PeerInfo is an optional helper method to retrieve protocol specific metadata
// about a certain peer in the network. If an info retrieval function is set,
// but returns nil, it is assumed that the protocol handshake is still running.
PeerInfo func(id discover.NodeID) interface{}
2014-11-04 04:21:44 -08:00
}
func (p Protocol) cap() Cap {
return Cap{p.Name, p.Version}
2014-10-23 08:57:54 -07:00
}
// Cap is the structure of a peer capability.
type Cap struct {
Name string
Version uint
2014-10-23 08:57:54 -07:00
}
func (cap Cap) RlpData() interface{} {
return []interface{}{cap.Name, cap.Version}
2014-10-23 08:57:54 -07:00
}
2015-02-13 14:54:34 -08:00
func (cap Cap) String() string {
return fmt.Sprintf("%s/%d", cap.Name, cap.Version)
}
type capsByNameAndVersion []Cap
func (cs capsByNameAndVersion) Len() int { return len(cs) }
func (cs capsByNameAndVersion) Swap(i, j int) { cs[i], cs[j] = cs[j], cs[i] }
func (cs capsByNameAndVersion) Less(i, j int) bool {
return cs[i].Name < cs[j].Name || (cs[i].Name == cs[j].Name && cs[i].Version < cs[j].Version)
}