monitor

Documentation

Overview

Package monitor provides access to monitored addresses

Index

• Constants
• func ListExistingMonitors(chain string, monitorChan chan<- Monitor)
• func ListWatchedMonitors(chain, watchList string, monitorChan chan<- Monitor)
• func PathToMonitorFile(chain string, address base.Address) string
• type Header
• type Monitor
  • func NewMonitor(chain string, addr base.Address, create bool) (Monitor, error)
  • func NewMonitorStaged(chain, addr string) (Monitor, error)
  • func (mon *Monitor) Close()
  • func (mon *Monitor) Count() int64
  • func (mon *Monitor) Decache(conn *rpc.Connection, showProgress bool) (string, error)
  • func (mon *Monitor) Delete() (prev bool)
  • func (mon *Monitor) GetRemoveWarning() string
  • func (mon *Monitor) IsDeleted() bool
  • func (mon *Monitor) IsOpen() bool
  • func (mon *Monitor) MoveToProduction() error
  • func (mon *Monitor) Path() (path string)
  • func (mon *Monitor) ReadAndFilterAppearances(filt *filter.AppearanceFilter, withCount bool) (apps []types.Appearance, cnt int, err error)
  • func (mon *Monitor) ReadAppearanceAt(idx int64, app *types.AppRecord) (err error)
  • func (mon *Monitor) ReadMonitorHeader() (err error)
  • func (mon *Monitor) Reload(create bool) (int64, error)
  • func (mon *Monitor) Remove() (bool, error)
  • func (mon *Monitor) RemoveDups() (int64, int64, error)
  • func (mon *Monitor) RemoveMonitor() string
  • func (mon Monitor) String() string
  • func (mon *Monitor) TruncateTo(chain string, num uint32) (bool, error)
  • func (mon *Monitor) UnDelete() (prev bool)
  • func (mon *Monitor) WriteAppearances(apps []types.AppRecord, append bool) (int64, error)
  • func (mon *Monitor) WriteAppearancesAppend(lastScanned uint32, apps *[]types.AppRecord) error
  • func (mon *Monitor) WriteMonHeader(deleted bool, lastScanned uint32, force bool) (err error)
• type MonitorUpdate
  • func NewUpdater(chain string, testMode, skipFreshen bool, addrs []string) MonitorUpdate
  • func (updater *MonitorUpdate) FreshenMonitors(monitorArray *[]Monitor) (bool, error)

Constants

const (
	Ext = ".mon.bin"
)

Functions

func ListExistingMonitors

func ListExistingMonitors(chain string, monitorChan chan<- Monitor)

ListExistingMonitors puts a list of Monitors into the monitorChannel. The list of monitors is built from a file called addresses.tsv in the current folder or, if not present, from existing monitors

func ListWatchedMonitors

func ListWatchedMonitors(chain, watchList string, monitorChan chan<- Monitor)

ListWatchedMonitors puts a list of Monitors into the monitorChannel. The list of monitors is built from a file called addresses.tsv in the current folder

func PathToMonitorFile

func PathToMonitorFile(chain string, address base.Address) string

Types

type Header

type Header struct {
	Magic       uint16 `json:"-"`
	Unused      bool   `json:"-"`
	Deleted     bool   `json:"deleted,omitempty"`
	LastScanned uint32 `json:"lastScanned,omitempty"`
}

Header is the header of the Monitor file. Note that it's the same width as an types.AppRecord therefor one should not change its size

type Monitor

type Monitor struct {
	Address base.Address `json:"address"`
	Staged  bool         `json:"-"`
	Chain   string       `json:"-"`
	ReadFp  *os.File     `json:"-"`
	Header
}

Monitor carries information about a Monitor file and its header

func NewMonitor

func NewMonitor(chain string, addr base.Address, create bool) (Monitor, error)

NewMonitor returns a Monitor (but has not yet read in the AppearanceRecords). If 'create' is sent, create the Monitor if it does not already exist

func NewMonitorStaged

func NewMonitorStaged(chain, addr string) (Monitor, error)

NewMonitorStaged returns a Monitor whose path is in the 'staging' folder

func (*Monitor) Close

func (mon *Monitor) Close()

Close closes an open Monitor if it's open, does nothing otherwise

func (*Monitor) Count

func (mon *Monitor) Count() int64

func (*Monitor) Decache

func (mon *Monitor) Decache(conn *rpc.Connection, showProgress bool) (string, error)

func (*Monitor) Delete

func (mon *Monitor) Delete() (prev bool)

Delete marks the file's delete flag, but does not physically remove the file

func (*Monitor) GetRemoveWarning

func (mon *Monitor) GetRemoveWarning() string

func (*Monitor) IsDeleted

func (mon *Monitor) IsDeleted() bool

IsDeleted returns true if the monitor has been deleted but not removed

func (*Monitor) IsOpen

func (mon *Monitor) IsOpen() bool

IsOpen returns true if the underlying monitor file is opened.

func (*Monitor) MoveToProduction

func (mon *Monitor) MoveToProduction() error

MoveToProduction moves a previously staged monitor to the monitors folder.

func (*Monitor) Path

func (mon *Monitor) Path() (path string)

Path returns the path to the Monitor file

func (*Monitor) ReadAndFilterAppearances

func (mon *Monitor) ReadAndFilterAppearances(filt *filter.AppearanceFilter, withCount bool) (apps []types.Appearance, cnt int, err error)

func (*Monitor) ReadAppearanceAt

func (mon *Monitor) ReadAppearanceAt(idx int64, app *types.AppRecord) (err error)

ReadAppearanceAt returns the appearance at the one-based index. The file remains open.

func (*Monitor) ReadMonitorHeader

func (mon *Monitor) ReadMonitorHeader() (err error)

ReadMonitorHeader reads the monitor's header and returns without closing the file

func (*Monitor) Reload

func (mon *Monitor) Reload(create bool) (int64, error)

Reload loads information about the monitor such as the file's size and record count

func (*Monitor) Remove

func (mon *Monitor) Remove() (bool, error)

Remove removes a previously deleted file, does nothing if the file is not deleted

func (*Monitor) RemoveDups

func (mon *Monitor) RemoveDups() (int64, int64, error)

func (*Monitor) RemoveMonitor

func (mon *Monitor) RemoveMonitor() string

func (Monitor) String

func (mon Monitor) String() string

func (*Monitor) TruncateTo

func (mon *Monitor) TruncateTo(chain string, num uint32) (bool, error)

func (*Monitor) UnDelete

func (mon *Monitor) UnDelete() (prev bool)

UnDelete unmarks the file's delete flag

func (*Monitor) WriteAppearances

func (mon *Monitor) WriteAppearances(apps []types.AppRecord, append bool) (int64, error)

WriteAppearances writes appearances to a Monitor

func (*Monitor) WriteAppearancesAppend

func (mon *Monitor) WriteAppearancesAppend(lastScanned uint32, apps *[]types.AppRecord) error

WriteAppearancesAppend appends appearances to the end of the file, updates the header with lastScanned (if later) and returns the number of records written. Note that we should be writing to a temporary file.

func (*Monitor) WriteMonHeader

func (mon *Monitor) WriteMonHeader(deleted bool, lastScanned uint32, force bool) (err error)

WriteMonHeader writes the monitor's header

type MonitorUpdate

type MonitorUpdate struct {
	MaxTasks      int
	MonitorMap    map[base.Address]*Monitor
	Chain         string
	PublisherAddr base.Address
	TestMode      bool
	SkipFreshen   bool
	FirstBlock    base.Blknum
	Addrs         []string
}

MonitorUpdate stores the original 'chifra list' command line options plus

func NewUpdater

func NewUpdater(chain string, testMode, skipFreshen bool, addrs []string) MonitorUpdate

func (*MonitorUpdate) FreshenMonitors

func (updater *MonitorUpdate) FreshenMonitors(monitorArray *[]Monitor) (bool, error)