caddymodule

Documentation

Index

• Constants
• type Olaf
  • func (Olaf) CaddyModule() caddy.ModuleInfo
  • func (o *Olaf) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error
  • func (o *Olaf) UnmarshalCaddyfile(d *caddyfile.Dispenser) (err error)
  • func (o *Olaf) Validate() error

Constants

const (
	TypeFile = "file"
	TypeHTTP = "http"
)

Types

type Olaf

type Olaf struct {
	// The config source type.
	Type string `json:"type,omitempty"`

	// The path to the config.
	//
	//    Type: TypeFile => Path: filename
	//    Type: TypeHTTP => Path: url
	Path string `json:"path,omitempty"`

	// Maximum time allowed for a complete connection and request. This
	// option is useful only if Type is TypeHTTP.
	Timeout caddy.Duration `json:"timeout,omitempty"`
}

Olaf implements a handler that embeds Olaf's declarative configuration, which will be expanded later by a config adapter named `olaf`.

func (Olaf) CaddyModule

func (Olaf) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Olaf) ServeHTTP

func (o *Olaf) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error

ServeHTTP implements caddyhttp.MiddlewareHandler.

func (*Olaf) UnmarshalCaddyfile

func (o *Olaf) UnmarshalCaddyfile(d *caddyfile.Dispenser) (err error)

UnmarshalCaddyfile implements caddyfile.Unmarshaler. Syntax:

olaf <path>

func (*Olaf) Validate

func (o *Olaf) Validate() error

Validate implements caddy.Validator.