aboutsummaryrefslogtreecommitdiff
path: root/src/Init.h
diff options
context:
space:
mode:
authorPaul Nettle <nettle.paul@gmail.com>2017-08-25 09:30:39 -0500
committerPaul Nettle <nettle.paul@gmail.com>2017-08-25 09:30:39 -0500
commit06f646aec4dbce64d28bae1be6111bd833f8e79e (patch)
treee98859f400af75fb43150c3d03bde83de9b77f79 /src/Init.h
downloadgobbledegook-06f646aec4dbce64d28bae1be6111bd833f8e79e.tar.gz
gobbledegook-06f646aec4dbce64d28bae1be6111bd833f8e79e.tar.bz2
gobbledegook-06f646aec4dbce64d28bae1be6111bd833f8e79e.zip
Initial version 1.0
Diffstat (limited to 'src/Init.h')
-rw-r--r--src/Init.h43
1 files changed, 43 insertions, 0 deletions
diff --git a/src/Init.h b/src/Init.h
new file mode 100644
index 0000000..cad7785
--- /dev/null
+++ b/src/Init.h
@@ -0,0 +1,43 @@
+// Copyright 2017 Paul Nettle.
+//
+// This file is part of Gobbledegook.
+//
+// Gobbledegook is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Gobbledegook is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Gobbledegook. If not, see <http://www.gnu.org/licenses/>.
+
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+//
+// >>
+// >>> INSIDE THIS FILE
+// >>
+//
+// Herein lies the code that manages the full initialization (including the running) of the server
+//
+// >>
+// >>> DISCUSSION
+// >>
+//
+// See the discussion at the top of Init.cpp
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+#pragma once
+
+// Trigger a graceful, asynchronous shutdown of the server
+//
+// This method is non-blocking and as such, will only trigger the shutdown process but not wait for it
+void shutdown();
+
+// Entry point for the asynchronous server thread
+//
+// This method should not be called directly, instead, direct your attention over to `ggkStart()`
+void runServerThread();