From c32f82baeed4e6a7e909c3ce6cff668ba4a895a6 Mon Sep 17 00:00:00 2001 From: Vincent Demeester Date: Sun, 1 Nov 2015 19:15:05 +0100 Subject: [PATCH] Linting types package Signed-off-by: Vincent Demeester --- types/types.go | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/types/types.go b/types/types.go index 41cdea240..22abb8dd2 100644 --- a/types/types.go +++ b/types/types.go @@ -5,43 +5,43 @@ import ( "strings" ) -// Backend configuration +// Backend holds backend configuration. type Backend struct { Servers map[string]Server `json:"servers,omitempty"` CircuitBreaker *CircuitBreaker `json:"circuitBreaker,omitempty"` LoadBalancer *LoadBalancer `json:"loadBalancer,omitempty"` } -// LoadBalancer configuration +// LoadBalancer holds load balancing configuration. type LoadBalancer struct { Method string `json:"method,omitempty"` } -// CircuitBreaker configuration +// CircuitBreaker holds circuit breaker configuration. type CircuitBreaker struct { Expression string `json:"expression,omitempty"` } -// Server configuration +// Server holds server configuration. type Server struct { URL string `json:"url,omitempty"` Weight int `json:"weight,omitempty"` } -// Route configuration +// Route holds route configuration. type Route struct { Rule string `json:"rule,omitempty"` Value string `json:"value,omitempty"` } -// Frontend configuration +// Frontend holds frontend configuration. type Frontend struct { Backend string `json:"backend,omitempty"` Routes map[string]Route `json:"routes,omitempty"` PassHostHeader bool `json:"passHostHeader,omitempty"` } -// Load Balancer Method +// LoadBalancerMethod holds the method of load balancing to use. type LoadBalancerMethod uint8 const ( @@ -56,6 +56,7 @@ var loadBalancerMethodNames = []string{ "Drr", } +// NewLoadBalancerMethod create a new LoadBalancerMethod from a given LoadBalancer. func NewLoadBalancerMethod(loadBalancer *LoadBalancer) (LoadBalancerMethod, error) { if loadBalancer != nil { for i, name := range loadBalancerMethodNames { @@ -67,14 +68,16 @@ func NewLoadBalancerMethod(loadBalancer *LoadBalancer) (LoadBalancerMethod, erro return Wrr, ErrInvalidLoadBalancerMethod } +// ErrInvalidLoadBalancerMethod is thrown when the specified load balancing method is invalid. var ErrInvalidLoadBalancerMethod = errors.New("Invalid method, using default") -// Configuration of a provider +// Configuration of a provider. type Configuration struct { Backends map[string]*Backend `json:"backends,omitempty"` Frontends map[string]*Frontend `json:"frontends,omitempty"` } +// ConfigMessage hold configuration information exchanged between parts of traefik. type ConfigMessage struct { ProviderName string Configuration *Configuration