raft

type LocalNode interface {
	RemoteNode

	AppendLogMessage([]byte, time.Duration) error
	RemoteProcedureCall(RemoteNode, uint8, interface{}, interface{}) error
	GetRemoteNodes() ([]RemoteNode, error)
	GetAuthToken() string
}

type LocalNodeSetter interface {
	SetLocalNode(LocalNode)
}

type MessageProtocol interface {
	SharedStateGetter
	LocalNodeSetter
	MessageTypeTranslatorGetter
	MessageReceiveEventHandler
}

type MessagePtrFactory func() interface{}

type MessageReceiveEventHandler interface {

	// OnMessageReceive is called when a message was recieved and has been
	// properly decoded; return either an error or an struct ptr; both will
	// be sent back to the requesting client
	OnMessageReceive(uint8, interface{}) (interface{}, error)
}

type MessageTypeTranslator map[uint8]MessagePtrFactory

type MessageTypeTranslatorGetter interface {

	// GetTypeTranslator returns the protocol's
	// type translator
	GetTypeTranslator() MessageTypeTranslator
}

type RemoteNode interface {
	GetID() string
	GetAddress() string
}

type SharedState interface {

	// AppendLogMessage decodes the log message
	// and applies the represented change to the
	// local state
	AppendLogMessage([]byte)

	// Encode encodes the current state into
	// the writer
	Encode(io.Writer) error

	// Decode decodes a state from the reader
	// into the local state
	Decode(io.Reader) error
}

type SharedStateGetter interface {

	// GetSharedState returns the SharedState
	GetSharedState() SharedState
}