source

Documentation

Index

• Variables
• type BookProto
• type CandleProto
• type DecodeKeyFunc
• type KeyGetter
  • func NewKeyGetter(online, offline, all DecodeKeyFunc, req http.Request) KeyGetter
• type MultiDecoder
• type Proto
• type Reader
• type SingleDecoder
• type SinkDecoder
• type Source
  • func NewSource(origin string, symbol SymbolProto, book BookProto, trade TradeProto, ...) Source
• type SymbolProto
• type TradeProto

Variables

var (
	ErrBadUpgrade = errors.New("matt::chasm::source: bad upgrade")
	ErrBadRead    = errors.New("matt::chasm::source: bad read")
)

Types

type BookProto

type BookProto interface {
	Proto
	SingleDecoder[core.BookEvent]
}

type CandleProto

type CandleProto interface {
	Proto
	SinkDecoder[core.CandleEvent]
}

type DecodeKeyFunc

type DecodeKeyFunc func(raw []byte) []core.Key

TODO: we should be returning an error

type KeyGetter

type KeyGetter interface {
	Online() []core.Key
	Offline() []core.Key
	All() []core.Key
}

func NewKeyGetter

func NewKeyGetter(online, offline, all DecodeKeyFunc, req http.Request) KeyGetter

type MultiDecoder

type MultiDecoder[T core.Event] interface {
	Decode(frame []byte, destination []T) (int, bool, error)
}

type Proto

type Proto interface {
	Endpoint() string
	Subscribe(key core.Key) []byte
	Unsubscribe(key core.Key) []byte
}

type Reader

type Reader[T core.Event] interface {
	Open() error
	Close() error
	Read() (T, bool)
	Next() error
}

type SingleDecoder

type SingleDecoder[T core.Event] interface {
	Decode(frame []byte) (T, bool, error)
}

type SinkDecoder

type SinkDecoder[T core.Event] interface {
	Sink(key core.Key, frame []byte) (T, bool, error)
	Rebuild(key core.Key) (T, bool, error)
}

type Source

type Source interface {
	Symbol(key core.Key) Reader[core.SymbolEvent]
	Book(key core.Key) Reader[core.BookEvent]
	Candle(key core.Key) Reader[core.CandleEvent]
	Trade(key core.Key) Reader[core.TradeEvent]
	Get() KeyGetter
}

func NewSource

func NewSource(origin string,
	symbol SymbolProto, book BookProto, trade TradeProto, candle CandleProto, getter KeyGetter) Source

type SymbolProto

type SymbolProto interface {
	Proto
	MultiDecoder[core.SymbolEvent]
}

type TradeProto

type TradeProto interface {
	Proto
	MultiDecoder[core.TradeEvent]
}