msgstream

type Err struct {
	Topic     string
	Partition int32
	Err       error
}

type Errors []*Err

type Factory interface {
	// SpawnMessageStream creates a T instance for the given topic/partition
	// with the given offset. It will return an error if there is an instance
	// already consuming from the topic/partition.
	//
	// Offset can be a literal offset, or OffsetNewest or OffsetOldest. If
	// offset is smaller then the oldest offset then the oldest offset is
	// returned. If offset is larger then the newest offset then the newest
	// offset is returned. If offset is either sarama.OffsetNewest or
	// sarama.OffsetOldest constant, then the actual offset value is returned.
	// otherwise offset is returned.
	SpawnMessageStream(namespace *actor.ID, topic string, partition int32, offset int64) (T, int64, error)

	// Stop shuts down the consumer. It must be called after all child partition
	// consumers have already been closed.
	Stop()
}

type T interface {
	// Messages returns the read channel for the messages that are fetched from
	// the topic partition.
	Messages() <-chan *consumer.Message

	// Errors returns a read channel of errors that occurred during consuming,
	// if enabled. By default, errors are logged and not returned over this
	// channel. If you want to implement any custom error handling, set your
	// config's Consumer.Return.Errors setting to true, and read from this
	// channel.
	Errors() <-chan *Err

	// Stop synchronously stops the partition consumer. It must be called
	// before the factory that created the instance can be stopped.
	Stop()
}