types

Documentation

Index

• Constants
• Variables
• type HTTPConfig
• type HTTPRoute
• type Port
  • func (p *Port) Parse(v string) (err error)
  • func (p *Port) String() string
• type Route
• type RouteType
• type Scheme
  • func (s Scheme) IsReverseProxy() bool
  • func (s Scheme) IsStream() bool
  • func (s Scheme) Validate() gperr.Error
• type StreamRoute

Constants

const (
	MinPort = 0
	MaxPort = 65535
)

Variables

var (
	ErrInvalidPortSyntax = gperr.New("invalid port syntax, expect [listening_port:]target_port")
	ErrPortOutOfRange    = gperr.New("port out of range")
)

var ErrInvalidScheme = gperr.New("invalid scheme")

Types

type HTTPConfig

type HTTPConfig struct {
	NoTLSVerify           bool          `json:"no_tls_verify,omitempty"`
	ResponseHeaderTimeout time.Duration `json:"response_header_timeout,omitempty"`
}

type HTTPRoute

type HTTPRoute interface {
	Route
	http.Handler
}

type Port

type Port struct {
	Listening int `json:"listening"`
	Proxy     int `json:"proxy"`
}

func (*Port) Parse

func (p *Port) Parse(v string) (err error)

Parse implements strutils.Parser.

func (*Port) String

func (p *Port) String() string

type Route

type Route interface {
	task.TaskStarter
	task.TaskFinisher
	ProviderName() string
	TargetName() string
	TargetURL() *net.URL
	HealthMonitor() health.HealthMonitor

	Started() bool

	IdlewatcherConfig() *idlewatcher.Config
	HealthCheckConfig() *health.HealthCheckConfig
	LoadBalanceConfig() *loadbalance.Config
	HomepageConfig() *homepage.ItemConfig
	HomepageItem() *homepage.Item
	ContainerInfo() *docker.Container

	Agent() *agent.AgentConfig

	IsDocker() bool
	IsAgent() bool
	UseLoadBalance() bool
	UseIdleWatcher() bool
	UseHealthCheck() bool
	UseAccessLog() bool
}

type RouteType

type RouteType string

const (
	RouteTypeStream RouteType = "stream"
	RouteTypeHTTP   RouteType = "http"
)

type Scheme

type Scheme string

const (
	SchemeHTTP       Scheme = "http"
	SchemeHTTPS      Scheme = "https"
	SchemeTCP        Scheme = "tcp"
	SchemeUDP        Scheme = "udp"
	SchemeFileServer Scheme = "fileserver"
)

func (Scheme) IsReverseProxy

func (s Scheme) IsReverseProxy() bool

func (Scheme) IsStream

func (s Scheme) IsStream() bool

func (Scheme) Validate

func (s Scheme) Validate() gperr.Error

type StreamRoute

type StreamRoute interface {
	Route
	net.Stream
}