HTTPD Library - Revision history

Elverion: /* Creating a HTTPD instance */

2016-10-18T01:46:15Z

‎Creating a HTTPD instance

Elverion: /* Routes */

2016-09-09T04:35:04Z

‎Routes

Elverion: /* Supported Methods */

2016-09-09T04:34:21Z

‎Supported Methods

Elverion: /* Routes */

2016-09-09T04:34:03Z

‎Routes

Elverion at 04:32, 9 September 2016

2016-09-09T04:32:31Z

Elverion: Created page with "= Creating a cache instance = '''object Httpd()''' '''object Httpd(table config)''' The HTTPD library is optional and the module must be required before use. Next, the Httpd..."

2016-09-08T17:10:53Z

Created page with "= Creating a cache instance = '''object Httpd()''' '''object Httpd(table config)''' The HTTPD library is optional and the module must be required before use. Next, the Httpd..."

New page

= Creating a cache instance =
'''object Httpd()'''

'''object Httpd(table config)'''

The HTTPD library is optional and the module must be required before use. Next, the Httpd class must be instantiated:
<source lang="lua">
require('httpd/httpd');

httpd = Httpd();
</source>

Optionally, you may provide config parameters:
<source lang="lua">
httpd = Httpd({
ip = '0.0.0.0', -- The IP to bind to; use 0.0.0.0 to accept any connection; default 127.0.0.1
port = 80, -- The port to bind to; default 8080
controllerDir = '/Controllers/', -- Folder to look for controller objects; default /Controllers/
viewDir = '/Views/', -- Folder to look for view files & templates; default /Views/
staticDir = '/Static/', -- Folder to look for static files (images, css, javascript, etc.); default /Static/
)};
</source>

← Older revision		Revision as of 04:35, 9 September 2016
Line 41:		Line 41:

	=Routes=		=Routes=
−	When initiated, the ~~HTTPD~~ expects to be able to load a routes.lua file which is located in the same directory as your calling script(probably main.lua). This routes file should contain calls to the Route object; this object is instantiated for you automatically when you load the HTTPD library. In this file, you will tell the Route object to mount various controllers to URIs via the Route:controller() function.	+	When initiated, the Httpd expects to be able to load a routes.lua file which is located in the same directory as your calling script(probably main.lua). This routes file should contain calls to the Route object; this object is instantiated for you automatically when you load the HTTPD library. In this file, you will tell the Route object to mount various controllers to URIs via the Route:controller() function.

@@ Line 45: / Line 45: @@
 ==Supported Methods==
-'''Route:controller(uriSegment, controllerName)'''
+'''Route:controller(string uriSegment, string controllerName)'''
 This function maps the first URI segment of a URL to a specific controller, which must be the exact name of the controller class.

@@ Line 43: / Line 43: @@
 When initiated, the HTTPD expects to be able to load a routes.lua file which is located in the same directory as your calling script(probably main.lua). This routes file should contain calls to the Route object; this object is instantiated for you automatically when you load the HTTPD library. In this file, you will tell the Route object to mount various controllers to URIs via the Route:controller() function.
 '''Route:controller(uriSegment, controllerName)'''
 This function maps the first URI segment of a URL to a specific controller, which must be the exact name of the controller class.
 For example:

@@ Line 19: / Line 19: @@
     ip            = '0.0.0.0',        -- The IP to bind to; use 0.0.0.0 to accept any connection; default 127.0.0.1
     port          = 80,               -- The port to bind to; default 8080
-    controllerDir = '/Controllers/',  -- Folder to look for controller objects; default /Controllers/
+    controllerDir = './Controllers/',  -- Folder to look for controller objects; default /Controllers/
-    viewDir       = '/Views/',        -- Folder to look for view files & templates; default /Views/
+    viewDir       = './Views/',        -- Folder to look for view files & templates; default /Views/
-    staticDir     = '/Static/',       -- Folder to look for static files (images, css, javascript, etc.); default /Static/
+    staticDir     = './Static/',       -- Folder to look for static files (images, css, javascript, etc.); default /Static/
 )};
 </source>
 =Supported Methods=

@@ Line 1: / Line 1: @@
-= Creating a cache instance =
+For a step-by-step guide of setting up a simple website using this library, see [https://solarstrike.net/phpBB3/viewtopic.php?f=6&t=6367 this forum post].
 '''object Httpd()'''
@@ Line 10: / Line 12: @@
 httpd = Httpd();
 </source>
 Optionally, you may provide config parameters:
@@ Line 20: / Line 23: @@
     staticDir     = '/Static/',       -- Folder to look for static files (images, css, javascript, etc.); default /Static/
 )};
 </source>