write docs for Reactor interface

This commit is contained in:
Anton Kaliaev
2018-02-08 13:07:40 +04:00
parent 7640e6a29f
commit 2b2c233977
+13 -1
View File
@@ -8,11 +8,23 @@ import (
type Reactor interface {
cmn.Service // Start, Stop
// SetSwitch allows setting a switch.
SetSwitch(*Switch)
// GetChannels returns the list of channel descriptors.
GetChannels() []*conn.ChannelDescriptor
// AddPeer is called by the switch when a new peer is added.
AddPeer(peer Peer)
// RemovePeer is called by the switch when the peer is stopped (due to error
// or other reason).
RemovePeer(peer Peer, reason interface{})
Receive(chID byte, peer Peer, msgBytes []byte) // CONTRACT: msgBytes are not nil
// Receive is called when msgBytes is received from peer.
//
// CONTRACT: msgBytes are not nil
Receive(chID byte, peer Peer, msgBytes []byte)
}
//--------------------------------------