source

Documentation

Index

• Variables
• type BatchDecodeFunc
• type BatchDecoder
• type BookCodec
  • func NewBookCodec(endpoint endpoint, sub, unsub ProtoMsgFunc, ...) BookCodec
  • func NewCoinbaseBookCodec() BookCodec
  • func NewKrakenBookCodec() BookCodec
• type CandleCodec
  • func NewCandleCodec(endpoint endpoint, sub, unsub ProtoMsgFunc, ...) CandleCodec
  • func NewCoinbaseCandleCodec() CandleCodec
  • func NewKrakenCandleCodec() CandleCodec
• type DecodeKeyFunc
• type KeyGetter
  • func NewKeyGetter(online, offline, all DecodeKeyFunc, req http.Request) KeyGetter
• type LossyDecodeFunc
• type Proto
• type ProtoMsgFunc
• type Reader
• type SinkDecoder
• type SinkFunc
• type SinkTryFunc
• type Source
  • func NewSource(origin string, symbol SymbolCodec, book BookCodec, trade TradeCodec, ...) Source
• type SymbolCodec
  • func NewCoinbaseSymbolCodec() SymbolCodec
  • func NewKrakenSymbolCodec() SymbolCodec
  • func NewSymbolCodec(endpoint endpoint, sub, unsub ProtoMsgFunc, ...) SymbolCodec
• type TradeCodec
  • func NewCoinbaseTradeCodec() TradeCodec
  • func NewKrakenTradeCodec() TradeCodec
  • func NewTradeCodec(endpoint endpoint, sub, unsub ProtoMsgFunc, ...) TradeCodec
• type UnitDecoder

Variables

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

Types

type BatchDecodeFunc

type BatchDecodeFunc[T core.Event] func(frame []byte, destination []T) (int, bool, error)

type BatchDecoder

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

type BookCodec

type BookCodec interface {
	Proto
	UnitDecoder[core.BookEvent]
}

func NewBookCodec

func NewBookCodec(
	endpoint endpoint,
	sub, unsub ProtoMsgFunc,
	decode LossyDecodeFunc[core.BookEvent, bookBase],
) BookCodec

func NewCoinbaseBookCodec

func NewCoinbaseBookCodec() BookCodec

func NewKrakenBookCodec

func NewKrakenBookCodec() BookCodec

type CandleCodec

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

func NewCandleCodec

func NewCandleCodec(
	endpoint endpoint,
	sub, unsub ProtoMsgFunc,
	sink SinkFunc[core.CandleEvent, candleBase],
	try SinkTryFunc[core.CandleEvent, candleBase],
) CandleCodec

func NewCoinbaseCandleCodec

func NewCoinbaseCandleCodec() CandleCodec

func NewKrakenCandleCodec

func NewKrakenCandleCodec() CandleCodec

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 LossyDecodeFunc

type LossyDecodeFunc[T core.Event, B codecBase] func(base *B, frame []byte) (T, bool, error)

type Proto

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

type ProtoMsgFunc

type ProtoMsgFunc func(key core.Key) []byte

type Reader

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

type SinkDecoder

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

type SinkFunc

type SinkFunc[T core.Event, B codecBase] func(base *B, key core.Key, frame []byte) (T, bool, error)

type SinkTryFunc

type SinkTryFunc[T core.Event, B codecBase] func(base *B, 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 SymbolCodec,
	book BookCodec,
	trade TradeCodec,
	candle CandleCodec,
	getter KeyGetter,
) Source

type SymbolCodec

type SymbolCodec interface {
	Proto
	BatchDecoder[core.SymbolEvent]
}

func NewCoinbaseSymbolCodec

func NewCoinbaseSymbolCodec() SymbolCodec

func NewKrakenSymbolCodec

func NewKrakenSymbolCodec() SymbolCodec

func NewSymbolCodec

func NewSymbolCodec(
	endpoint endpoint,
	sub, unsub ProtoMsgFunc,
	decode BatchDecodeFunc[core.SymbolEvent],
) SymbolCodec

type TradeCodec

type TradeCodec interface {
	Proto
	BatchDecoder[core.TradeEvent]
}

func NewCoinbaseTradeCodec

func NewCoinbaseTradeCodec() TradeCodec

func NewKrakenTradeCodec

func NewKrakenTradeCodec() TradeCodec

func NewTradeCodec

func NewTradeCodec(
	endpoint endpoint,
	sub, unsub ProtoMsgFunc,
	decode BatchDecodeFunc[core.TradeEvent],
) TradeCodec

type UnitDecoder

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