File: options.go

package info (click to toggle)
golang-github-vulcand-oxy 2.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 728 kB
  • sloc: makefile: 14
file content (119 lines) | stat: -rw-r--r-- 3,058 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
package cbreaker

import (
	"net/http"
	"time"

	"github.com/vulcand/oxy/v2/utils"
)

// Option represents an option you can pass to New.
type Option func(*CircuitBreaker) error

// Logger defines the logger used by CircuitBreaker.
func Logger(l utils.Logger) Option {
	return func(c *CircuitBreaker) error {
		c.log = l
		return nil
	}
}

// Verbose additional debug information.
func Verbose(verbose bool) Option {
	return func(c *CircuitBreaker) error {
		c.verbose = verbose
		return nil
	}
}

// FallbackDuration is how long the CircuitBreaker will remain in the Tripped
// state before trying to recover.
func FallbackDuration(d time.Duration) Option {
	return func(c *CircuitBreaker) error {
		c.fallbackDuration = d
		return nil
	}
}

// RecoveryDuration is how long the CircuitBreaker will take to ramp up
// requests during the Recovering state.
func RecoveryDuration(d time.Duration) Option {
	return func(c *CircuitBreaker) error {
		c.recoveryDuration = d
		return nil
	}
}

// CheckPeriod is how long the CircuitBreaker will wait between successive
// checks of the breaker condition.
func CheckPeriod(d time.Duration) Option {
	return func(c *CircuitBreaker) error {
		c.checkPeriod = d
		return nil
	}
}

// OnTripped sets a SideEffect to run when entering the Tripped state.
// Only one SideEffect can be set for this hook.
func OnTripped(s SideEffect) Option {
	return func(c *CircuitBreaker) error {
		c.onTripped = s
		return nil
	}
}

// OnStandby sets a SideEffect to run when entering the Standby state.
// Only one SideEffect can be set for this hook.
func OnStandby(s SideEffect) Option {
	return func(c *CircuitBreaker) error {
		c.onStandby = s
		return nil
	}
}

// Fallback defines the http.Handler that the CircuitBreaker should route
// requests to when it prevents a request from taking its normal path.
func Fallback(h http.Handler) Option {
	return func(c *CircuitBreaker) error {
		c.fallback = h
		return nil
	}
}

// ResponseFallbackOption represents an option you can pass to NewResponseFallback.
type ResponseFallbackOption func(*ResponseFallback) error

// ResponseFallbackLogger defines the logger used by ResponseFallback.
func ResponseFallbackLogger(l utils.Logger) ResponseFallbackOption {
	return func(c *ResponseFallback) error {
		c.log = l
		return nil
	}
}

// ResponseFallbackDebug additional debug information.
func ResponseFallbackDebug(debug bool) ResponseFallbackOption {
	return func(c *ResponseFallback) error {
		c.debug = debug
		return nil
	}
}

// RedirectFallbackOption represents an option you can pass to NewRedirectFallback.
type RedirectFallbackOption func(*RedirectFallback) error

// RedirectFallbackLogger defines the logger used by ResponseFallback.
func RedirectFallbackLogger(l utils.Logger) RedirectFallbackOption {
	return func(c *RedirectFallback) error {
		c.log = l
		return nil
	}
}

// RedirectFallbackDebug additional debug information.
func RedirectFallbackDebug(debug bool) RedirectFallbackOption {
	return func(c *RedirectFallback) error {
		c.debug = debug
		return nil
	}
}