listener

Documentation

Index

• Constants
• func IsDisconnected(err error) bool
• type MonitorListener
• type Version

Constants

const (
	// VersionUnsupported is here for use in error returns etc.
	VersionUnsupported = Version("unsupported")

	// Version1_2 is the API 1.0 version of the protocol (see above).
	Version1_2 = Version("1.2")
)

Functions

func IsDisconnected

func IsDisconnected(err error) bool

IsDisconnected is a convenience function that wraps the absurdly long set of checks for a disconnect.

Types

type MonitorListener

type MonitorListener interface {
	// Enqueue adds this payload to the send queue. Any errors should be logged
	// and handled appropriately.
	Enqueue(pl *payload.Payload)

	// Version returns the API version of this listener
	Version() Version

	// Close closes the listener.
	Close()
}

MonitorListener is a generic consumer of monitor events. Implementers are expected to handle errors as needed, including exiting.

type Version

type Version string

Version is the version of a node-monitor listener client. There are two API versions:

• 1.0 which encodes the gob type information with each payload sent, and adds a meta object before it.
• 1.2 which maintains a gob session per listener, thus only encoding the type information on the first payload sent. It does NOT prepend the a meta object.