events

Documentation

Index

• Constants
• type BaseEvent
  • func (be *BaseEvent) Created() time.Time
  • func (be *BaseEvent) EventID() string
  • func (be *BaseEvent) Message() string
  • func (be *BaseEvent) Reference() string
  • func (be *BaseEvent) String() string
• type ContainerEvent
  • func (ce *ContainerEvent) Topic() string
• type Event
• type EventTopic
• type EventType
  • func NewEventType(kind interface{}) EventType
  • func (t EventType) Topic() string

Constants

const (
	ContainerCreated       = "Created"
	ContainerFailed        = "Failed"
	ContainerMigrated      = "Migrated"
	ContainerMigratedByDrs = "MigratedByDrs"
	ContainerPoweredOff    = "PoweredOff"
	ContainerPoweredOn     = "PoweredOn"
	ContainerReconfigured  = "Reconfigured"
	ContainerRelocated     = "Relocated"
	ContainerRemoved       = "Removed"
	ContainerResumed       = "Resumed"
	ContainerShutdown      = "Shutdown"
	ContainerStarted       = "Started"
	ContainerStopped       = "Stopped"
	ContainerSuspended     = "Suspended"
)

Types

type BaseEvent

type BaseEvent struct {
	Type        EventType
	Event       string
	ID          string
	Detail      string
	Ref         string
	CreatedTime time.Time
}

func (*BaseEvent) Created

func (be *BaseEvent) Created() time.Time

func (*BaseEvent) EventID

func (be *BaseEvent) EventID() string

func (*BaseEvent) Message

func (be *BaseEvent) Message() string

func (*BaseEvent) Reference

func (be *BaseEvent) Reference() string

func (*BaseEvent) String

func (be *BaseEvent) String() string

return event type / description

type ContainerEvent

type ContainerEvent struct {
	*BaseEvent
}

func (*ContainerEvent) Topic

func (ce *ContainerEvent) Topic() string

type Event

type Event interface {
	EventTopic
	// id of event
	EventID() string
	// event (PowerOn, PowerOff, etc)
	String() string
	// reference evented object
	Reference() string
	// event message
	Message() string

	Created() time.Time
}

type EventTopic

type EventTopic interface {
	Topic() string
}

type EventType

type EventType string

func NewEventType

func NewEventType(kind interface{}) EventType

NewEventType utility function that uses reflection to return the event type

func (EventType) Topic

func (t EventType) Topic() string