README
¶
Server API Documentation
/*
Relative API Path:
api/server/status
Request:
N/A
Response(200, 405):
"0" - OFF,
"1" - ON,
"2" - "MAINTENANCE",
"3" - "RESTARTING"
*/
func Status(res http.ResponseWriter, req *http.Request) bool {}
/*
Relative API Path:
api/server/start
Request:
N/A
Response(204, 405, 409):
N/A
*/
func Start(res http.ResponseWriter, req *http.Request) bool {}
/*
Relative API Path:
api/server/shutdown
Request:
{
"graceful": boolean
}
Response(204, 404, 405):
N/A
*/
func Shutdown(res http.ResponseWriter, req *http.Request) bool {}
/*
Relative API Path:
api/server/restart
Request:
{
"graceful": boolean
}
Response(204, 404, 405):
N/A
*/
func Restart(res http.ResponseWriter, req *http.Request) bool {}
/*
Relative API Path:
api/server/maintenance
Request:
N/A
Response(204, 405):
N/A
*/
func Maintenance(res http.ResponseWriter, req *http.Request) bool {}
Documentation
¶
Overview ¶
Package server is a child of package api to handle api calls concerning the server
Package server is a child of package api to handle api calls concerning the server ¶
Package server is a child of package api to handle api calls concerning the server ¶
Package server is a child of package api to handle api calls concerning the server ¶
Package server is a child of package api to handle api calls concerning the server
Index ¶
- func Maintenance(res http.ResponseWriter, req *http.Request, publicServer *public.Controller) bool
- func Restart(res http.ResponseWriter, req *http.Request, publicServer *public.Controller) bool
- func Shutdown(res http.ResponseWriter, req *http.Request, publicServer *public.Controller) bool
- func Start(res http.ResponseWriter, req *http.Request, publicServer *public.Controller) bool
- func Status(res http.ResponseWriter, req *http.Request, publicServer *public.Controller) bool
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Maintenance ¶
func Maintenance(res http.ResponseWriter, req *http.Request, publicServer *public.Controller) bool
Maintenance function is called from /api/server/maintenance and will place the public server into maintenance mode.
func Restart ¶
func Restart(res http.ResponseWriter, req *http.Request, publicServer *public.Controller) bool
Restart function is called from /api/server/restart and will attempt to shutdown, either gracefully or not gracefully (contingent on request data), and then turn back on the public server.
func Shutdown ¶
func Shutdown(res http.ResponseWriter, req *http.Request, publicServer *public.Controller) bool
Shutdown function is called from /api/server/shutdown and will attempt to shutdown, either gracefully or not gracefully (contingent on request data).
func Start ¶
func Start(res http.ResponseWriter, req *http.Request, publicServer *public.Controller) bool
Start function is called from /api/server/start and turn the public server on.
func Status ¶
func Status(res http.ResponseWriter, req *http.Request, publicServer *public.Controller) bool
Status function is called from api/server/status and will return the current status of the public server.
Types ¶
This section is empty.
Source Files