mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-06-19 21:31:37 +00:00
fbecb8c5a5
The name of a method’s receiver should be a reflection of its identity; often a one or two letter abbreviation of its type suffices (such as “c” or “cl” for “Client”). Don’t use generic names such as “me”, “this” or “self”, identifiers typical of object-oriented languages that place more emphasis on methods as opposed to functions. The name need not be as descriptive as that of a method argument, as its role is obvious and serves no documentary purpose. It can be very short as it will appear on almost every line of every method of the type; familiarity admits brevity. Be consistent, too: if you call the receiver “c” in one method, don’t call it “cl” in another.
123 lines
3.1 KiB
Go
123 lines
3.1 KiB
Go
// Copyright 2014 The go-ethereum Authors
|
|
// This file is part of the go-ethereum library.
|
|
//
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
|
// 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,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// 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/>.
|
|
|
|
package p2p
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
)
|
|
|
|
const (
|
|
errInvalidMsgCode = iota
|
|
errInvalidMsg
|
|
)
|
|
|
|
var errorToString = map[int]string{
|
|
errInvalidMsgCode: "invalid message code",
|
|
errInvalidMsg: "invalid message",
|
|
}
|
|
|
|
type peerError struct {
|
|
code int
|
|
message string
|
|
}
|
|
|
|
func newPeerError(code int, format string, v ...interface{}) *peerError {
|
|
desc, ok := errorToString[code]
|
|
if !ok {
|
|
panic("invalid error code")
|
|
}
|
|
err := &peerError{code, desc}
|
|
if format != "" {
|
|
err.message += ": " + fmt.Sprintf(format, v...)
|
|
}
|
|
return err
|
|
}
|
|
|
|
func (e *peerError) Error() string {
|
|
return e.message
|
|
}
|
|
|
|
var errProtocolReturned = errors.New("protocol returned")
|
|
|
|
var ErrAddPairPeer = errors.New("add a pair peer")
|
|
|
|
type DiscReason uint
|
|
|
|
const (
|
|
DiscRequested DiscReason = iota
|
|
DiscNetworkError
|
|
DiscProtocolError
|
|
DiscUselessPeer
|
|
DiscTooManyPeers
|
|
DiscAlreadyConnected
|
|
DiscIncompatibleVersion
|
|
DiscInvalidIdentity
|
|
DiscQuitting
|
|
DiscUnexpectedIdentity
|
|
DiscSelf
|
|
DiscReadTimeout
|
|
DiscPairPeerStop
|
|
DiscSubprotocolError = 0x10
|
|
)
|
|
|
|
var discReasonToString = [...]string{
|
|
DiscRequested: "disconnect requested",
|
|
DiscNetworkError: "network error",
|
|
DiscProtocolError: "breach of protocol",
|
|
DiscUselessPeer: "useless peer",
|
|
DiscTooManyPeers: "too many peers",
|
|
DiscAlreadyConnected: "already connected",
|
|
DiscIncompatibleVersion: "incompatible p2p protocol version",
|
|
DiscInvalidIdentity: "invalid node identity",
|
|
DiscQuitting: "client quitting",
|
|
DiscUnexpectedIdentity: "unexpected identity",
|
|
DiscSelf: "connected to self",
|
|
DiscReadTimeout: "read timeout",
|
|
DiscPairPeerStop: "pair peer connection stop",
|
|
DiscSubprotocolError: "subprotocol error",
|
|
}
|
|
|
|
func (d DiscReason) String() string {
|
|
if len(discReasonToString) <= int(d) || int(d) < 0 {
|
|
return fmt.Sprintf("unknown disconnect reason %d", d)
|
|
}
|
|
return discReasonToString[int(d)]
|
|
}
|
|
|
|
func (d DiscReason) Error() string {
|
|
return d.String()
|
|
}
|
|
|
|
func discReasonForError(err error) DiscReason {
|
|
if reason, ok := err.(DiscReason); ok {
|
|
return reason
|
|
}
|
|
if err == errProtocolReturned {
|
|
return DiscQuitting
|
|
}
|
|
peerError, ok := err.(*peerError)
|
|
if ok {
|
|
switch peerError.code {
|
|
case errInvalidMsgCode, errInvalidMsg:
|
|
return DiscProtocolError
|
|
default:
|
|
return DiscSubprotocolError
|
|
}
|
|
}
|
|
return DiscSubprotocolError
|
|
}
|