Module inclusion - Revision history

Rcobb: /* Configuring a binary or combined binary & Tcl module into your server */

2008-04-16T19:36:11Z

Configuring a binary or combined binary & Tcl module into your server

Rcobb: /* Tcl Modules */

2008-04-16T19:33:47Z

Tcl Modules

Rcobb: /* Startup Functions & Version Constraints (Ns_ModuleInit and Ns_ModuleVersion) */

2008-04-16T19:29:00Z

Startup Functions & Version Constraints (Ns_ModuleInit and Ns_ModuleVersion)

Rcobb: /* Configuring a binary or combined binary & Tcl module into your server */

2008-04-16T19:28:23Z

Configuring a binary or combined binary & Tcl module into your server

Rcobb: Typo

2008-04-16T19:19:58Z

Typo

Rcobb: First draft. Needs comment & review.

2008-04-16T19:10:46Z

First draft. Needs comment & review.

Rcobb: New page: Typical AOLServer modules are written in either Tcl, C, or some combination of those languages (though, of course, new languages can be added via the C module interface). They are include...

2008-04-16T18:08:37Z

New page: Typical AOLServer modules are written in either Tcl, C, or some combination of those languages (though, of course, new languages can be added via the C module interface). They are include...

New page

Typical AOLServer modules are written in either Tcl, C, or some combination of those languages (though, of course, new languages can be added via the C module interface). They are included into your runtime using a section of the [[AOLServer Configuration]] file.
== Configuring a binary or combined binary & Tcl module into your server ==
As documented [[somewhere else in the wiki]], a binary module is a dynamically loadable library (.so or .dll) that will be linked into your server at startup. To get it linked in, you:
# Put the file in the right directory with an appropriate extension:
#* In the default configuration of AOLServer, the right place is usually {your installation directory}/bin (e.g., /usr/local/aolserver/lib). In the AOLServer configuration file, by convention, this directory name is written as "${bindir}". Some installations use a separate "${homedir}/lib" (thus ${libdir}) directory.
# Tell AOLServer it's there, and that you want to use it for your virtual server.
#* In the modules section associated with your virtual server (e.g., "ns/server/${servername}/modules" in nsd.tcl), add the library using the syntax:
#*:<code>ns_param ''configurationSectionName'' ''locationOfDynamicLibrary''</code>
#: For example:
#:<pre><nowiki>
ns_param nsopenssl "${bindir}/nsopenssl.so"
</nowiki></pre>
# Restart your server. You should see a line that looks like
<pre><nowiki>
[15/Apr/2008:15:39:35][31632.18446744071924766624][-main-] Notice: modload: loading '/usr/local/aolserver/bin/nsopenssl.so'
</nowiki></pre>

@@ Line 1: / Line 1: @@
 Typical AOLServer modules are written in either Tcl, C, or some combination of those languages (though, of course, new languages can be added via the C module interface).  They are included into your runtime using a section of the [[AOLServer Configuration]] file.
 == Configuring a binary or combined binary & Tcl module into your server ==
-As documented [http://aolserver.com/docs/devel/c/ in the AOLServer C Developer's Guide], a binary module is a dynamically loadable library (.so or .dll) that will be linked into the server at startup (by the fact that it provides an external function called "Ns_ModuleInit" and an external integer called "Ns_Version").  To get AOLServer to try to link it in:
+As documented [http://aolserver.com/docs/devel/c/ in the AOLServer C Developer's Guide], a binary module is a dynamically loadable library (.so or .dll) that will be linked into the server at startup.  To get AOLServer to try to link it in:
 # Put the file in the right directory:
 #* In the default configuration of AOLServer, the right place is usually {your installation directory}/bin (e.g., /usr/local/aolserver/lib).  In the AOLServer configuration file, by convention, this directory name is written as "${bindir}".  Some installations use a separate "${homedir}/lib" (thus ${libdir}) directory.

@@ Line 55: / Line 55: @@
 The syntax for loading pure-Tcl library modules is:
-#*:<code>ns_param ''moduleName'' '''Tcl'''</code>
+:<code>ns_param ''moduleName'' '''Tcl'''</code>
-#: For example:
+For example:
-#:<pre><nowiki>ns_param nssession Tcl</nowiki></pre>
+:<pre><nowiki>ns_param nssession Tcl</nowiki></pre>
 [[Category:Documentation]]

@@ Line 29: / Line 29: @@
 extern "C"
+{
-NS_EXPORT int
+    NS_EXPORT int
-Foo_ModInit(char* server, char* module)
+    Foo_ModInit(char* server, char* module)
-−
+    {
-...
+        ...
+}
 </nowiki></pre>

@@ Line 1: / Line 1: @@
 Typical AOLServer modules are written in either Tcl, C, or some combination of those languages (though, of course, new languages can be added via the C module interface).  They are included into your runtime using a section of the [[AOLServer Configuration]] file.
 == Configuring a binary or combined binary & Tcl module into your server ==
-As documented [[somewhere else in the wiki]], a binary module is a dynamically loadable library (.so or .dll) that will be linked into the server at startup (by the fact that it provides an external function called "Ns_ModuleInit" and an external integer called "Ns_Version").  To get AOLServer to try to link it in:
+As documented [http://aolserver.com/docs/devel/c/ in the AOLServer C Developer's Guide], a binary module is a dynamically loadable library (.so or .dll) that will be linked into the server at startup (by the fact that it provides an external function called "Ns_ModuleInit" and an external integer called "Ns_Version").  To get AOLServer to try to link it in:
 # Put the file in the right directory:
 #* In the default configuration of AOLServer, the right place is usually {your installation directory}/bin (e.g., /usr/local/aolserver/lib).  In the AOLServer configuration file, by convention, this directory name is written as "${bindir}".  Some installations use a separate "${homedir}/lib" (thus ${libdir}) directory.
@@ Line 40: / Line 40: @@
 MODINIT = Foo_ModInit
 </pre>
 == Tcl Modules ==
 Developing Tcl modules for use with AOLServer is just as straightforward, but have some interesting additional features: a Tcl library really can be installed only into the Tcl interpreters for a specific virtual server, and they can usually be reloaded dynamically.

@@ Line 6: / Line 6: @@
 #* (In AOLServer 3.x and below, the convention for the extension for dynamic libraries was to follow the convention of the host operating system; e.g., for Linux/Unix to use ".so" and for Windows to use ".dll". In AOLServer 4.0 and above, we just use ".so" for all dynamic libraries to simplify the configuration and packaging).
 # Tell AOLServer that it should provide that module to the virtual servers you're configuring.
-#* In the modules section associated with your virtual server (e.g., "ns/server/${servername}/modules" in nsd.tcl), add the library using the syntax:
+#* In the modules section associated with your virtual server (e.g., "ns/servers/${servername}/modules" in nsd.tcl), add the library using the syntax:
 #*:<code>ns_param   ''moduleName'' ''locationOfDynamicLibrary?(startupFunction)?''</code>
 #: For example:
@@ Line 12: / Line 12: @@
 # Restart your server. You should see a line that looks like
 #:<pre><nowiki>[15/Apr/2008:15:39:35][31632.18446744071924766624][-main-] Notice: modload: loading '/usr/local/aolserver/bin/nsopenssl.so'</nowiki></pre>
-Each module included into a virtual server has its own configuration ''ns_section'' in the configuration script.  By convention, these sections are named "ns/server/{servername}/module/{moduleName}", where the moduleName is taken from the ns_param used to include the library in the "modules" section.  Modules usually provide some guidance about how to write this section, perhaps by providing their own "nsd.tcl" files in the module directory.
+Each module included into a virtual server has its own configuration ''ns_section'' in the configuration script.  By convention, these sections are named "ns/servers/{servername}/module/{moduleName}", where the moduleName is taken from the ns_param used to include the library in the "modules" section.  Modules usually provide some guidance about how to write this section, perhaps by providing their own "nsd.tcl" files in the module directory.
 The library, of course, is only dynamically linked into the AOLServer executable ''once'' (that is the nature of dynamic linking in most operating systems). It is ''initialized'' (that is, its initialization function is called) once per virtual server it is configured into.  There is no mechanism for removing a dynamically loaded module once loaded; the server must be restarted to remove that context.