notifier

Documentation

Overview

Package notifier implements push notifications.

Index

• Constants
• func DescribeShoutrrrService(ppfmt pp.PP, proto string) string
• type Composed
  • func NewComposed(nots ...Notifier) Composed
  • func (ns Composed) Describe(yield func(name string, params string) bool)
  • func (ns Composed) Send(ctx context.Context, ppfmt pp.PP, msg Message) bool
• type Message
  • func MergeMessages(msgs ...Message) Message
  • func NewMessage() Message
  • func NewMessagef(format string, args ...any) Message
  • func (m Message) Format() string
  • func (m Message) IsEmpty() bool
• type Notifier
• type Shoutrrr
  • func NewShoutrrr(ppfmt pp.PP, rawURLs []string) (Shoutrrr, bool)
  • func (s Shoutrrr) Describe(yield func(string, string) bool)
  • func (s Shoutrrr) Send(_ context.Context, ppfmt pp.PP, msg Message) bool

Constants

const (
	// ShoutrrrDefaultTimeout is the default timeout for a UptimeKuma ping.
	ShoutrrrDefaultTimeout = 10 * time.Second
)

Functions

func DescribeShoutrrrService

func DescribeShoutrrrService(ppfmt pp.PP, proto string) string

DescribeShoutrrrService gives a human-readable description for a service.

Types

type Composed

type Composed []Notifier

Composed represents the composite of multiple notifiers.

func NewComposed

func NewComposed(nots ...Notifier) Composed

NewComposed creates a new composed notifier.

func (Composed) Describe

func (ns Composed) Describe(yield func(name string, params string) bool)

Describe calls [Notifier.Describe] for each notifier in the group with the callback.

func (Composed) Send

func (ns Composed) Send(ctx context.Context, ppfmt pp.PP, msg Message) bool

Send calls [Notifier.Send] for each notifier in the group.

type Message

type Message []string

Message holds the messages and success/failure status for notifiers.

func MergeMessages

func MergeMessages(msgs ...Message) Message

MergeMessages keeps only the ones with highest severity.

func NewMessage

func NewMessage() Message

NewMessage creates a new empty Message.

func NewMessagef

func NewMessagef(format string, args ...any) Message

NewMessagef creates a new MonitorMessage containing one formatted string.

func (Message) Format

func (m Message) Format() string

Format turns the message into a single string.

func (Message) IsEmpty

func (m Message) IsEmpty() bool

IsEmpty checks if the message is empty.

type Notifier

type Notifier interface {
	// Describe a notifier in a human-readable format by calling callback with service names and params.
	Describe(yield func(name, params string) bool)

	// Send out a message.
	Send(ctx context.Context, ppfmt pp.PP, msg Message) bool
}

Notifier is an abstract service for push notifications.

type Shoutrrr

type Shoutrrr struct {
	// The router
	Router *router.ServiceRouter

	// The services
	ServiceDescriptions []string
}

Shoutrrr wraps a handler of a shoutrrr router.

func NewShoutrrr

func NewShoutrrr(ppfmt pp.PP, rawURLs []string) (Shoutrrr, bool)

NewShoutrrr creates a new shoutrrr notifier.

func (Shoutrrr) Describe

func (s Shoutrrr) Describe(yield func(string, string) bool)

Describe calls callback on each registered notification service.

func (Shoutrrr) Send

func (s Shoutrrr) Send(_ context.Context, ppfmt pp.PP, msg Message) bool

Send sents the message msg.