Documentation ¶
Overview ¶
Package rlpx implements the RLPx transport protocol.
Index ¶
- type Conn
- func (c *Conn) Close() error
- func (c *Conn) Handshake(prv *ecdsa.PrivateKey) (*ecdsa.PublicKey, error)
- func (c *Conn) InitWithSecrets(sec Secrets)
- func (c *Conn) Read() (code uint64, data []byte, wireSize int, err error)
- func (c *Conn) SetDeadline(time time.Time) error
- func (c *Conn) SetReadDeadline(time time.Time) error
- func (c *Conn) SetSnappy(snappy bool)
- func (c *Conn) SetWriteDeadline(time time.Time) error
- func (c *Conn) Write(code uint64, data []byte) (uint32, error)
- type Secrets
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Conn ¶
type Conn struct {
// contains filtered or unexported fields
}
Conn is an RLPx network connection. It wraps a low-level network connection. The underlying connection should not be used for other activity when it is wrapped by Conn.
Before sending messages, a handshake must be performed by calling the Handshake method. This type is not generally safe for concurrent use, but reading and writing of messages may happen concurrently after the handshake.
func NewConn ¶
NewConn wraps the given network connection. If dialDest is non-nil, the connection behaves as the initiator during the handshake.
func (*Conn) Handshake ¶
Handshake performs the handshake. This must be called before any data is written or read from the connection.
func (*Conn) InitWithSecrets ¶
InitWithSecrets injects connection secrets as if a handshake had been performed. This cannot be called after the handshake.
func (*Conn) SetDeadline ¶
SetDeadline sets the deadline for all future read and write operations.
func (*Conn) SetReadDeadline ¶
SetReadDeadline sets the deadline for all future read operations.
func (*Conn) SetSnappy ¶
SetSnappy enables or disables snappy compression of messages. This is usually called after the devp2p Hello message exchange when the negotiated version indicates that compression is available on both ends of the connection.
func (*Conn) SetWriteDeadline ¶
SetWriteDeadline sets the deadline for all future write operations.