HTTP server API changes for improved extensibility (#684)

* refactored `HttpServer` so all subclass member functions are proctected, to make it easier to extend base functionality
* added API service, can be used to enumerate registered endpoints (at `/api`). Currently only very basic information is provided

7 files changed, 50 insertions, 50 deletions

diff --git a/src/zenhttp/servers/httpasio.cpp b/src/zenhttp/servers/httpasio.cpp
index 3970dea12..12aee1ee0 100644
--- a/src/zenhttp/servers/httpasio.cpp
+++ b/src/zenhttp/servers/httpasio.cpp
@@ -1298,11 +1298,11 @@ public:
 	HttpAsioServer(const AsioConfig& Config);
 	~HttpAsioServer();
 
-	virtual void RegisterService(HttpService& Service) override;
-	virtual int	 Initialize(int BasePort, std::filesystem::path DataDir) override;
-	virtual void Run(bool IsInteractiveSession) override;
-	virtual void RequestExit() override;
-	virtual void Close() override;
+	virtual void OnRegisterService(HttpService& Service) override;
+	virtual int	 OnInitialize(int BasePort, std::filesystem::path DataDir) override;
+	virtual void OnRun(bool IsInteractiveSession) override;
+	virtual void OnRequestExit() override;
+	virtual void OnClose() override;
 
 private:
 	Event			 m_ShutdownEvent;
@@ -1328,7 +1328,7 @@ HttpAsioServer::~HttpAsioServer()
 }
 
 void
-HttpAsioServer::Close()
+HttpAsioServer::OnClose()
 {
 	try
 	{
@@ -1342,13 +1342,13 @@ HttpAsioServer::Close()
 }
 
 void
-HttpAsioServer::RegisterService(HttpService& Service)
+HttpAsioServer::OnRegisterService(HttpService& Service)
 {
 	m_Impl->RegisterService(Service.BaseUri(), Service);
 }
 
 int
-HttpAsioServer::Initialize(int BasePort, std::filesystem::path DataDir)
+HttpAsioServer::OnInitialize(int BasePort, std::filesystem::path DataDir)
 {
 	ZEN_TRACE_CPU("HttpAsioServer::Initialize");
 	m_Impl->Initialize(DataDir);
@@ -1372,7 +1372,7 @@ HttpAsioServer::Initialize(int BasePort, std::filesystem::path DataDir)
 }
 
 void
-HttpAsioServer::Run(bool IsInteractive)
+HttpAsioServer::OnRun(bool IsInteractive)
 {
 	const bool TestMode = !IsInteractive;
 
@@ -1416,7 +1416,7 @@ HttpAsioServer::Run(bool IsInteractive)
 }
 
 void
-HttpAsioServer::RequestExit()
+HttpAsioServer::OnRequestExit()
 {
 	m_ShutdownEvent.Set();
 }
diff --git a/src/zenhttp/servers/httpmulti.cpp b/src/zenhttp/servers/httpmulti.cpp
index b8b7931a9..6541a1c48 100644
--- a/src/zenhttp/servers/httpmulti.cpp
+++ b/src/zenhttp/servers/httpmulti.cpp
@@ -20,7 +20,7 @@ HttpMultiServer::~HttpMultiServer()
 }
 
 void
-HttpMultiServer::RegisterService(HttpService& Service)
+HttpMultiServer::OnRegisterService(HttpService& Service)
 {
 	for (auto& Server : m_Servers)
 	{
@@ -29,7 +29,7 @@ HttpMultiServer::RegisterService(HttpService& Service)
 }
 
 int
-HttpMultiServer::Initialize(int BasePort, std::filesystem::path DataDir)
+HttpMultiServer::OnInitialize(int BasePort, std::filesystem::path DataDir)
 {
 	ZEN_TRACE_CPU("HttpMultiServer::Initialize");
 
@@ -54,7 +54,7 @@ HttpMultiServer::Initialize(int BasePort, std::filesystem::path DataDir)
 }
 
 void
-HttpMultiServer::Run(bool IsInteractiveSession)
+HttpMultiServer::OnRun(bool IsInteractiveSession)
 {
 	const bool TestMode = !IsInteractiveSession;
 
@@ -98,13 +98,13 @@ HttpMultiServer::Run(bool IsInteractiveSession)
 }
 
 void
-HttpMultiServer::RequestExit()
+HttpMultiServer::OnRequestExit()
 {
 	m_ShutdownEvent.Set();
 }
 
 void
-HttpMultiServer::Close()
+HttpMultiServer::OnClose()
 {
 	for (auto& Server : m_Servers)
 	{
diff --git a/src/zenhttp/servers/httpmulti.h b/src/zenhttp/servers/httpmulti.h
index 53cf57568..ae0ed74cf 100644
--- a/src/zenhttp/servers/httpmulti.h
+++ b/src/zenhttp/servers/httpmulti.h
@@ -15,11 +15,11 @@ public:
 	HttpMultiServer();
 	~HttpMultiServer();
 
-	virtual void RegisterService(HttpService& Service) override;
-	virtual int	 Initialize(int BasePort, std::filesystem::path DataDir) override;
-	virtual void Run(bool IsInteractiveSession) override;
-	virtual void RequestExit() override;
-	virtual void Close() override;
+	virtual void OnRegisterService(HttpService& Service) override;
+	virtual int	 OnInitialize(int BasePort, std::filesystem::path DataDir) override;
+	virtual void OnRun(bool IsInteractiveSession) override;
+	virtual void OnRequestExit() override;
+	virtual void OnClose() override;
 
 	void AddServer(Ref<HttpServer> Server);
 
diff --git a/src/zenhttp/servers/httpnull.cpp b/src/zenhttp/servers/httpnull.cpp
index 9ac1c61ce..06838a0ed 100644
--- a/src/zenhttp/servers/httpnull.cpp
+++ b/src/zenhttp/servers/httpnull.cpp
@@ -19,20 +19,20 @@ HttpNullServer::~HttpNullServer()
 }
 
 void
-HttpNullServer::RegisterService(HttpService& Service)
+HttpNullServer::OnRegisterService(HttpService& Service)
 {
 	ZEN_UNUSED(Service);
 }
 
 int
-HttpNullServer::Initialize(int BasePort, std::filesystem::path DataDir)
+HttpNullServer::OnInitialize(int BasePort, std::filesystem::path DataDir)
 {
 	ZEN_UNUSED(DataDir);
 	return BasePort;
 }
 
 void
-HttpNullServer::Run(bool IsInteractiveSession)
+HttpNullServer::OnRun(bool IsInteractiveSession)
 {
 	const bool TestMode = !IsInteractiveSession;
 
@@ -76,13 +76,13 @@ HttpNullServer::Run(bool IsInteractiveSession)
 }
 
 void
-HttpNullServer::RequestExit()
+HttpNullServer::OnRequestExit()
 {
 	m_ShutdownEvent.Set();
 }
 
 void
-HttpNullServer::Close()
+HttpNullServer::OnClose()
 {
 }
 
diff --git a/src/zenhttp/servers/httpnull.h b/src/zenhttp/servers/httpnull.h
index 818020604..ce7230938 100644
--- a/src/zenhttp/servers/httpnull.h
+++ b/src/zenhttp/servers/httpnull.h
@@ -17,11 +17,11 @@ public:
 	HttpNullServer();
 	~HttpNullServer();
 
-	virtual void RegisterService(HttpService& Service) override;
-	virtual int	 Initialize(int BasePort, std::filesystem::path DataDir) override;
-	virtual void Run(bool IsInteractiveSession) override;
-	virtual void RequestExit() override;
-	virtual void Close() override;
+	virtual void OnRegisterService(HttpService& Service) override;
+	virtual int	 OnInitialize(int BasePort, std::filesystem::path DataDir) override;
+	virtual void OnRun(bool IsInteractiveSession) override;
+	virtual void OnRequestExit() override;
+	virtual void OnClose() override;
 
 private:
 	Event m_ShutdownEvent;
diff --git a/src/zenhttp/servers/httpplugin.cpp b/src/zenhttp/servers/httpplugin.cpp
index d6ca7e1c5..426e62179 100644
--- a/src/zenhttp/servers/httpplugin.cpp
+++ b/src/zenhttp/servers/httpplugin.cpp
@@ -95,11 +95,11 @@ struct HttpPluginServerImpl : public HttpPluginServer, TransportServer
 
 	// HttpPluginServer
 
-	virtual void RegisterService(HttpService& Service) override;
-	virtual int	 Initialize(int BasePort, std::filesystem::path DataDir) override;
-	virtual void Run(bool IsInteractiveSession) override;
-	virtual void RequestExit() override;
-	virtual void Close() override;
+	virtual void OnRegisterService(HttpService& Service) override;
+	virtual int	 OnInitialize(int BasePort, std::filesystem::path DataDir) override;
+	virtual void OnRun(bool IsInteractiveSession) override;
+	virtual void OnRequestExit() override;
+	virtual void OnClose() override;
 
 	virtual void AddPlugin(Ref<TransportPlugin> Plugin) override;
 	virtual void RemovePlugin(Ref<TransportPlugin> Plugin) override;
@@ -706,7 +706,7 @@ HttpPluginServerImpl::CreateConnectionHandler(TransportConnection* Connection)
 }
 
 int
-HttpPluginServerImpl::Initialize(int BasePort, std::filesystem::path DataDir)
+HttpPluginServerImpl::OnInitialize(int BasePort, std::filesystem::path DataDir)
 {
 	ZEN_TRACE_CPU("HttpPluginServerImpl::Initialize");
 
@@ -740,7 +740,7 @@ HttpPluginServerImpl::Initialize(int BasePort, std::filesystem::path DataDir)
 }
 
 void
-HttpPluginServerImpl::Close()
+HttpPluginServerImpl::OnClose()
 {
 	if (!m_IsInitialized)
 		return;
@@ -776,7 +776,7 @@ HttpPluginServerImpl::Close()
 }
 
 void
-HttpPluginServerImpl::Run(bool IsInteractive)
+HttpPluginServerImpl::OnRun(bool IsInteractive)
 {
 	ZEN_MEMSCOPE(GetHttppluginTag());
 
@@ -822,7 +822,7 @@ HttpPluginServerImpl::Run(bool IsInteractive)
 }
 
 void
-HttpPluginServerImpl::RequestExit()
+HttpPluginServerImpl::OnRequestExit()
 {
 	m_ShutdownEvent.Set();
 }
@@ -850,7 +850,7 @@ HttpPluginServerImpl::RemovePlugin(Ref<TransportPlugin> Plugin)
 }
 
 void
-HttpPluginServerImpl::RegisterService(HttpService& Service)
+HttpPluginServerImpl::OnRegisterService(HttpService& Service)
 {
 	ZEN_MEMSCOPE(GetHttppluginTag());
 
diff --git a/src/zenhttp/servers/httpsys.cpp b/src/zenhttp/servers/httpsys.cpp
index 9dbdd7167..7b02f95f1 100644
--- a/src/zenhttp/servers/httpsys.cpp
+++ b/src/zenhttp/servers/httpsys.cpp
@@ -54,11 +54,11 @@ public:
 
 	// HttpServer interface implementation
 
-	virtual int	 Initialize(int BasePort, std::filesystem::path DataDir) override;
-	virtual void Run(bool TestMode) override;
-	virtual void RequestExit() override;
-	virtual void RegisterService(HttpService& Service) override;
-	virtual void Close() override;
+	virtual int	 OnInitialize(int BasePort, std::filesystem::path DataDir) override;
+	virtual void OnRun(bool TestMode) override;
+	virtual void OnRequestExit() override;
+	virtual void OnRegisterService(HttpService& Service) override;
+	virtual void OnClose() override;
 
 	WorkerThreadPool& WorkPool();
 
@@ -984,7 +984,7 @@ HttpSysServer::~HttpSysServer()
 }
 
 void
-HttpSysServer::Close()
+HttpSysServer::OnClose()
 {
 	if (m_IsHttpInitialized)
 	{
@@ -1292,7 +1292,7 @@ HttpSysServer::StartServer()
 }
 
 void
-HttpSysServer::Run(bool IsInteractive)
+HttpSysServer::OnRun(bool IsInteractive)
 {
 	if (IsInteractive)
 	{
@@ -2097,7 +2097,7 @@ InitialRequestHandler::HandleCompletion(ULONG IoResult, ULONG_PTR NumberOfBytesT
 //
 
 int
-HttpSysServer::Initialize(int BasePort, std::filesystem::path DataDir)
+HttpSysServer::OnInitialize(int BasePort, std::filesystem::path DataDir)
 {
 	ZEN_TRACE_CPU("HttpSysServer::Initialize");
 
@@ -2115,13 +2115,13 @@ HttpSysServer::Initialize(int BasePort, std::filesystem::path DataDir)
 }
 
 void
-HttpSysServer::RequestExit()
+HttpSysServer::OnRequestExit()
 {
 	m_ShutdownEvent.Set();
 }
 
 void
-HttpSysServer::RegisterService(HttpService& Service)
+HttpSysServer::OnRegisterService(HttpService& Service)
 {
 	RegisterService(Service.BaseUri(), Service);
 }