stream

Documentation

Index

• Constants
• type Service
  • func New() Service
• type Stream
  • func (s *Stream) AddRecords(logId string, records []consensus.Record) (err error)
  • func (s *Stream) Close()
  • func (s *Stream) LogIds() []string
  • func (s *Stream) UnwatchIds(ctx context.Context, logIds []string)
  • func (s *Stream) WaitLogs() []consensus.Log
  • func (s *Stream) WatchIds(ctx context.Context, logIds []string)

Constants

const CName = "consensus.stream"

Types

type Service

type Service interface {
	// NewStream creates new stream with able to watch and unwatch log ids
	NewStream() *Stream
	app.ComponentRunnable
}

Service maintains a cache for logs (receive updates from db) and creates new stream objects with able to subscribe/unsubscribe to log ids

func New

func New() Service

type Stream

type Stream struct {
	// contains filtered or unexported fields
}

Stream is a buffer that receives updates from object and gives back to a client

func (*Stream) AddRecords

func (s *Stream) AddRecords(logId string, records []consensus.Record) (err error)

AddRecords adds new records to stream, called by objects

func (*Stream) Close

func (s *Stream) Close()

Close closes stream and unsubscribes all ids

func (*Stream) LogIds

func (s *Stream) LogIds() []string

LogIds returns watched log ids

func (*Stream) UnwatchIds

func (s *Stream) UnwatchIds(ctx context.Context, logIds []string)

UnwatchIds removes given ids from subscription

func (*Stream) WaitLogs

func (s *Stream) WaitLogs() []consensus.Log

WaitLogs wait for new log records empty returned slice means that stream is closed

func (*Stream) WatchIds

func (s *Stream) WatchIds(ctx context.Context, logIds []string)

WatchIds adds given ids to subscription