mirrors/etherpad-lite
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2025-05-05 14:47:12 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 52

added some comments to the server setup to explain what additionalSetup does and why

Browse source
This commit is contained in:
calcnerd256 2012-01-30 10:47:06 -06:00
parent 2fd4789013
commit 23d6369746
1 changed files with 12 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

15
node/server.js
View file

@ -68,8 +68,14 @@ exports.maxAge = 1000*60*60*6;
log4js.setGlobalLogLevel(settings.loglevel);
function init(additionalSetup){
if("function" != typeof additionalSetup) additionalSetup = function(){};
async.waterfall([
//additionalSetup is an optional argument that must be a function
//the purpose of additionalSetup is
//to allow whoever initializes the server to add functionality
//before the server begins listening
if("function" != typeof additionalSetup)
//the default value for initialSetup is a no-op
additionalSetup = function additionalSetup(app, db, managers, handlers){};
async.waterfall([
//initalize the database
function (callback)
{
@ -414,10 +420,13 @@ async.waterfall([
});
});
//additionalSetup is a hook for modifying the app before it begins listening
//some things such a hook might need are the app itself, the database, and any managers and handlers it might want to use
//rather than passing the managers and handlers one by one, each of those collections is passed as a dictionary
additionalSetup(
app, db,
{
ro: readOnlyManager,
"ro": readOnlyManager,
pad: padManager,
security: securityManager
},