journal

Documentation

Overview

Package journal provides a mechanism to emit Events from an RxGo (github.com/ReactiveX/RxGo/) Observable any time the game updates the files in the log directory.

Index

• type GameJournal
  • func NewJournal() (gj GameJournal, err error)
  • func (j GameJournal) StartMonitor() (err error)
  • func (j GameJournal) StopMonitor()

Types

type GameJournal

type GameJournal struct {
	Events <-chan event.Event
	Errors <-chan error
	// contains filtered or unexported fields
}

GameJournal represents the set of log files produced by Elite as an observable stream of events. DO NOT directly instance this type. Please use the NewJournal() function.

func NewJournal

func NewJournal() (gj GameJournal, err error)

NewJournal creates and initializes a GameJournal.

func (GameJournal) StartMonitor

func (j GameJournal) StartMonitor() (err error)

StartMonitor starts the file watcher and begins emitting events to the Events channel

func (GameJournal) StopMonitor

func (j GameJournal) StopMonitor()

StopMonitor terminates the file watcher, preventing further events being emitted