cc52954a2a
This change makes the environment handling logic execute independent of the server itself and should make it much easier for people to contribute changes and additional environment handlers down the road without polluting the server object even more. There is still a lot of work to do on this front to make things easier to work with, and there are some questionable design decisions at play I'm sure. Welcome to additional modifications and cleanup to make this code easier to reason about and work with.
90 lines
3.3 KiB
Go
90 lines
3.3 KiB
Go
package environment
|
|
|
|
import (
|
|
"github.com/pterodactyl/wings/events"
|
|
"os"
|
|
)
|
|
|
|
const (
|
|
ConsoleOutputEvent = "console output"
|
|
StateChangeEvent = "state change"
|
|
)
|
|
|
|
// Defines the basic interface that all environments need to implement so that
|
|
// a server can be properly controlled.
|
|
type ProcessEnvironment interface {
|
|
// Returns the name of the environment.
|
|
Type() string
|
|
|
|
// Returns an event emitter instance that can be hooked into to listen for different
|
|
// events that are fired by the environment. This should not allow someone to publish
|
|
// events, only subscribe to them.
|
|
Events() *events.EventBus
|
|
|
|
// Determines if the server instance exists. For example, in a docker environment
|
|
// this should confirm that the container is created and in a bootable state. In
|
|
// a basic CLI environment this can probably just return true right away.
|
|
Exists() (bool, error)
|
|
|
|
// Determines if the environment is currently active and running a server process
|
|
// for this specific server instance.
|
|
IsRunning() (bool, error)
|
|
|
|
// Performs an update of server resource limits without actually stopping the server
|
|
// process. This only executes if the environment supports it, otherwise it is
|
|
// a no-op.
|
|
InSituUpdate() error
|
|
|
|
// Runs before the environment is started. If an error is returned starting will
|
|
// not occur, otherwise proceeds as normal.
|
|
OnBeforeStart() error
|
|
|
|
// Starts a server instance. If the server instance is not in a state where it
|
|
// can be started an error should be returned.
|
|
Start() error
|
|
|
|
// Stops a server instance. If the server is already stopped an error should
|
|
// not be returned.
|
|
Stop() error
|
|
|
|
// Restart a server instance. If already stopped the process will be started. This function
|
|
// will return an error if the server is already performing a restart process as to avoid
|
|
// unnecessary double/triple/quad looping issues if multiple people press restart or spam the
|
|
// button to restart.
|
|
Restart() error
|
|
|
|
// Waits for a server instance to stop gracefully. If the server is still detected
|
|
// as running after seconds, an error will be returned, or the server will be terminated
|
|
// depending on the value of the second argument.
|
|
WaitForStop(seconds int, terminate bool) error
|
|
|
|
// Terminates a running server instance using the provided signal. If the server
|
|
// is not running no error should be returned.
|
|
Terminate(signal os.Signal) error
|
|
|
|
// Destroys the environment removing any containers that were created (in Docker
|
|
// environments at least).
|
|
Destroy() error
|
|
|
|
// Returns the exit state of the process. The first result is the exit code, the second
|
|
// determines if the process was killed by the system OOM killer.
|
|
ExitState() (uint32, bool, error)
|
|
|
|
// Creates the necessary environment for running the server process. For example,
|
|
// in the Docker environment create will create a new container instance for the
|
|
// server.
|
|
Create() error
|
|
|
|
// Attaches to the server console environment and allows piping the output to a
|
|
// websocket or other internal tool to monitor output. Also allows you to later
|
|
// send data into the environment's stdin.
|
|
Attach() error
|
|
|
|
// Sends the provided command to the running server instance.
|
|
SendCommand(string) error
|
|
|
|
// Reads the log file for the process from the end backwards until the provided
|
|
// number of bytes is met.
|
|
Readlog(int64) ([]string, error)
|
|
}
|