l4subroute

Documentation

Index

• type Handler
  • func (*Handler) CaddyModule() caddy.ModuleInfo
  • func (h *Handler) Handle(cx *layer4.Connection, next layer4.Handler) error
  • func (h *Handler) Provision(ctx caddy.Context) error
  • func (h *Handler) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

Types

type Handler

type Handler struct {
	// The primary list of routes to compile and execute.
	Routes layer4.RouteList `json:"routes,omitempty"`

	// Maximum time connections have to complete the matching phase (the first terminal handler is matched). Default: 3s.
	MatchingTimeout caddy.Duration `json:"matching_timeout,omitempty"`
	// contains filtered or unexported fields
}

Handler implements a handler that compiles and executes routes. This is useful for a batch of routes that all inherit the same matchers, or for multiple routes that should be treated as a single route.

func (*Handler) CaddyModule

func (*Handler) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Handler) Handle

func (h *Handler) Handle(cx *layer4.Connection, next layer4.Handler) error

Handle handles the connections.

func (*Handler) Provision

func (h *Handler) Provision(ctx caddy.Context) error

Provision sets up the module.

func (*Handler) UnmarshalCaddyfile

func (h *Handler) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile sets up the Handler from Caddyfile tokens. Syntax:

subroute {
	matching_timeout <duration>
	@a <matcher> [<matcher_args>]
	@b {
		<matcher> [<matcher_args>]
		<matcher> [<matcher_args>]
	}
	route @a @b {
		<handler> [<handler_args>]
	}
	@c <matcher> {
		<matcher_option> [<matcher_option_args>]
	}
	route @c {
		<handler> [<handler_args>]
		<handler> {
			<handler_option> [<handler_option_args>]
		}
	}
}