Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Dispatcher ¶
type Dispatcher struct {
Receivers []Receiver
SimpleReceiver
}
Dispatcher is a meta-receiver which sends requests to other receivers
func NewDispatcher ¶
func NewDispatcher(receivers ...Receiver) *Dispatcher
NewDispatcher is a helper to build a dispatcher from a list of receivers
type ErrorFunc ¶
ErrorFunc takes a events.Request and error and returns a crafted error events.Response
type HandleFunc ¶
HandleFunc takes a events.Request and returns a events.Response and error
type Receiver ¶
type Receiver interface {
Check(events.Request) bool
Handle(events.Request) (events.Response, error)
Auth(events.Request) (events.Response, error)
Error(events.Request, error) (events.Response, error)
}
Receiver defines the format of an object that can process events.Requests
func NewReceiver ¶
func NewReceiver(cf CheckFunc, af HandleFunc, hf HandleFunc, ef ErrorFunc) Receiver
NewReceiver generates a receiver from functions
type Route ¶
type Route struct {
Path *regexp.Regexp
SimpleReceiver
}
Route is a receiver that works based on a regex path
func NewRoute ¶
func NewRoute(path *regexp.Regexp, handler HandleFunc) *Route
NewRoute is a helper to convert a regexp and handlefunc into a Route Receiver
func NewRouteWithAuth ¶ added in v0.5.0
func NewRouteWithAuth(path *regexp.Regexp, handler HandleFunc, auth HandleFunc) *Route
NewRouteWithAuth is a helper to conver a regexp, handler, and auth func into a Route Receiver
func NewRouteWithBasicAuth ¶ added in v0.5.0
NewRouteWithBasicAuth is a helper to create a route protected by HTTP basic auth
type SimpleReceiver ¶
type SimpleReceiver struct {
CheckFunc CheckFunc
AuthFunc HandleFunc
HandleFunc HandleFunc
ErrorFunc ErrorFunc
}
SimpleReceiver defines a basic Receiver composed of 4 functions
func (*SimpleReceiver) Check ¶
func (rs *SimpleReceiver) Check(req events.Request) bool
Check determines if the receiver can handle the given events.Request
Source Files
Directories