stream

package

v0.1.7 Latest Latest Go to latest Published: Apr 22, 2024 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const CName = "consensus.stream"

This section is empty.

This section is empty.

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() Service

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

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

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

AddRecords adds new records to stream, called by objects

func (s *Stream) Close()

Close closes stream and unsubscribes all ids

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

LogIds returns watched log ids

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

UnwatchIds removes given ids from subscription

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

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

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

WatchIds adds given ids to subscription