channel

Documentation

Overview

Package channel implements the channel interface

Index

• func AllDone()
• func ConfigAllChannels()
• func GetAllChannels() map[string]*Channel
• func GetNotifiers(channel []string) map[string]notify.Notify
• func IsDryNotify() bool
• func SetChannel(name string)
• func SetDryNotify(dry bool)
• func SetNotifiers(notifiers []notify.Notify)
• func SetNotify(channel string, n notify.Notify)
• func SetProber(channel string, p probe.Prober)
• func SetProbers(probers []probe.Prober)
• func WatchForAllEvents()
• type Channel
  • func GetChannel(name string) *Channel
  • func NewEmpty(name string) *Channel
  • func (c *Channel) Channel() chan probe.Result
  • func (c *Channel) Config()
  • func (c *Channel) Done() chan bool
  • func (c *Channel) GetNotify(name string) notify.Notify
  • func (c *Channel) GetProber(name string) probe.Prober
  • func (c *Channel) Send(result probe.Result)
  • func (c *Channel) SetNotifiers(notifiers []notify.Notify)
  • func (c *Channel) SetNotify(n notify.Notify)
  • func (c *Channel) SetProber(p probe.Prober)
  • func (c *Channel) SetProbers(probers []probe.Prober)
  • func (c *Channel) WatchEvent(wg *sync.WaitGroup)

Functions

func AllDone

func AllDone()

AllDone send the done signal to all channels

func ConfigAllChannels

func ConfigAllChannels()

ConfigAllChannels config all channels

func GetAllChannels

func GetAllChannels() map[string]*Channel

GetAllChannels returns all channels

func GetNotifiers

func GetNotifiers(channel []string) map[string]notify.Notify

GetNotifiers returns all of the notifiers by a list of channel names

func IsDryNotify

func IsDryNotify() bool

IsDryNotify returns the dry run flag

func SetChannel

func SetChannel(name string)

SetChannel sets the channel

func SetDryNotify

func SetDryNotify(dry bool)

SetDryNotify sets the global dry run flag

func SetNotifiers

func SetNotifiers(notifiers []notify.Notify)

SetNotifiers set a notify to the channel

func SetNotify

func SetNotify(channel string, n notify.Notify)

SetNotify set a notify to the channel

func SetProber

func SetProber(channel string, p probe.Prober)

SetProber sets the prober

func SetProbers

func SetProbers(probers []probe.Prober)

SetProbers sets the probers

func WatchForAllEvents

func WatchForAllEvents()

WatchForAllEvents watch the event for all channels

Types

type Channel

type Channel struct {
	Name      string                   `yaml:"name"`      // unique name
	Probers   map[string]probe.Prober  `yaml:"probers"`   // probers
	Notifiers map[string]notify.Notify `yaml:"notifiers"` // notifiers
	// contains filtered or unexported fields
}

Channel implements a config for Channel

func GetChannel

func GetChannel(name string) *Channel

GetChannel returns the channel

func NewEmpty

func NewEmpty(name string) *Channel

NewEmpty creates a new empty Channel object with nil channel After setup the probers, You have to call Config() to create the channel

func (*Channel) Channel

func (c *Channel) Channel() chan probe.Result

Channel returns the notification channel

func (*Channel) Config

func (c *Channel) Config()

Config configures the channel

func (*Channel) Done

func (c *Channel) Done() chan bool

Done returns the done channel

func (*Channel) GetNotify

func (c *Channel) GetNotify(name string) notify.Notify

GetNotify returns the Notify object

func (*Channel) GetProber

func (c *Channel) GetProber(name string) probe.Prober

GetProber returns the Notify object

func (*Channel) Send

func (c *Channel) Send(result probe.Result)

Send sends the result to the channel

func (*Channel) SetNotifiers

func (c *Channel) SetNotifiers(notifiers []notify.Notify)

SetNotifiers sets the Notify objects

func (*Channel) SetNotify

func (c *Channel) SetNotify(n notify.Notify)

SetNotify sets the Notify object

func (*Channel) SetProber

func (c *Channel) SetProber(p probe.Prober)

SetProber sets the Notify object

func (*Channel) SetProbers

func (c *Channel) SetProbers(probers []probe.Prober)

SetProbers sets the Notify objects

func (*Channel) WatchEvent

func (c *Channel) WatchEvent(wg *sync.WaitGroup)

WatchEvent watches the notification event Go through all of notification to notify the result.