nginx

Documentation

Overview

Access Nginx APIs.

Index

• type Nginx
  • func (n Nginx) GetCtxAny(k string) (interface{}, error)
  • func (n Nginx) GetCtxFloat(k string) (float64, error)
  • func (n Nginx) GetCtxInt(k string) (int, error)
  • func (n Nginx) GetCtxString(k string) (string, error)
  • func (n Nginx) GetSubsystem() (string, error)
  • func (n Nginx) GetTLS1VersionStr() (string, error)
  • func (n Nginx) GetVar(k string) (string, error)
  • func (n Nginx) ReqStartTime() (float64, error)
  • func (n Nginx) SetCtx(k string, v interface{}) error

Types

type Nginx

type Nginx struct {
	bridge.PdkBridge
}

Holds this module's functions. Accessible as `kong.Nginx`

func (Nginx) GetCtxAny

func (n Nginx) GetCtxAny(k string) (interface{}, error)

kong.Nginx.GetCtxAny() returns a value from the `ngx.ctx` request context table.

func (Nginx) GetCtxFloat

func (n Nginx) GetCtxFloat(k string) (float64, error)

kong.Nginx.GetCtxFloat() returns a float value from the `ngx.ctx` request context table.

func (Nginx) GetCtxInt

func (n Nginx) GetCtxInt(k string) (int, error)

kong.Nginx.GetCtxInt() returns an integer value from the `ngx.ctx` request context table.

func (Nginx) GetCtxString

func (n Nginx) GetCtxString(k string) (string, error)

kong.Nginx.GetCtxString() returns a string value from the `ngx.ctx` request context table.

func (Nginx) GetSubsystem

func (n Nginx) GetSubsystem() (string, error)

kong.Nginx.GetSubsystem() returns the current Nginx subsystem this function is called from: “http” or “stream”.

func (Nginx) GetTLS1VersionStr

func (n Nginx) GetTLS1VersionStr() (string, error)

func (Nginx) GetVar

func (n Nginx) GetVar(k string) (string, error)

kong.Nginx.GetVar() returns an Nginx variable. Equivalent to `ngx.var[k]`

func (Nginx) ReqStartTime

func (n Nginx) ReqStartTime() (float64, error)

kong.Nginx.ReqStartTime() returns the curent request's start time as a floating-point number of seconds. Equivalent to `ngx.req.start_time()`

func (Nginx) SetCtx

func (n Nginx) SetCtx(k string, v interface{}) error

kong.Nginx.SetCtx() sets a value in the `ngx.ctx` request context table.