routes

Documentation

Index

• Variables
• func ByAlias(typeFilter ...route.RouteType) map[string]Route
• func Clear()
• func HealthInfo() map[string]*HealthInfoRaw
• func HealthMap() map[string]map[string]string
• func HomepageCategories() []string
• func HomepageConfig(categoryFilter, providerFilter string) homepage.Homepage
• func Iter(yield func(alias string, r Route) bool)
• func NumRoutes() int
• type HTTPRoute
  • func GetHTTPRouteOrExact(alias, host string) (HTTPRoute, bool)
• type HealthInfoRaw
  • func (info *HealthInfoRaw) MarshalJSON() ([]byte, error)
  • func (info *HealthInfoRaw) UnmarshalJSON(data []byte) error
• type ReverseProxyRoute
• type Route
  • func Get(alias string) (Route, bool)
• type StreamRoute

Variables

var (
	HTTP   = pool.New[HTTPRoute]("http_routes")
	Stream = pool.New[StreamRoute]("stream_routes")
)

Functions

func ByAlias

func ByAlias(typeFilter ...route.RouteType) map[string]Route

func Clear

func Clear()

func HealthInfo

func HealthInfo() map[string]*HealthInfoRaw

func HealthMap

func HealthMap() map[string]map[string]string

func HomepageCategories

func HomepageCategories() []string

func HomepageConfig

func HomepageConfig(categoryFilter, providerFilter string) homepage.Homepage

func Iter

func Iter(yield func(alias string, r Route) bool)

func NumRoutes

func NumRoutes() int

Types

type HTTPRoute

type HTTPRoute interface {
	Route
	http.Handler
}

func GetHTTPRouteOrExact

func GetHTTPRouteOrExact(alias, host string) (HTTPRoute, bool)

type HealthInfoRaw

type HealthInfoRaw struct {
	Status  health.Status `json:"status"`
	Latency time.Duration `json:"latency"`
}

func (*HealthInfoRaw) MarshalJSON

func (info *HealthInfoRaw) MarshalJSON() ([]byte, error)

func (*HealthInfoRaw) UnmarshalJSON

func (info *HealthInfoRaw) UnmarshalJSON(data []byte) error

type ReverseProxyRoute

type ReverseProxyRoute interface {
	HTTPRoute
	ReverseProxy() *reverseproxy.ReverseProxy
}

type Route

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

	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
}

func Get

func Get(alias string) (Route, bool)

type StreamRoute

type StreamRoute interface {
	Route
	net.Stream
}