watched

README

Watch Elite: Dangerous Journal Files

This is a Go library to watch Journal files of Elite: Dangerous. The commander's Journal is official way to hook player tools into E:D.

This root package only defines some abstractions for event processing. This gives developers the opportunity to build different processing strategies for the events coming from ED.

Building

Using watched as a library does not need anything special. Just

import "github.com/CmdrVasquess/watched"

in your application.

If you want to build edeh and use it right in place, you have to build the project. Want to get platform independent, instead of make try to use

$ go run mk/mk.go

Documentation

Index

• Constants
• func LogCfg() c4hgol.Group
• func Peek(str []byte) (t time.Time, event string, err error)
• func PeekEvent(str []byte) (event string, err error)
• func PeekTime(str []byte) (t time.Time, err error)
• type BranchConfig
• type EventRecv
• type EventSrc
• type JEIDCounter
  • func (idc *JEIDCounter) Count(t time.Time) (JEventID, error)
  • func (idc *JEIDCounter) CountUnix(tu int64) (JEventID, error)
  • func (idc *JEIDCounter) Last() JEventID
  • func (idc *JEIDCounter) SetLast(jeid JEventID)
• type JEventID
• type JounalEvent
• type RawEvent
  • func (re RawEvent) Peek() (time.Time, string, error)
  • func (re RawEvent) PeekEvent() (string, error)
  • func (re RawEvent) PeekTime() (time.Time, error)
• type RecvToSrc
  • func (rs *RecvToSrc) Branch(cfg BranchConfig) EventSrc
  • func (rs *RecvToSrc) Close() error
  • func (rs *RecvToSrc) OnJournalEvent(e JounalEvent) error
  • func (rs *RecvToSrc) OnStatusEvent(e StatusEvent) error
• type StatusEvent
• type StatusType
  • func ParseStatusType(s string) StatusType
  • func (st StatusType) String() string

Constants

const (
	StatCargoName    = "Cargo"
	StatMarketName   = "Market"
	StatModulesName  = "ModuleInfo"
	StatNavRouteName = "NavRoute"
	StatOutfitName   = "Outfitting"
	StatShipyardName = "Shipyard"
	StatStatusName   = "Status"
)

const (
	JESequenceMask = (1 << jeSequenceBits) - 1
)

Functions

func LogCfg

func LogCfg() c4hgol.Group

func Peek

func Peek(str []byte) (t time.Time, event string, err error)

func PeekEvent

func PeekEvent(str []byte) (event string, err error)

func PeekTime

func PeekTime(str []byte) (t time.Time, err error)

Types

type BranchConfig

type BranchConfig struct {
	JournalQLen int
	StatusQLen  int
}

type EventRecv

type EventRecv interface {
	OnJournalEvent(e JounalEvent) error
	OnStatusEvent(e StatusEvent) error
	Close() error
}

type EventSrc

type EventSrc struct {
	Journal <-chan JounalEvent
	Status  <-chan StatusEvent
}

type JEIDCounter

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

JEIDCounter generates unique journal event IDs from the event timestamp and a sequence part that numbers all events from one second. JEIDCounter requires that not more than 2^jeSequenceBits=1024 events per second occur.

func (*JEIDCounter) Count

func (idc *JEIDCounter) Count(t time.Time) (JEventID, error)

func (*JEIDCounter) CountUnix

func (idc *JEIDCounter) CountUnix(tu int64) (JEventID, error)

func (*JEIDCounter) Last

func (idc *JEIDCounter) Last() JEventID

func (*JEIDCounter) SetLast

func (idc *JEIDCounter) SetLast(jeid JEventID)

type JEventID

type JEventID = int64

const StartNow JEventID = -1

type JounalEvent

type JounalEvent struct {
	Serial JEventID
	Event  RawEvent
}

type RawEvent

type RawEvent []byte

func (RawEvent) Peek

func (re RawEvent) Peek() (time.Time, string, error)

func (RawEvent) PeekEvent

func (re RawEvent) PeekEvent() (string, error)

func (RawEvent) PeekTime

func (re RawEvent) PeekTime() (time.Time, error)

type RecvToSrc

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

func (*RecvToSrc) Branch

func (rs *RecvToSrc) Branch(cfg BranchConfig) EventSrc

func (*RecvToSrc) Close

func (rs *RecvToSrc) Close() error

func (*RecvToSrc) OnJournalEvent

func (rs *RecvToSrc) OnJournalEvent(e JounalEvent) error

func (*RecvToSrc) OnStatusEvent

func (rs *RecvToSrc) OnStatusEvent(e StatusEvent) error

type StatusEvent

type StatusEvent struct {
	Type  StatusType
	Event RawEvent
}

type StatusType

type StatusType int

const (
	StatCargo StatusType = iota + 1
	StatMarket
	StatModules
	StatNavRoute
	StatOutfit
	StatShipyard
	StatStatus
)

func ParseStatusType

func ParseStatusType(s string) StatusType

func (StatusType) String

func (st StatusType) String() string