event

Documentation

Index

• type Callback
• type Manager
  • func NewEventManager() *Manager
  • func (e *Manager) EventService() (stoppable.Stoppable, error)
  • func (e *Manager) RegisterEventCallback(name string, myFunc Callback) error
  • func (e *Manager) Report(priority int, category, evtType, details string)
  • func (e *Manager) UnregisterEventCallback(name string)
• type Reporter

Types

type Callback

type Callback func(priority int, category, evtType, details string)

Callback defines the callback functions for client event reports

type Manager

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

Holds state for the event reporting system

func NewEventManager

func NewEventManager() *Manager

func (*Manager) EventService

func (e *Manager) EventService() (stoppable.Stoppable, error)

func (*Manager) RegisterEventCallback

func (e *Manager) RegisterEventCallback(name string,
	myFunc Callback) error

RegisterEventCallback records the given function to receive ReportableEvent objects. It returns the internal index of the callback so that it can be deleted later.

func (*Manager) Report

func (e *Manager) Report(priority int, category, evtType, details string)

Report reports an event from the client to api users, providing a priority, category, eventType, and details

func (*Manager) UnregisterEventCallback

func (e *Manager) UnregisterEventCallback(name string)

UnregisterEventCallback deletes the callback identified by the index. It returns an error if it fails.

type Reporter

type Reporter interface {
	Report(priority int, category, evtType, details string)
}

Reporter reporting api (used internally)