types

package
v4.0.0-rc3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 7, 2022 License: Apache-2.0 Imports: 2 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ACL

type ACL struct {
	Name      string
	Criterion string
	Value     string
	Comment   string
}

is-multiple:true

type Action

type Action interface {
	Parse(parts []string, parserType ParserType, comment string) error
	String() string
	GetComment() string
}

type ArrayStringKeyValue

type ArrayStringKeyValue struct{}

is-multiple:true no-sections:true no-parse:true struct-name:ArrayKeyValue parser-type:StringKeyValueC

type Balance

type Balance struct {
	Algorithm string
	Params    params.BalanceParams
	Comment   string
}

is-multiple:false

type Bind

type Bind struct {
	Path    string // can be address:port or socket path
	Params  []params.BindOption
	Comment string
}

is-multiple:true

type BindProcess

type BindProcess struct {
	Process string
	Comment string
}

is-multiple:false

type CPUMap

type CPUMap struct {
	Process string
	CPUSet  string
	Comment string
}

is-multiple:true

type Comments

type Comments struct {
	Value string
}

no-sections:true is-multiple:true no-init:true no-parse:true

type ConfigHash

type ConfigHash struct {
	Value string
}

no-sections:true no-init:true no-get:true

type ConfigVersion

type ConfigVersion struct {
	Value int64
}

no-sections:true no-init:true no-get:true

type Cookie struct {
	Domain   []string
	Attr     []string
	Name     string
	Type     string
	Comment  string
	Maxidle  int64
	Maxlife  int64
	Dynamic  bool
	Httponly bool
	Indirect bool
	Nocache  bool
	Postonly bool
	Preserve bool
	Secure   bool
}

is-multiple:false

type DeclareCapture

type DeclareCapture struct {
	Type    string
	Length  int64
	Comment string
}

is-multiple:true

type DefaultServer

type DefaultServer struct {
	Params  []params.ServerOption
	Comment string
}

is-multiple:true

type DgramBind

type DgramBind struct {
	Path    string // can be address:port or socket path
	Params  []params.DgramBindOption
	Comment string
}

is-multiple:true

type Enabled

type Enabled struct {
	Comment string
}

Enabled is used by parsers Daemon, MasterWorker, ExternalCheck, NoSplice, CompressionOffload gen:Daemon create-type:bool gen:MasterWorker create-type:bool gen:ExternalCheck create-type:bool gen:NoSplice create-type:bool gen:CompressionOffload create-type:bool

type ErrorFile

type ErrorFile struct {
	Code    string
	File    string
	Comment string
}

no-init:true is-multiple:true

type ExternalCheckCommand

type ExternalCheckCommand struct {
	Command string
	Comment string
}

no-parse:true

type ExternalCheckPath

type ExternalCheckPath struct {
	Path    string
	Comment string
}

no-parse:true

type Filter

type Filter interface {
	Parse(parts []string, comment string) error
	Result() common.ReturnResultLine
}

type Filters

type Filters struct{}

no-sections:true is-multiple:true parser-type:Filter is-interface:true no-init:true no-parse:true

type ForcePersist

type ForcePersist struct {
	Cond     string
	CondTest string
	Comment  string
}

type Group

type Group struct {
	Name    string
	Users   []string
	Comment string
}

is-multiple:true

type H1CaseAdjust

type H1CaseAdjust struct {
	From    string
	To      string
	Comment string
}

is-multiple:true

type HTTPAfterResponse

type HTTPAfterResponse struct{}

struct-name:AfterResponses is-multiple:true parser-type:Action is-interface:true no-parse:true no-init:true

type HTTPCheck

type HTTPCheck struct{}

struct-name:Checks is-multiple:true parser-type:Action is-interface:true no-init:true no-parse:true test:"ok":http-check set-var(check.port) int(1234) test:"ok":http-check set-var-fmt(check.port) int(1234) test:"ok":http-check unset-var(txn.from)

type HTTPCheckV2

type HTTPCheckV2 struct {
	Type            string
	ExclamationMark bool
	Match           string
	Pattern         string
	Comment         string
}

is-multiple:true

type HTTPRequests

type HTTPRequests struct{}

struct-name:Requests is-multiple:true parser-type:Action is-interface:true no-init:true no-parse:true test:"ok":http-request add-header Authorization Basic\ eC1oYXByb3h5LXJlY3J1aXRzOlBlb3BsZSB3aG8gZGVjb2RlIG1lc3NhZ2VzIG9mdGVuIGxvdmUgd29ya2luZyBhdCBIQVByb3h5LiBEbyBub3QgYmUgc2h5LCBjb250YWN0IHVz test:"ok":http-request add-header Authorisation "Basic eC1oYXByb3h5LXJlY3J1aXRzOlBlb3BsZSB3aG8gZGVjb2RlIG1lc3NhZ2VzIG9mdGVuIGxvdmUgd29ya2luZyBhdCBIQVByb3h5LiBEbyBub3QgYmUgc2h5LCBjb250YWN0IHVz" test:"ok":http-request return status 200 content-type "text/plain" string "My content" if { var(txn.myip) -m found } test:"ok":http-request return status 200 content-type "text/plain" string "My content" unless { var(txn.myip) -m found } test:"ok":http-request return content-type "text/plain" string "My content" if { var(txn.myip) -m found } test:"ok":http-request return content-type 'text/plain' string 'My content' if { var(txn.myip) -m found } test:"ok":http-request return content-type "text/plain" lf-string "Hello, you are: %[src]" if { var(txn.myip) -m found } test:"ok":http-request return content-type "text/plain" file /my/fancy/response/file if { var(txn.myip) -m found } test:"ok":http-request return content-type "text/plain" lf-file /my/fancy/lof/format/response/file if { var(txn.myip) -m found } test:"ok":http-request return content-type "text/plain" string "My content" hdr X-value value if { var(txn.myip) -m found } test:"ok":http-request return content-type "text/plain" string "My content" hdr X-value x-value hdr Y-value y-value if { var(txn.myip) -m found } test:"ok":http-request return content-type "text/plain" lf-string "Hello, you are: %[src]" test:"ok":http-request redirect location /file.html if { var(txn.routecookie) "ROUTEMP" }:1

type HTTPResponses

type HTTPResponses struct{}

struct-name:Responses is-multiple:true parser-type:Action is-interface:true no-init:true no-parse:true test:"ok":http-response return status 200 content-type "text/plain" string "My content" if { var(txn.myip) -m found } test:"ok":http-response return status 200 content-type "text/plain" string "My content" unless { var(txn.myip) -m found } test:"ok":http-response return content-type "text/plain" string "My content" if { var(txn.myip) -m found } test:"ok":http-response return content-type 'text/plain' string 'My content' if { var(txn.myip) -m found } test:"ok":http-response return content-type "text/plain" lf-string "Hello, you are: %[src]" if { var(txn.myip) -m found } test:"ok":http-response return content-type "text/plain" file /my/fancy/response/file if { var(txn.myip) -m found } test:"ok":http-response return content-type "text/plain" lf-file /my/fancy/lof/format/response/file if { var(txn.myip) -m found } test:"ok":http-response return content-type "text/plain" string "My content" hdr X-value value if { var(txn.myip) -m found } test:"ok":http-response return content-type "text/plain" string "My content" hdr X-value x-value hdr Y-value y-value if { var(txn.myip) -m found } test:"ok":http-response return content-type "text/plain" lf-string "Hello, you are: %[src]"

type HTTPReuse

type HTTPReuse struct {
	ShareType string
	Comment   string
}

is-multiple:false

type HashType

type HashType struct {
	Method   string
	Function string
	Modifier string
	Comment  string
}

type Int64C

type Int64C struct {
	Value   int64
	Comment string
}

Int64 is used by parsers MaxConn, NbProc, NbThread gen:MaxConn gen:NbProc gen:NbThread gen:StatsMaxconn

type LoadServerStateFromFile

type LoadServerStateFromFile struct {
	Argument string
}

type Log

type Log struct {
	Global   bool
	NoLog    bool
	Address  string
	Length   int64
	Format   string
	Facility string
	Level    string
	MinLevel string
	Comment  string
}

is-multiple:true no-init:true no-parse:true

type LuaLoad

type LuaLoad struct {
	File    string
	Comment string
}

is-multiple:true

type LuaPrependPath

type LuaPrependPath struct {
	Path    string
	Type    string
	Comment string
}

is-multiple:true

type Mailer

type Mailer struct {
	Name    string
	IP      string
	Port    int64
	Comment string
}

is-multiple:true

type MonitorFail

type MonitorFail struct {
	Condition string
	ACLList   []string
}

type MonitorURI

type MonitorURI struct {
	URI string
}

type Nameserver

type Nameserver struct {
	Name    string
	Address string
	Comment string
}

is-multiple:true

type OptionForwardFor

type OptionForwardFor struct {
	Except  string
	Header  string
	IfNone  bool
	Comment string
}

no-parse:true

type OptionHTTPLog

type OptionHTTPLog struct {
	NoOption bool
	Clf      bool
	Comment  string
}

no-parse:true

type OptionHttpchk

type OptionHttpchk struct {
	NoOption bool
	Method   string
	URI      string
	Version  string
	Comment  string
}

no-parse:true

type OptionMysqlCheck

type OptionMysqlCheck struct {
	NoOption      bool
	User          string
	ClientVersion string
	Comment       string
}

no-parse:true

type OptionPgsqlCheck

type OptionPgsqlCheck struct {
	NoOption bool
	User     string
	Comment  string
}

no-parse:true

type OptionRedispatch

type OptionRedispatch struct {
	NoOption bool
	Interval *int64
	Comment  string
}

no-parse:true

type OptionSmtpchk

type OptionSmtpchk struct {
	NoOption bool
	Hello    string
	Domain   string
	Comment  string
}

no-parse:true

type ParserType

type ParserType int
const (
	HTTP ParserType = iota
	TCP
)

type Peer

type Peer struct {
	Name    string
	IP      string
	Port    int64
	Comment string
}

is-multiple:true

type ProcessVary

type ProcessVary struct {
	On      bool
	Comment string
}

is-multiple:false

type Redirect

type Redirect struct{}

is-multiple:true parser-type:Action is-interface:true no-init:true no-parse:true

type Section

type Section struct {
	Name    string
	Comment string
}

no-sections:true no-init:true

type Server

type Server struct {
	Name    string
	Address string
	Params  []params.ServerOption
	Comment string
}

is-multiple:true

type ServerTemplate

type ServerTemplate struct {
	Prefix     string
	NumOrRange string
	Fqdn       string
	Port       int64
	Params     []params.ServerOption
	Comment    string
}

is-multiple:true

type SetVar

type SetVar struct {
	Name    string
	Expr    common.Expression
	Comment string
}

is-multiple:true

type SetVarFmt

type SetVarFmt struct {
	Name    string
	Format  string
	Comment string
}

is-multiple:true test:"ok":set-var-fmt proc.current_state "primary" test:"ok":set-var-fmt proc.bootid "%pid|%t"

type SimpleAutoOnOff

type SimpleAutoOnOff struct{}

no-sections:true struct-name:AutoOnOff parser-type:StringC

type SimpleEnabled

type SimpleEnabled struct{}

no-sections:true struct-name:Enabled parser-type:Enabled

type SimpleNumber

type SimpleNumber struct{}

no-sections:true struct-name:Number parser-type:Int64C

type SimpleOnOff

type SimpleOnOff struct{}

no-sections:true struct-name:OnOff parser-type:StringC

type SimpleOption

type SimpleOption struct {
	NoOption bool
	Comment  string
}

no-sections:true struct-name:Option no-init:true

type SimpleSize

type SimpleSize struct{}

no-sections:true struct-name:Size parser-type:StringC

type SimpleString

type SimpleString struct{}

no-sections:true struct-name:String parser-type:StringC

type SimpleStringKeyValue

type SimpleStringKeyValue struct{}

no-sections:true struct-name:StringKeyValue parser-type:StringKeyValueC

type SimpleStringSlice

type SimpleStringSlice struct{}

no-sections:true struct-name:StringSlice parser-type:StringSliceC

type SimpleTime

type SimpleTime struct{}

no-sections:true struct-name:Time parser-type:StringC

type SimpleTimeout

type SimpleTimeout struct {
	Value   string
	Comment string
}

no-sections:true struct-name:Timeout no-init:true

type SimpleWord

type SimpleWord struct{}

no-sections:true struct-name:Word parser-type:StringC

type Socket

type Socket struct {
	Path    string // can be address:port
	Params  []params.BindOption
	Comment string
}

is-multiple:true

type SslEngine

type SslEngine struct {
	Name       string
	Algorithms []string
	Comment    string
}

is-multiple:true

type SslModeAsync

type SslModeAsync struct{}

type Stats

type Stats struct{}

struct-name:Stats is-multiple:true parser-type:StatsSettings is-interface:true no-init:true no-parse:true

type StatsSettings

type StatsSettings interface {
	Parse(parts []string, comment string) error
	String() string
	GetComment() string
}

type Stick

type Stick struct {
	Type     string
	Pattern  string
	Table    string
	Cond     string
	CondTest string
	Comment  string
}

is-multiple:true no-parse:true

type StickTable

type StickTable struct {
	Type   string
	Length string
	Size   string

	Expire  string
	NoPurge bool
	Peers   string
	Store   string
	Comment string
}

type StringC

type StringC struct {
	Value   string
	Comment string
}

String is used by parsers Mode, DefaultBackend, SimpleTimeTwoWords, StatsTimeout gen:Mode gen:DefaultBackend gen:StatsTimeout gen:LogSendHostName

type StringKeyValueC

type StringKeyValueC struct {
	Key     string
	Value   string
	Comment string
}

StringKeyValueC is a simple key value, for example environment variables.

type StringSliceC

type StringSliceC struct {
	Value   []string
	Comment string
}

StringSliceC is used by ConfigSnippet, CompressionAlgo, CompressionType gen:ConfigSnippet gen:CompressionAlgo gen:CompressionType

type TCPCheck

type TCPCheck struct{}

struct-name:Checks is-multiple:true parser-type:Action is-interface:true no-init:true no-parse:true test:"ok":tcp-check expect string +OK\ POP3\ ready test:"ok":tcp-check expect string *\ OK\ IMAP4\ ready test:"ok":tcp-check send PING\r\n test:"ok":tcp-check send PING\r\n comment testcomment test:"ok":tcp-check send QUIT\r\n test:"ok":tcp-check send QUIT\r\n comment testcomment test:"ok":tcp-check send info\ replication\r\n test:"ok":tcp-check set-var-fmt(check.name) "%H" test:"ok":tcp-check set-var-fmt(txn.from) "addr=%[src]:%[src_port]" test:"fail":tcp-check set-var-fmt(txn.from) "addr=%[src]:%[src_port] if TRUE" test:"ok":tcp-check unset-var(txn.from)

type TCPRequests

type TCPRequests struct{}

struct-name:Requests is-multiple:true parser-type:TCPType is-interface:true no-init:true no-parse:true

type TCPResponses

type TCPResponses struct{}

struct-name:Responses is-multiple:true parser-type:TCPType is-interface:true no-init:true no-parse:true

type TCPType

type TCPType interface {
	Parse(parts []string, comment string) error
	String() string
	GetComment() string
}

type ThreadGroup

type ThreadGroup struct {
	Group      string
	NumOrRange string
	Comment    string
}

is-multiple:true

type TimeTwoWords

type TimeTwoWords struct{}

no-sections:true struct-name:TimeTwoWords no-init:true parser-type:StringC

type UnProcessed

type UnProcessed struct {
	Value string
}

no-sections:true is-multiple:true no-init:true no-parse:true

type UniqueIDFormat

type UniqueIDFormat struct {
	LogFormat string
	Comment   string
}

type UniqueIDHeader

type UniqueIDHeader struct {
	Name    string
	Comment string
}

type UnixBind

type UnixBind struct {
	Prefix  string
	Mode    string
	User    string
	UID     string
	Group   string
	GID     string
	Comment string
}

is-multiple:false

type UseBackend

type UseBackend struct {
	Name     string
	Cond     string
	CondTest string
	Comment  string
}

is-multiple:true

type UseServer

type UseServer struct {
	Name     string
	Cond     string
	CondTest string
	Comment  string
}

is-multiple:true no-parse:true

type User

type User struct {
	Name       string
	Password   string
	IsInsecure bool
	Groups     []string
	Comment    string
}

is-multiple:true

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL