FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
caddy/controller.go at PreferChaChaIfFirst · elcore/caddy · GitHub
elcore
caddy
Repository navigation
Code
Pull requests
Actions
Projects
Wiki
Security and quality
Insights
Expand file tree
Breadcrumbs
caddy
/
controller.go
Copy path
More file actions
More file actions
Latest commit
History
History
History
111 lines (93 loc) · 3.79 KB
Breadcrumbs
caddy
/
controller.go
Copy path
File metadata and controls
111 lines (93 loc) · 3.79 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
package
caddy
import
(
"strings"
"github.com/mholt/caddy/caddyfile"
)
// Controller is given to the setup function of directives which
// gives them access to be able to read tokens with which to
// configure themselves. It also stores state for the setup
// functions, can get the current context, and can be used to
// identify a particular server block using the Key field.
type
Controller
struct
{
caddyfile.
Dispenser
// The instance in which the setup is occurring
instance
*
Instance
// Key is the key from the top of the server block, usually
// an address, hostname, or identifier of some sort.
Key
string
// OncePerServerBlock is a function that executes f
// exactly once per server block, no matter how many
// hosts are associated with it. If it is the first
// time, the function f is executed immediately
// (not deferred) and may return an error which is
// returned by OncePerServerBlock.
OncePerServerBlock
func
(
f
func
()
error
)
error
// ServerBlockIndex is the 0-based index of the
// server block as it appeared in the input.
ServerBlockIndex
int
// ServerBlockKeyIndex is the 0-based index of this
// key as it appeared in the input at the head of the
// server block.
ServerBlockKeyIndex
int
// ServerBlockKeys is a list of keys that are
// associated with this server block. All these
// keys, consequently, share the same tokens.
ServerBlockKeys
[]
string
// ServerBlockStorage is used by a directive's
// setup function to persist state between all
// the keys on a server block.
ServerBlockStorage
interface
{}
}
// ServerType gets the name of the server type that is being set up.
func
(
c
*
Controller
)
ServerType
()
string
{
return
c
.
instance
.
serverType
}
// OnFirstStartup adds fn to the list of callback functions to execute
// when the server is about to be started NOT as part of a restart.
func
(
c
*
Controller
)
OnFirstStartup
(
fn
func
()
error
) {
c
.
instance
.
onFirstStartup
=
append
(
c
.
instance
.
onFirstStartup
,
fn
)
}
// OnStartup adds fn to the list of callback functions to execute
// when the server is about to be started (including restarts).
func
(
c
*
Controller
)
OnStartup
(
fn
func
()
error
) {
c
.
instance
.
onStartup
=
append
(
c
.
instance
.
onStartup
,
fn
)
}
// OnRestart adds fn to the list of callback functions to execute
// when the server is about to be restarted.
func
(
c
*
Controller
)
OnRestart
(
fn
func
()
error
) {
c
.
instance
.
onRestart
=
append
(
c
.
instance
.
onRestart
,
fn
)
}
// OnShutdown adds fn to the list of callback functions to execute
// when the server is about to be shut down (including restarts).
func
(
c
*
Controller
)
OnShutdown
(
fn
func
()
error
) {
c
.
instance
.
onShutdown
=
append
(
c
.
instance
.
onShutdown
,
fn
)
}
// OnFinalShutdown adds fn to the list of callback functions to execute
// when the server is about to be shut down NOT as part of a restart.
func
(
c
*
Controller
)
OnFinalShutdown
(
fn
func
()
error
) {
c
.
instance
.
onFinalShutdown
=
append
(
c
.
instance
.
onFinalShutdown
,
fn
)
}
// Context gets the context associated with the instance associated with c.
func
(
c
*
Controller
)
Context
()
Context
{
return
c
.
instance
.
context
}
// NewTestController creates a new Controller for
// the server type and input specified. The filename
// is "Testfile". If the server type is not empty and
// is plugged in, a context will be created so that
// the results of setup functions can be checked for
// correctness.
//
// Used only for testing, but exported so plugins can
// use this for convenience.
func
NewTestController
(
serverType
,
input
string
)
*
Controller
{
var
ctx
Context
if
stype
,
err
:=
getServerType
(
serverType
);
err
==
nil
{
ctx
=
stype
.
NewContext
()
}
return
&
Controller
{
instance
:
&
Instance
{
serverType
:
serverType
,
context
:
ctx
},
Dispenser
:
caddyfile
.
NewDispenser
(
"Testfile"
,
strings
.
NewReader
(
input
)),
OncePerServerBlock
:
func
(
f
func
()
error
)
error
{
return
f
() },
}
}
Back
|
FazBrowse Home
|
New Git URL