certusone
/
tendermint
mirror of https://github.com/certusone/tendermint.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

document that msgBytes in p2p/connection change

This commit is contained in:
Anton Kaliaev 2018-02-08 13:09:46 +04:00
parent d6d1f8512d
commit 3f9aa8d8fa
No known key found for this signature in database
GPG Key ID: 7B6881D965918214
2 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
p2p/base_reactor.go
View File

@ -23,7 +23,10 @@ type Reactor interface {
// Receive is called when msgBytes is received from peer.
//
// CONTRACT: msgBytes are not nil
// NOTE reactor can not keep msgBytes around after Receive completes without
// copying.
//
// CONTRACT: msgBytes are not nil.
Receive(chID byte, peer Peer, msgBytes []byte)
}

8
p2p/conn/connection.go
View File

@ -679,7 +679,8 @@ func writeMsgPacketTo(packet msgPacket, w io.Writer, n *int, err *error) {
wire.WriteBinary(packet, w, n, err)
}
// Handles incoming msgPackets. Returns a msg bytes if msg is complete.
// Handles incoming msgPackets. It returns a message bytes if message is
// complete. NOTE message bytes may change on next call to recvMsgPacket.
// Not goroutine-safe
func (ch *Channel) recvMsgPacket(packet msgPacket) ([]byte, error) {
ch.Logger.Debug("Read Msg Packet", "conn", ch.conn, "packet", packet)
@ -688,11 +689,6 @@ func (ch *Channel) recvMsgPacket(packet msgPacket) ([]byte, error) {
}
ch.recving = append(ch.recving, packet.Bytes...)
if packet.EOF == byte(0x01) {
// TODO: document that these returned msgBytes will change under you after Receive finishes.
// TODO: document it in the Reactor interface especially - implementations of a Reactor
// can not keep these bytes around after the Receive completes without copying!
// In general that's fine, because the first thing we do is unmarshal into a msg type and then
// we never use the bytes again
msgBytes := ch.recving
// clear the slice without re-allocating.