api

Documentation

Index

• type Error
• type Server
  • func (a *Server) Handler() (http.Handler, error)
• type Signal

Types

type Error

type Error struct {
	StatusCode int    `json:"status_code"`
	Message    string `json:"error"`
}

Error represents JSON error to be sent to user.

type Server

type Server struct {
	Name      string          // Name of this Nanny.
	Notifiers notifiers       // Enabled notifiers.
	Storage   storage.Storage // What to use as persistence system.
	// contains filtered or unexported fields
}

Server is Nanny API Server.

func (*Server) Handler

func (a *Server) Handler() (http.Handler, error)

Handler returns http.Handler and error. This way we can customise http.Server and just pass in our handlers.

type Signal

type Signal struct {
	// Name of program being monitored.
	// IP addres of caller is appended to the name so it may be non-unique.
	Name     string `json:"name"`
	Notifier string `json:"notifier"` // What notifier to use.
	// After how many seconds to expect next call.
	// May contain "10s", "1h": https://golang.org/pkg/time/#ParseDuration
	NextSignal string            `json:"next_signal"`
	Meta       map[string]string `json:"meta"` // Metadata for this signal, may contain custom data.
}

Signal represents incomming JSON-encoded data to process.