AOLserver Wiki - User contributions [en]

Annotated AOLserver Configuration Reference

2009-02-09T09:54:36Z

Gustafn: added to fastpath options: directoryfile, directorylisting, directoryproc and directoryadp

'''[ Please make comments on the [[Talk:Annotated_AOLserver_Configuration_Reference]] page. ]'''

<pre>
#
# config-reference.tcl.txt --
#
# Annotated AOLserver Configuration Reference
#
# Nearly every AOLserver configuration variable is represented
# here. This file is provided as a reference -- please do not load
# this into your server.
#

#
# Global parameters
#
ns_section "ns/parameters"
ns_param home $home ;# Server's home directory

# Limits
ns_param listenbacklog 32 ;# Max length of pending conn queue
ns_param schedmaxelapsed 2 ;# Warn when waiting on really long procs
ns_param shutdowntimeout 20 ;# Secs to wait on shutdown if open conns

# Server logging
ns_param dev true ;# Display logging with "Dev" severity
ns_param debug false ;# Display logging with "Debug" severity
ns_param logexpanded false ;# true = double-spaced server.log
ns_param logroll false ;# Roll server.log every 24 hours.
ns_param maxbackup 10 ;# Max number of old server.log files
ns_param pidfile "nspid" ;# PID of server (named "nspid.PORT")
ns_param serverlog "server.log" ;# Filename of server.log

# DNS tuning
ns_param dnscache true ;# In-memory cache of DNS lookups
ns_param dnscachetimeout 60 ;# How long to keep hostnames in cache

# Miscellaneous
ns_param mailhost smtp.yourcompany.com ;# SMTP host for ns_sendmail

#
# Thread library (nsthread) parameters
#
ns_section "ns/threads"
ns_param mutexmeter true ;# measure lock contention
ns_param stacksize [expr 128*1024] ;# stack size per thread (in bytes)

#
# MIME types.
#
# Note: AOLserver already has an exhaustive list of MIME types, but in
# case something is missing you can add it here.
#
ns_section "ns/mimetypes"
ns_param ".xls" "application/vnd.ms-excel"
ns_param default "*/*" ;# MIME type for unknown extension
ns_param noextension "*/*" ;# MIME type for missing extension

############################################################
#
# Server-level configuration
#
# There is only one server in AOLserver, but this is helpful when multiple
# servers share the same configuration file. This file assumes that only
# one server is in use so it is set at the top.
#

ns_section "ns/servers"
ns_param $server $servername ;# Name of virtual server.

#
# Server parameters
#
ns_section "ns/server/${servername}"
ns_param directoryfile $directoryfile ;# List of files to use (index.html)
ns_param pageroot $pageroot ;# Directory under which all pages live

# Tuning options
ns_param connsperthread 0 ;# Normally there's one conn per thread
ns_param maxthreads 20 ;# Tune this to scale your server
ns_param minthreads 0 ;# Tune this to scale your server
ns_param threadtimeout 120 ;# Idle timeout for connection threads
ns_param maxconnections 100 ;# Max connections per connection thread before it is shut down
ns_param spread 20 ;# Variance factor for threadtimeout and maxconnections
;# to prevent mass mortality of theads (e.g. +-20%)

# Limits
ns_param maxline 8192 ;# Max line length from client

# Directory listings can be generated with an ADP or a Tcl proc.
ns_param directoryadp $home/dirlist.adp ;# Choose one or the other
ns_param directoryproc _ns_dirlist ;# ...but not both!
ns_param directorylisting simple ;# Can be simple or fancy (for ns_dirlist)

# Miscellaneous
ns_param checkmodifiedsince true ;# Check url if no If-Modified-Since?
ns_param enableaolpress false ;# Enable extra features used by AOLpress
ns_param headercase preserve ;# tolower, toupper, preserve

#
# Internal redirects
#
ns_section "ns/server/${servername}/redirects"
ns_param 404 "/notfound.html" ;# Not Found error page
ns_param 500 "/servererror.html" ;# Server Error page

#
# Fastpath serves HTML
#
ns_section "ns/server/${servername}/fastpath"
ns_param cache true ;# Enable cache for normal URLs; default: false
ns_param cachemaxentry 8192 ;# Largest file size allowable in cache; default: cachemaxsize/10
ns_param cachemaxsize [expr 5000*1024] ;# Size of fastpath cache; default: 5120000
ns_param mmap false ;# Use mmap() for cache; default: false
ns_param directoryfile index.adp,index.tcl,index.html,index.htm
;# String. Directory index/default page to look for.
;# Optional, default is directoryfile parameter set in
;# ns/server/${servername} section.
ns_param directorylisting fancy ;# Directory listing style.
;# Optional, can be "fancy" or "simple".
ns_param directoryproc _ns_dirlist ;# String. Name of Tcl proc to use to display
;# directory listings. Optional, default is to use
;# _ns_dirlist. You can either specify directoryproc,
;# or directoryadp - not both.
;#ns_param directoryadp dir.adp ;# String. Name of ADP page to use to display directory
;# listings. Optional. You can either specify directoryadp
;# or directoryproc - not both.

#
# Tcl interpreter
#
ns_section "ns/server/${servername}/tcl"
ns_param debug false ;# Names of files sourced is logged
ns_param nsvbuckets 8 ;# No. of buckets to hold nsv's
ns_param library "$home/servers/${servername}/modules/tcl" ;# Private tcl library for the server

#
# ADP (AOLserver Dynamic Page) configuration
#
ns_section "ns/server/${servername}/adp"

# ADP features
ns_param map "/*.adp" ;# Extensions to parse as ADP's
ns_param map "/*.html" ;# Any extension can be mapped
ns_param enableexpire true ;# Set "Expires: now" on all ADP's
ns_param enabledebug true ;# Turn on Tclpro debugging with "?debug"
ns_param debuginit "ns_adp_debuginit" ;# Debug procedure

# ADP tuning
ns_param cache true ;# In-memory cache of ADP's
ns_param cachesize [expr 5000*1024]

# ADP special pages
ns_param errorpage ${pageroot}/errorpage.adp ;# Pretty-print ADP errors with an ADP
ns_param startpage ${pageroot}/startpage.inc ;# Page to include for all ADP's

#
# ADP custom parsers -- see adp.c
#
ns_section "ns/server/${servername}/adp/parsers"
ns_param adp ".adp" ;# The simple parser looks for <\% ... \%>
ns_param fancy ".adp" ;# The fancy parser does a lot more.

#
# Socket driver module (HTTP) -- nssock
#
ns_section "ns/server/${servername}/module/nssock"
ns_param port $httpport ;# Port for HTTP (typically 80)
ns_param hostname $host ;# This is not the same as your hostname
ns_param address $address ;# This is not the same as your host addr
ns_param location "url" ;# URL for auto-redirects (trailing slash)
ns_param maxinput [expr 5 * 1024 * 1024] ;# Maximum file size for uploads in bytes, default is 1MB, new in AOLserver 4.01
ns_param keepwait 30 ;# Max time conn is kept alive (keepalive)
;# (set to 0 to disable keepalive)

#
# Socket driver module (HTTPS) -- nsssl
#
ns_section "ns/server/${servername}/module/nsssl"
ns_param port $httpsport ;# Port for HTTPS (typically 443)
ns_param hostname $host ;# This is not the same as your hostname
ns_param address $address ;# This is not the same as your host addr
ns_param keyfile ${home}/servers/${servername}/modules/nsssl/keyfile.pem
ns_param certfile ${home}/servers/${servername}/modules/nsssl/certfile.pem

#
# Control port -- nscp
#
ns_section "ns/server/${servername}/module/nscp"
ns_param port 9999 ;# Control port listens on port 9999
ns_param address "127.0.0.1" ;# For security, use 127.0.0.1 only

# Control port users
ns_section "ns/server/${servername}/module/nscp/users"
# The default password for nsadmin is "x". You should change it.
# type "ns_crypt newpassword salt" and put the encrypted string below.
ns_param user "nsadmin:t2GqvvaiIUbF2:" ;# sample user="nsadmin", pw="x".

#
# Access log -- nslog
#
ns_section "ns/server/${servername}/module/nslog"
ns_param file "access.log"
ns_param formattedtime true ;# true=common log format
ns_param logcombined false ;# true==NCSA combined format
ns_param maxbackup 5 ;# Max number to keep around when rolling
ns_param rollhour 0 ;# Time to roll log
ns_param rolllog true ;# Should we roll log?
ns_param rollonsignal true ;# Roll log on SIGHUP

#
# CGI interface -- nscgi
#
# Note: CGI is *vastly* inferior to ADP's or even built-in Tcl libraries.
#
ns_section "ns/server/${servername}/module/nscgi"
ns_param debug false ;# Be chatty in log
ns_param gethostbyaddr false ;# Whether to do reverse DNS lookups
ns_param limit 0 ;# Max number of concurrent CGI processes
ns_param maxoutput 10240 ;# Max bytes allowed from external process
ns_param buffersize 8192 ;# Buffer output from external process
ns_param map "GET /cgi /usr/local/cgi" ;# Where your CGI executables live (GET)
ns_param map "POST /cgi /usr/local/cgi" ;# Where your CGI executables live (POST)

# CGI environment variable handling -- See admin guide
ns_param systemenvironment false ;# Copies environment from nsd start shell

#
# Access control (permissions) -- nsperm
#
ns_section "ns/server/${servername}/module/nsperm"

#
# Unix domain socket driver -- nsunix
#
ns_section "ns/server/${servername}/module/nsunix"
ns_param hostname "host" ;# Hostname used in response to client
ns_param port "port" ;# Port to listen on
ns_param socketfile "path.name" ;# UNIX domain socket driver

#
# Virtual Hosting redirector -- nsvhr
#
ns_section "ns/server/${servername}/module/nsvhr"
ns_param busyurl "url" ;# Redirect here if back-end times out
ns_param errorurl "url" ;# Redirect here on proxy errors
ns_param method "GET" ;# Methods allowed to proxy
ns_param method "POST" ;# Methods allowed to proxy (can have >1)
ns_param timeout 30 ;# Timeout waiting for back-end

# Register hosts to proxy
ns_section "ns/server/${servername}/module/nsvhr/maps"
ns_param "www.tcpsocket.com" "http://127.0.0.0:2000" ;# HTTP proxy
ns_param "www.domainsocket.com" "unix://somehost" ;# Domain socket

#
# Database drivers
#
# Two pools are given here. Sybase uses the Sybase client libraries,
# obtained from Sybase. Postgres is freely available at
# www.postgresql.org. Sybase uses an external proxy daemon while
# Postgres uses an internal driver. The Sybase driver requires some
# configuration in ns/db/driver/sybase_driver to tell th "nsext.so"
# driver where to find the nssybpd executable and some other things.
# The Postgres driver doesn't need any of that because it's internal
# and does not use nsext.so.
#
ns_section "ns/db/drivers"
ns_param sybase_driver nsext.so ;# Use nsext.so for a proxy daemon
ns_param postgres_driver nspostgres.so ;# An internal driver

ns_section "ns/db/driver/sybase_driver"
ns_param localdaemon nssybpd ;# Name of the proxy daemon executable
ns_param param path_to_sybase ;# Usually the $SYBASE env var

ns_section "ns/db/pools"
ns_param sybase_pool "Sybase Pool"
ns_param postgres_pool "Postgres Pool"

ns_section "ns/db/pool/sybase_pool"
ns_param driver sybase_driver
ns_param datasource SERVER_NAME:database_name
ns_param user user_name
ns_param password password
ns_param connections 1
ns_param logsqlerrors true ;# Verbose SQL query error logging
ns_param verbose false ;# Verbose error logging
ns_param maxidle 600 ;# Max time to keep idle db conn open
ns_param maxopen 3600 ;# Max time to keep active db conn open

ns_section "ns/db/pool/postgres_pool"
ns_param driver postgres_driver
ns_param datasource HOSTNAME:PORT:database_name
ns_param user user_name
ns_param password password
ns_param connections 1
ns_param logsqlerrors true ;# Verbose SQL query error logging
ns_param verbose false ;# Verbose error logging
ns_param maxidle 600 ;# Max time to keep idle db conn open
ns_param maxopen 3600 ;# Max time to keep active db conn open

#
# Accessing DB pools
#
# In the case of virtual servers you can give different virtual
# servers access to different databases, or you can let them access
# them all. AOLserver 3.x does not use virtual servers so the only
# useful value is "*", but if you use one config file for multiple nsd
# processes, or you are using a version of AOLserver that supports
# virtual servers, then you should list the pools you want to access.
#
ns_section "ns/server/${servername}/db"
ns_param pools * ;# Wildcard gives access to all
ns_param defaultpool sybase_pool

#
# Modules to load
#
# Note: Only load the modules you are actually going to use.
#
ns_section "ns/server/${servername}/modules"
ns_param nssock nssock.so
ns_param nsssl nsssle.so
ns_param nscp nscp.so
ns_param nslog nslog.so
ns_param nscgi nscgi.so
ns_param nsperm nsperm.so

#
# Loading a Tcl module
#
# This example shows a Tcl module, called "tcl_module", has its code
# in the AOLserver Tcl library in either the modules/tcl/tcl_module
# directory or servers/servername/modules/tcl/tcl_module directory.
#
ns_param tcl_module tcl
</pre>

[[Category:Documentation]]
[[Category:Configuration]]

Thread-shared Variables

2009-02-09T08:45:11Z

Gustafn: fix category entries

The nsv commands provide a high performance data sharing mechanism. This facility is a more flexible alternative to the obsolete [[ns_share]] command. The model uses an array syntax and includes more features. In addition, lock contention is managed in a much more scalable way--something that is not possible with the obsolete [[ns_share]] facility.
* [[nsv_get]] - get key value
* [[nsv_exists]] - check key existence
* [[nsv_set]] - set key value
* [[nsv_append]] - append value
* [[nsv_lappend]] - append value as list element
* [[nsv_incr]] - increment and return value
* [[nsv_unset]] - unset a value
* [[nsv_array]] - manage nsv arrays
* [[nsv_names]] - list the nsvs in use

Commands for the most part mirror the corresponding Tcl command for ordinary variables. Basically, to set a value, simply use the nsv_set command:

nsv_set myarray foo $value

and to get a value, simply use the nsv_get command:

set value [nsv_get myarray foo]

What is the difference between nsv_set and nsv_array set? Is it exactly the same as the difference between set and array set?

'''Multithreading Features'''

One advantages of nsv is built in interlocking for thread safety. For example, consider a case of a "increment-by-one" unique id system. Here's the [[ns_share]] solution:

ns_share ids
set ids(lock) [ns_mutex create]
set ids(next) 0

proc nextid {} {
ns_share ids
ns_mutex lock $ids(lock)
set next [incr ids(next)]
ns_mutex unlock $ids(lock)
return $next
}

and here's an nsv solution:

nsv_set ids next 0

proc nextid {} {
return [nsv_incr ids next]
}

Note that the nsv solution does not need a mutex as the [[nsv_incr]] command is internally interlocked.

'''Compatibility with Tcl Arrays'''

Another useful feature of nsv is the [[nsv_array]] command which works much like the Tcl array command. This can be used to import and export values from ordinary Tcl arrays. For example, to copy from Tcl use:

nsv_array set meta [array get tmpmeta]

and to copy to Tcl use:

array set metacopy [nsv_array get meta]

As with all other nsv command, [[nsv_array]] is atomic and no explicit locking is required. This feature can be used to contruct a new nsv array by first filling up an ordinary temporary Tcl array via some time consuming process and then swapping it into place as above. While the new temporary array is being constructed, other threads can access the old array without delay or inconsistant data. You can even reset a complete nsv array in one step with "reset". For example, instead of:

ns_share lock meta
set lock [ns_mutex create]

ns_mutex lock $lock
unset meta
array set meta [array get tmpmeta]
ns_mutex unlock $lock

you can simply use:

nsv_array reset meta [array get tmpmeta]

The reset option will flush and then reset all values atomically, eliminating the need for the explicit lock.

Other options for the nsv_array command include:
* [[nsv_array]] exists ''array'' - test existance of array
* [[nsv_array]] size ''array'' - return # of elements in array
* [[nsv_array]] names ''array'' ''?pattern?'' - return keys of array

'''Configuration'''

The nsv system uses a common multithreading technique to reduce the potential for lock contention which is to split the locks to acheive finer grained locking. This technique groups arrays randomly into buckets and only the arrays within a particular bucket share a lock. The number of buckets to be used can be configured by setting the "nsvbuckets" tcl parameters, e.g.:

[[ns/server/server1/tcl]]
nsvbuckets=20

The default is 8 which should be reasonable. Note that you can monitor the lock contention, if any, by enabling mutex metering:

[[ns/threads]]
mutexmetering=on

and then viewing the results of "[[ns_info]] locks" command after the server has been running for some time. The nsv locks all have names of the form "nsv:##". If you find many lock attempts which did not successed immediately, try increasing nsvbuckets.

'''Migrating From ns_share'''

Migrating from [[ns_share]] is straightforward. If your init.tcl included commands such as:

ns_share myshare
set myshare(lock) [ns_mutex create]

use instead:

nsv_set myshare lock [ns_mutex create]

In your procedures, instead of:

proc myproc {} {
ns_share myshare
ns_mutex lock $myshare(lock) ...

use:

proc myproc {} {
ns_mutex lock [nsv_get myshare lock]
...

and within an ADP page, instead of:

<%
ns_share myshare
ns_puts $myshare(key1)
%>

<%=$myshare(key2)%>

use:

<%
ns_puts [nsv_get myshare key1]
%>

<%=[nsv_get myshare key2]%>

Notice that, unlike [[ns_share]], no command is required to define the shared array. The first attempt at setting the variable through any means will automaticaly create the array. Also notice that only arrays are supported. However, to migrate from [[ns_share]] you can simply package up all existing [[ns_share]] scalars into a single array with a short name, perhaps just ".". For example, if you had:

ns_share mylock myfile
set myfile /tmp/some.file
set mylock [ns_mutex create]

you can use:

nsv_set . myfile /tmp/some.file
nsv_set . mylock [ns_mutex create]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns buildsqldate

2009-02-07T20:04:11Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_buildsqldate.html

----

'''NAME'''

: ns_buildsqldate - Build a SQL date value from specified month, day, and year

'''SYNOPSIS'''

: '''ns_buildsqldate''' ''month day year''

'''DESCRIPTION'''

: This command builds a SQL date string out of the specified month, day, and year. The month can be the month number (1 - 12) or the full, capitalized month name (January, February, ..., December). The day must be a number from 1 - 31, and the year must be a 4-digit year (e.g., 1957). An error is returned if any of the argument values are invalid. The resulting string can be used in an SQL statement.

'''EXAMPLES'''

% ns_buildsqldate "01" "15" "1929"
1929-01-15

% ns_buildsqldate "13" "31" "2000"
Invalid date: 13 31 2000
while executing ...

% set thedate [[ns_buildsqldate "January" "15" "1929"]]
% ns_db dml $db "INSERT INTO mytable (datefield) VALUES ([[ns_dbquotevalue $thedate]])"

'''SEE ALSO'''

: [[ns_buildsqltime]], [[ns_buildsqltimestamp]], [[ns_parsesqldate]], [[ns_parsesqltime]], [[ns_parsesqltimestamp]]

[[Category:Documentation]] [[Category:Core Tcl API]]

Ns localsqltimestamp

2009-02-07T20:03:37Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_localsqltimestamp.html

----

'''NAME'''

: ns_localsqltimestamp - Return a SQL timestamp containing the local time.

'''SYNOPSIS'''

: '''ns_localsqltimestamp'''

'''DESCRIPTION'''

: This command returns a timestamp value that encodes the local time in ANSI SQL format (YYYY-MM-DD hh24:mm:ss).

'''EXAMPLES'''

% ns_localsqltimestamp
2004-06-22 23:00:27

: This command is equivalent to the following:

% ns_fmttime [[ns_time]] "%Y-%m-%d %H:%M:%S"

% clock format [[ns_time]] -format "%Y-%m-%d %H:%M:%S"

'''SEE ALSO'''

: [[ns_localtime]]

[[Category:Documentation]] [[Category:Core Tcl API]]

Ns dbquotevalue

2009-02-07T20:02:56Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_dbquotevalue.html

----

'''NAME'''

: ns_dbquotevalue - Prepare a value string for inclusion in an SQL statement.

'''SYNOPSIS'''

: '''ns_dbquotevalue''' ''value ?type?''

'''DESCRIPTION'''

: This command prepares the string ''value'' for inclusion in an SQL statement. If ''value'' is "", ns_dbquotevalue will return the string "NULL". If ''value'' is not "", the returned value depends on ''type''. If ''type'' is one of: bigint, bit, decimal, double, float, int, integer, numeric, real, smallint, or tinyint, then ''value'' will be returned without modification. When ''type'' is any other string, or if ''type'' is omitted, ''value'' will be surrounded by single quotes, and any single quotes that it contains will be escaped by translation into two single quotes.

'''EXAMPLES'''

% ns_dbquotevalue ""
NULL

% ns_dbquotevalue 45.3 float
45.3

% ns_dbquotevalue "John's Car"
<nowiki>'John''s Car'</nowiki>

% set company "John's Cheese Factory"
% ns_db dml $db "INSERT INTO companies (name) VALUES ([ns_dbquotevalue $company])"

'''SEE ALSO'''

: [[ns_dbquotename]]

[[Category:Documentation]] [[Category:Core Tcl API]]

Ns db

2009-02-07T20:02:13Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_db.html

----

'''NAME'''

: ns_db - Standard database access API.

'''SYNOPSIS'''

: '''ns_db''' ''option ?arg arg ...?''

'''DESCRIPTION'''

This command provides a mechanism to access databases. The legal ''option''s (which may be abbreviated) are:
* '''ns_db bindrow''' ''dbhandle''
* '''ns_db bouncepool''' ''poolname''

: Marks all database handles for the specified database pool as stale. When any database handle currently open is put back into the pool, its connection to the database will be reset.
* '''ns_db cancel''' ''dbhandle''
* '''ns_db close''' ''dbhandle''

: Closes the connection. Use this function only on handles that were obtained by the '''ns_db open''' function. The server automatically close handles when the operation is complete, so you don't normally have to call this function.
* '''ns_db connected''' ''dbhandle''
* '''ns_db datasource''' ''dbhandle''

: Returns the datasource for the database pool.
* '''ns_db dbtype''' ''dbhandle''

: Returns the database type for the database pool.
* '''ns_db dml''' ''dbhandle sql''
* '''ns_db driver''' ''dbhandle''

: Returns the name of the driver of the handle.
* '''ns_db exception''' ''dbhandle''
* '''ns_db exec''' ''dbhandle sqlcommand''

: Executes the specified SQL command. It returns either NS_DML (if the SQL command is a DML or DDL command) or NS_ROWS (if the SQL command returns rows, such as a SELECT). This function can be used for ad hoc querying, where you don't know what kind of SQL command will be executed.
* '''ns_db flush''' ''dbhandle''
* '''ns_db gethandle''' ''?-timeout timeout? poolname ?nhandles?''
* '''ns_db getrow''' ''dbhandle setId''
* '''ns_db open''' ''driver datasource user password''
* '''ns_db poolname''' ''dbhandle''
* '''ns_db pools'''
* '''ns_db releasehandle''' ''dbhandle''

: Puts the handle back in the pool. The server will automatically return any open handles to the pool after a page has finished executing.
* '''ns_db 1row''' ''dbhandle sql''

: This command expects the SQL to be a select statement that returns exactly one row and returns that row as an ns_set. An error is returned if zero or more than one row is returned.
* '''ns_db 0or1row''' ''dbhandle sql''

: This command expects the SQL to be a select statement that returns exactly zero or one row. On zero rows, a null string is returned. On one row, a newly allocated ns_set is returned. An error is thrown if more then one row is returned.
* '''ns_db password''' ''dbhandle''

: Returns the password of the user for the database pool.
* '''ns_db select''' ''dbhandle sql''
* '''ns_db setexception''' ''dbhandle code message''
* '''ns_db sp_exec''' ''dbhandle''
* '''ns_db sp_getparams'''
* '''ns_db sp_returncode''' ''dbhandle''
* '''ns_db sp_setparam''' ''dbhandle varname vartype inout value''
* '''ns_db sp_start''' ''dbhandle procname''
* '''ns_db user''' ''dbhandle''

: Returns the user for the database pool.
* '''ns_db verbose''' ''dbhandle ?on | off?''

'''EXAMPLES'''

'''SEE ALSO'''

: [[ns_buildsqldate]], [[ns_buildsqltime]], [[ns_buildsqltimestamp]], [[ns_dbquotename]], [[ns_dbquotevalue]], [[ns_localsqltimestamp]], [[ns_parsesqldate]], [[ns_parsesqltime]], [[ns_parsesqltimestamp]], [[ns_writecsv]]

: The tutorial [[Accessing A Database]] shows some very simple '''ns_db''' usage

[[Category:Documentation]] [[Category:Core Tcl API]]

Ns guesstype

2009-02-07T20:00:22Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_guesstype.html

----

'''NAME'''

: ns_guesstype - Lookup MIME type based on file extension.

'''SYNOPSIS'''

: '''ns_guesstype''' ''filename''

'''DESCRIPTION'''

: This command guesses and returns the MIME type of a file, based on the extension of ''filename''. A large set of default extension to MIME type mappings is built into the command:
* .adp returns "text/html; charset=iso-8859-1"
* .dci returns "text/html; charset=iso-8859-1"
* .htm returns "text/html; charset=iso-8859-1"
* .html returns "text/html; charset=iso-8859-1"
* .sht returns "text/html; charset=iso-8859-1"
* .shtml returns "text/html; charset=iso-8859-1"
* .ai returns "application/postscript"
* .aif returns "audio/aiff"
* .aifc returns "audio/aiff"
* .aiff returns "audio/aiff"
* .ani returns "application/x-navi-animation"
* .art returns "image/x-art"
* .au returns "audio/basic"
* .avi returns "video/x-msvideo"
* .bin returns "application/x-macbinary"
* .bmp returns "image/bmp"
* .css returns "text/css"
* .csv returns "application/csv"
* .dcr returns "application/x-director"
* .dir returns "application/x-director"
* .dp returns "application/commonground"
* .dxr returns "application/x-director"
* .elm returns "text/plain"
* .eml returns "text/plain"
* .exe returns "application/octet-stream"
* .gbt returns "text/plain"
* .gif returns "image/gif"
* .gz returns "application/x-compressed"
* .hqx returns "application/mac-binhex40"
* .jfif returns "image/jpeg"
* .jpe returns "image/jpeg"
* .jpg returns "image/jpeg"
* .jpeg returns "image/jpeg"
* .js returns "application/x-javascript"
* .ls returns "application/x-javascript"
* .map returns "application/x-navimap"
* .mid returns "audio/x-midi"
* .midi returns "audio/x-midi"
* .mocha returns "application/x-javascript"
* .mov returns "video/quicktime"
* .mpe returns "video/mpeg"
* .mpeg returns "video/mpeg"
* .mpg returns "video/mpeg"
* .nvd returns "application/x-navidoc"
* .nvm returns "application/x-navimap"
* .pbm returns "image/x-portable-bitmap"
* .pdf returns "application/pdf"
* .pgm returns "image/x-portable-graymap"
* .pic returns "image/pict"
* .pict returns "image/pict"
* .pnm returns "image/x-portable-anymap"
* .png returns "image/png"
* .ps returns "application/postscript"
* .qt returns "video/quicktime"
* .ra returns "audio/x-pn-realaudio"
* .ram returns "audio/x-pn-realaudio"
* .ras returns "image/x-cmu-raster"
* .rgb returns "image/x-rgb"
* .rtf returns "application/rtf"
* .sit returns "application/x-stuffit"
* .snd returns "audio/basic"
* .sql returns "application/x-sql"
* .stl returns "application/x-navistyle"
* .tar returns "application/x-tar"
* .tcl returns "text/plain"
* .text returns "text/plain"
* .tgz returns "application/x-compressed"
* .tif returns "image/tiff"
* .tiff returns "image/tiff"
* .txt returns "text/plain"
* .xbm returns "image/x-xbitmap"
* .xpm returns "image/x-xpixmap"
* .xht returns "application/xhtml+xml"
* .xhtml returns "application/xhtml+xml"
* .xml returns "text/xml"
* .xsl returns "text/xml"
* .vrml returns "x-world/x-vrml"
* .wav returns "audio/x-wav"
* .wrl returns "x-world/x-vrml"
* .z returns "application/x-compressed"
* .zip returns "application/x-zip-compressed"

: The MIME type returned for an extension can be overriden in the AOLserver config file, and new mappings can be added, e.g.

ns_section "ns/mimetypes"
ns_param ".xls" "application/vnd.ms-excel" ;# Add a mapping for Excel files
ns_param ".sjis_html" "text/html; charset=shift_jis" ;# Adding a mapping, specifing charset
ns_param ".adp" "text/html; charset=UTF-8" ;# Overriding an existing mapping

: The MIME type to be returned for files with unrecognized or missing extensions can also be specified in the "ns/mimetypes" section of the config file, e.g.

ns_section "ns/mimetypes"
ns_param default "*/*" ;# MIME type for unrecognized extension.
ns_param noextension "*/*" ;# MIME type for missing extension.

: If default is not configured, "*/*" will be returned for files with unrecognized extensions. If noextension is not configured, the MIME type configured as default (or "*/*") will be used.

'''EXAMPLES'''

: (Assuming configured with the examples above)

% ns_guesstype "hello.jpg"
image/jpeg

% ns_guesstype "hello.xls"
application/vnd.ms-excel

% ns_guesstype "hello.html"
text/html; charset=iso-8859-1

% ns_guesstype "world.adp"
text/html; charset=UTF-8

% ns_guesstype "world.doc"
*/*

% ns_guesstype somefile
*/*

[[Category:Documentation]] [[Category:Core Tcl API]]

Ns parsequery

2009-02-07T19:58:31Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_parsequery.html

----

'''NAME'''

: ns_parsequery - Parse a URL query string into an ns_set.

'''SYNOPSIS'''

: '''ns_parsequery''' ''querystring''

'''DESCRIPTION'''

: This command parses the specified ''querystring'' into an [[ns_set]], which is returned. The keys and values will be decoded.

'''EXAMPLES'''

% set s [ns_parsequery "msg=Hello+World%21&a=b&a=b&c=d"]
d0

% ns_set array $s
msg {Hello World!} a b a b c d

[[Category:Documentation]] [[Category:Core Tcl API]]

Ns register adp

2009-02-07T19:57:33Z

Gustafn:

Similar to Registered Procedures, all requests to a particular URL
can be captured but in this situation processing can be performed
by an ADP file. Giving additional functionality of being able to make
changes a lot more rapidly.

This also provides a method of making view controls at ADP level
rather than at TCL level, which keeps development at an
appropriate abstracted level.

Syntax:

ns_register_adp GET|POST /URL/* FILE

Both registered ADP pages, and registered procedures will be called
irregardless of to original requested target existing or not.

[[Category:Documentation]] [[Category:Core Tcl API]]

Ns rand

2009-02-07T19:56:26Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_rand.html

----

'''NAME'''

: ns_rand - Generate a random number

'''SYNOPSIS'''

: '''ns_rand''' ''?maximum?''

'''DESCRIPTION'''

: This command generates a cryptographically secure random number. If ''maximum'' is not specified, the random number returned is a floating-point value n such that 0.0 <= n < 1.0. If ''maximum'' is specified, it must be a positive integer between 1 and 2147483647, in which case '''ns_rand''' will return an integer value n such that 0 <= n <= max - 1.

: Internally '''ns_rand''' is implemented with the '''drand48()''' and '''lrand48()''' standard library functions. An internal random seed is generated the first time '''ns_rand''' is called after the server starts.

'''EXAMPLES'''

% ns_rand
0.39938485692

% ns_rand 10
7

'''CAVEAT'''

: [ns_rand 1] will always produce the result 0. [ns_rand 2] will produce the desired "coin flip" outcome of 0 or 1. This is standard with [http://java.sun.com/j2se/1.4.2/docs/api/java/util/Random.html#nextInt(int) Java's java.util.Random implementation of nextInt] and most other random number libraries.

'''SEE ALSO'''

[[Category:Documentation]] [[Category:Core Tcl API]]

Ns adp registerscript

2009-02-07T19:55:48Z

Gustafn:

Man page: http://aolserver.com/docs/devel/tcl/api/adp.html#ns_register_adptag

----

'''NAME'''

: ns_register_adptag - Register an XML-like tag for use within an ADP.

'''SYNOPSIS'''

: '''ns_register_adptag''' command ''?endcommand?'' proc

'''DESCRIPTION'''

: '''ns_register_adptag''' registers a procedure to be called when the specified beginning and ending tags are used in an ADP. The command is the beginning tag to look for, and the ''endcommand'' is the ending tag to look for. The proc is the procedure that will be called when AOLserver encounters those tags when processing an ADP.

: Try not to confuse '''ns_register_adptag''' with [[ns_adp_registertag]]. This one registers a Tcl proc that is run by the tag. The other one registers an ADP script that is run by the tag.

: There are two ways to use '''ns_register_adptag''', with and without the ''endcommand'' parameter:

* If the endcommand parameter is specified, the procedure you specify with proc must be of the form:

proc myadpproc { string tagset }

: The string is the string of characters between the beginning tag and the ending tag. The tagset is an [[ns_set]] of parameters that were specified with the beginning tag. The return value of the procedure will be sent to the browser in place of the string of text that was specified between the beginning and ending tags.

: The string is not parsed, which means that you cannot include ADP tags in the string unless you execute [[ns_adp_parse]] on the string inside the procedure that processes the registered ADP tag.

* If ''endcommand'' is not specified, then no closing tag is required. The procedure (proc) will be called every time the specified command is encountered. The procedure should take one parameter, an [[ns_set]] containing the parameters to the tag:

proc myadpproc { tagset }

: Note: This function cannot be called after the server has started. It must be called in a Tcl script in a virtual server's Tcl directory so that it can be initialized at server startup time.

'''EXAMPLE'''

: Suppose you want to register a tag that displays the enclosed text only if it is Christmas. You could register the tag as follows:

ns_register_adptag "christmas" "/christmas" xmas

# Note: We are registering a Tcl proc.
proc xmas {string tagset} {
if {[ns_fmttime [ns_time] "%m/%d"] == "12/25"} then {
return $string
}
}

: Then, in an ADP, you use these tags:

<christmas>Merry Christmas to all, and to all a good night!</christmas>

: In another example we show how to use a registered tag without an ''endcommand''. The tag is registered as follows:

ns_register_adptag hello helloproc

# Note: We are registering a Tcl proc.
proc helloproc { tags } {
return "Hello, [ns_set get $tags name]."
}

: In an ADP, you use this tag:

<hello name=Bob>

: This can be extended to provide XML-like template pages for content.

'''SEE ALSO'''

: [[ns_adp_registertag]], [[ns_adp_parse]]

[[Category:Documentation]] [[Category:Core Tcl API]]

Ns register proc

2009-02-07T19:54:49Z

Gustafn:

{{manpage|ns_proc}}

'''NAME'''

: ns_register_proc - Register a procedure for a method/URL combination

'''SYNOPSIS'''

: '''ns_register_proc''' ''?-noinherit? method URL myproc ?args?''

'''DESCRIPTION'''

: '''ns_register_proc''' registers the procname to handle the specified method/URL combination. When the server gets a matching request, it calls procname with the connection id and any arguments specified here.

: If ''-noinherit'' is specified, the requested URL must match the specified URL exactly. For example, if the URL specified with '''ns_register_proc''' is /foo/bar, procname will not be called unless the requested URL is exactly /foo/bar.

: If ''-noinherit'' is not specified, the requested URL can match the specified URL or any URL below it. For example, if the URL specified with '''ns_register_proc''' is /foo/bar, procname will be called for /foo/bar, /foo/bar/hmm, and any other URL below /foo/bar, provided there is not already another procedure registered for that exact URL or for an URL with a closer match.

: Note that you must use a glob-style matching character if you want inheritance for file names. For example, if you want /foo/bar to match /foo/bar.html, you must use:

ns_register_proc /foo/bar*

: You can register two procedures for any given method/URL combination by calling '''ns_register_proc''' once with the ''-noinherit'' flag set and once without it. Only one of the procedures will be called for any given request, depending on whether the URL was an exact match or not. For example:

ns_register_proc -noinherit GET /foo/bar Aproc
ns_register_proc GET /foo/bar Bproc
ns_register_proc GET /foo/bar/hmm Cproc

: Aproc will be called when the requested URL is exactly /foo/bar. Bproc will be called when the requested URL is below /foo/bar, provided there is not already another procedure registered to be called for that exact URL or for an URL with a closer match. Cproc (not Bproc) will be called when the requested URL is equal to or below /foo/bar/hmm. Syntax for the registered procedure The conn (connection) argument is optional for procedures registered by '''ns_register_proc''' if the procedure has 0 or 1 arguments (not including conn). The following examples show the variations that can be used in this case:

ns_register_proc GET /noargs noargs
ns_register_proc GET /context context fnord
ns_register_proc GET /conncontext conncontext greeblev

proc noargs { } {
ns_returnnotice 200 "noargs"
} ;# noargs

proc context { context } {
ns_returnnotice 200 "context is $context"
} ;# context

proc conncontext { conn context } {
ns_returnnotice 200 "conncontext is $context"
} ;# conncontext

: The ''conn'' (connection) argument is required for procedures registered by '''ns_register_proc''' if the procedure has 2 or more arguments (not including ''conn''). The ''conn'' argument will be filled automatically with the connection information. The first argument following ''conn'' will always take the value supplied by '''ns_register_proc''', if there is one, or an empty value. All other arguments must supply a default value. The following examples show the variations that can be used in this case:

ns_register_proc GET /twoargs twoargs fnord
ns_register_proc GET /threeargs threeargs fnord fjord

proc twoargs { conn context { greeble bork } } {
# Do stuff...
}

proc threeargs { conn context {greeble bork } { hoover quark } {
# Do stuff...
}

: When a GET of /twoargs is requested, the conn argument will be filled automatically, the context argument will be assigned "fnord" and the greeble argument will be assigned the default value "bork".

: When a GET of /threeargs is requested, the conn argument will be filled automatically, the context argument will be assigned "fnord" and the greeble argument will be assigned "fjord", and the hoover argument will be assigned the default value "quark".

'''SEE ALSO'''

: [[ns_unregister_proc]]

[[Category:Documentation]] [[Category:Core Tcl API]]

Ns shutdown

2009-02-07T19:54:15Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_shutdown.html

----

'''NAME'''

: ns_shutdown - Shut down AOLserver

'''SYNOPSIS'''

: '''ns_shutdown''' ''?timeout?''

'''DESCRIPTION'''

: This command shuts down the currently running instance of AOLserver, by sending an NS_SIGTERM signal.[[User:Gustafn|Gustafn]]If ''timeout'' is specified, the server waits that many seconds to shutdown; otherwise it shuts down immediately.

'''EXAMPLES'''

ns_shutdown
ns_shutdown 30

'''SEE ALSO'''

: none

[[Category:Documentation]] [[Category:Core Tcl API]]

Ns section

2009-02-07T19:52:56Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_section.html

----

'''NAME'''

: ns_section - Specify the current configuration section.

'''SYNOPSIS'''

: '''ns_section''' ''sectionname''

'''DESCRIPTION'''

: This command sets the current section to define parameters for using [[ns_param]]. This command is only available at server startup when parsing the config .tcl file.

'''EXAMPLES'''

% ns_section "ns/server/$servername/section"
% ns_param someSetting someValue

'''SEE ALSO'''

: [[ns_config]], [[ns_configsection]], [[ns_configsections]], [[ns_param]]

[[Category:Documentation]] [[Category:Core Tcl API]]

Ns modulepath

2009-02-07T19:52:15Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_modulepath.html

----

'''NAME'''

: ns_modulepath - Get the paths to a server's modules

'''SYNOPSIS'''

: '''ns_modulepath''' ''server ?module ...?''

'''DESCRIPTION'''

: This command returns the path to a server's directory and optionally to its modules. The command does no validation on the ''server'' to see if it is actually defined.

: The server directory is a subdirectory of "servers" under the path returned from [[ns_info]] '''home'''. Modules are relative to that directory in the subdirectory "modules".

'''EXAMPLES'''

% ns_modulepath exampleServer
/home/aolserver/servers/exampleServer

% file join [[ns_info home]] servers exampleServer
/home/aolserver/servers/exampleServer

% ns_modulepath exampleServer exampleModule
/home/aolserver/servers/exampleServer/modules/exampleModule

% file join [[ns_info home]] servers exampleServer modules exampleModule
/home/aolserver/servers/exampleServer/modules/exampleModule

'''SEE ALSO'''

: [[ns_info]] '''home'''

[[Category:Documentation]] [[Category:Core Tcl API]]

Ns library

2009-02-07T19:51:33Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_library.html

----

'''NAME'''

: ns_library - Get the paths to the private and shared Tcl libraries

'''SYNOPSIS'''

: '''ns_library''' ''library ?module?''

'''DESCRIPTION'''

: This command returns the path to the private and shared Tcl libraries, optionally specifying a ''module'' as well.
''library'' must either be "private" or "shared". The private library is the same as what's returned from [[ns_info]] '''tcllib''' as defined in the config .tcl at server start-up. The shared library is relative to the path specified by [[ns_info]] '''home''', in the "modules/tcl" subdirectory.

: The optional ''module'' is simply concatenated to the path returned from '''ns_library'''.

'''EXAMPLES'''

% ns_library shared
/home/aolserver/modules/tcl

% file join [ns_info home] modules tcl
/home/aolserver/modules/tcl

% ns_library private exampleModule
/home/aolserver/servers/exampleServer/tcl/exampleModule

% file join [ns_info tcllib] exampleModule
/home/aolserver/servers/exampleServer/tcl/exampleModule

'''SEE ALSO'''

: [[ns_info]] '''home''', [[ns_info]] '''tcllib'''

[[Category:Documentation]] [[Category:Core Tcl API]]

Ns configsection

2009-02-07T19:50:16Z

Gustafn:

<manpage>ns_configsection</manpage>

'''NAME'''

ns_configsection - Return a handle to an [[ns_set]] for a section of the server's configuration

'''SYNOPSIS'''

'''ns_configsection''' ''section''

'''DESCRIPTION'''

This command returns a handle for an [[ns_set]] which contains all the parameter key-value pairs for the ''section'' from the server's configuration. If the ''section'' is not defined, this command returns an empty string.

'''EXAMPLES'''

% set setId [ns_configsection ns/parameters]
t0

% ns_set name $setId
ns/parameters

% array set a [ns_set array $setId]
% array names a
EnableAdmin MailHost Home Group User debug

'''SEE ALSO'''

[[ns_config]], [[ns_configsections]], [[ns_set]]
----
[[Category:Documentation]] [[Category:Core Tcl API]]

Ns configsections

2009-02-07T19:49:47Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_configsections.html

----

'''NAME'''

ns_configsections - Return a list of handles to [[ns_set]]s for every section in the server's configuration

'''SYNOPSIS'''

'''ns_configsections'''

'''DESCRIPTION'''

This command returns a list of [[ns_set]]s for every section in the server's configuration. The corresponding [[ns_set]]s contain the key-value pairs for the configuration section that the [[ns_set]] represents.

'''EXAMPLES'''

% set sections [[ns_configsections]]
t0 t1 t2 t3 ... t116 t117

% ns_set name t8
ns/parameters

'''SEE ALSO'''

[[ns_config]], [[ns_configsection]], [[ns_set]]

----
[[Category:Documentation]] [[Category:Core Tcl API]]

Ns configsections

2009-02-07T19:49:29Z

Gustafn:

Ns configsections

2009-02-07T19:49:09Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_configsections.html

----

'''NAME'''

ns_configsections - Return a list of handles to [[ns_set]]s for every section in the server's configuration

'''SYNOPSIS'''

'''ns_configsections'''

'''DESCRIPTION'''

This command returns a list of [[ns_set]]s for every section in the server's configuration. The corresponding [[ns_set]]s contain the key-value pairs for the configuration section that the [[ns_set]] represents.

'''EXAMPLES'''

% set sections [[ns_configsections]]
t0 t1 t2 t3 ... t116 t117

% ns_set name t8
ns/parameters

'''SEE ALSO'''

[[ns_config]], [[ns_configsection]], [[ns_set]]

---

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns configsections

2009-02-07T19:48:54Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_configsections.html

----

'''NAME'''

ns_configsections - Return a list of handles to [[ns_set]]s for every section in the server's configuration

'''SYNOPSIS'''

'''ns_configsections'''

'''DESCRIPTION'''

This command returns a list of [[ns_set]]s for every section in the server's configuration. The corresponding [[ns_set]]s contain the key-value pairs for the configuration section that the [[ns_set]] represents.

'''EXAMPLES'''

% set sections [[ns_configsections]]
t0 t1 t2 t3 ... t116 t117

% ns_set name t8
ns/parameters

'''SEE ALSO'''

[[ns_config]], [[ns_configsection]], [[ns_set]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns configsection

2009-02-07T19:48:38Z

Gustafn:

<manpage>ns_configsection</manpage>

'''NAME'''

ns_configsection - Return a handle to an [[ns_set]] for a section of the server's configuration

'''SYNOPSIS'''

'''ns_configsection''' ''section''

'''DESCRIPTION'''

This command returns a handle for an [[ns_set]] which contains all the parameter key-value pairs for the ''section'' from the server's configuration. If the ''section'' is not defined, this command returns an empty string.

'''EXAMPLES'''

% set setId [ns_configsection ns/parameters]
t0

% ns_set name $setId
ns/parameters

% array set a [ns_set array $setId]
% array names a
EnableAdmin MailHost Home Group User debug

'''SEE ALSO'''

[[ns_config]], [[ns_configsections]], [[ns_set]]

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns config

2009-02-07T19:48:15Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_config.html

----

'''NAME'''

ns_config - Extract configuration information from the server

'''SYNOPSIS'''

'''ns_config''' ''?-exact | -bool | -int? section key ?default?''

'''DESCRIPTION'''

This command returns the value associated with the ''key'' in the specified ''section'' of the current server's configuration. If ''default'' is specified, and the ''section'' and ''key'' are not defined, then ''default'' is returned. If ''default'' is not specified in this situation, an empty string is returned.

If ''-exact'' is specified, matching on ''key'' is case-sensitive. By default, matching is case-insensitive.

If ''-bool'' is specified, '''ns_config''' will perform the conversion of a boolean value from "on", "1", "y", "yes", "t", and "true" to "1", and it will convert a boolean value of "off", "0", "n", "no", "f", and "false" to "0". If a boolean contains any other value, a warning is written to the server log and an empty string is returned. If the configuration value is not defined, an empty string is returned.

If ''-int'' is specified, '''ns_config''' will return the integer value of the specified key. If there is a non-integer value in the configuration, a warning is written to the log file and an empty string is returned.

'''EXAMPLES'''

% ns_config ns/parameters debug
off

% string length [ns_config dummy dummy]
0

% ns_config dummy dummy default
default

'''SEE ALSO'''

[[ns_configsection]], [[ns_configsections]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns parsetime

2009-02-07T19:46:41Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_parsetime.html

----

'''NAME'''

: ns_parsetime - Return an element from the time structure list

'''SYNOPSYS'''

: '''ns_parsetime''' ''option time''

'''DESCRIPTION'''

: This command takes a nine-element Tcl list as ''time'' representing the Unix '''struct tm''' structure (as would be returned from [[ns_gmtime]] or [[ns_localtime]]) and based on ''option'', returns an element from the list. The valid ''option''s are: sec, min, hour, mday, mon, year, wday, yday, isdst. The options are listed in order of the actual elements in the Tcl list itself.

'''EXAMPLE'''

% set time [ [[ns_localtime]] ]
33 33 22 11 5 104 5 162 1

% expr {1900 + [ [[ns_parsetime]] year $time]}
2004

'''SEE ALSO'''

: [[ns_fmttime]], [[ns_gmtime]], [[ns_httptime]], [[ns_localtime]], [[ns_parsehttptime]], [[ns_time]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns parsetime

2009-02-07T19:46:07Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_parsetime.html

----

'''NAME'''

: ns_parsetime - Return an element from the time structure list

'''SYNOPSYS'''

: '''ns_parsetime''' ''option time''

'''DESCRIPTION'''

: This command takes a nine-element Tcl list as ''time'' representing the Unix '''struct tm''' structure (as would be returned from [[ns_gmtime]] or [[ns_localtime]]) and based on ''option'', returns an element from the list. The valid ''option''s are: sec, min, hour, mday, mon, year, wday, yday, isdst. The options are listed in order of the actual elements in the Tcl list itself.

'''EXAMPLE'''

% set time [[[ns_localtime]]]
33 33 22 11 5 104 5 162 1

% expr {1900 + [[ns_parsetime year $time]]}
2004

'''SEE ALSO'''

: [[ns_fmttime]], [[ns_gmtime]], [[ns_httptime]], [[ns_localtime]], [[ns_parsehttptime]], [[ns_time]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns parsetime

2009-02-07T19:45:29Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_parsetime.html

----

'''NAME'''

: ns_parsetime - Return an element from the time structure list

'''SYNOPSYS'''

: '''ns_parsetime''' ''option time''

'''DESCRIPTION'''

: This command takes a nine-element Tcl list as ''time'' representing the Unix '''struct tm''' structure (as would be returned from [[ns_gmtime]] or [[ns_localtime]]) and based on ''option'', returns an element from the list. The valid ''option''s are: sec, min, hour, mday, mon, year, wday, yday, isdst. The options are listed in order of the actual elements in the Tcl list itself.

'''EXAMPLE'''

% set time [[ns_localtime]]
33 33 22 11 5 104 5 162 1

% expr {1900 + [[ns_parsetime year $time]]}
2004

'''SEE ALSO'''

: [[ns_fmttime]], [[ns_gmtime]], [[ns_httptime]], [[ns_localtime]], [[ns_parsehttptime]], [[ns_time]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns parsehttptime

2009-02-07T19:45:13Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_parsehttptime.html

----

'''NAME'''

: ns_parsehttptime - Convert a HTTP date format string into seconds

'''SYNOPSIS'''

: '''ns_parsehttptime''' ''httptime''

'''DESCRIPTION'''

: This command parses a string containing an HTTP date format string (see [http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.3 RFC 2616 Sec 3.3]) and returns the number of seconds since 00:00:00 UTC Jan 1, 1970.

'''EXAMPLES'''

% ns_parsehttptime "Thu, 01 Jan 1970 00:00:00 GMT"
0

% ns_parsehttptime "Thu, 14 Nov 2002 17:29:06 GMT"
1037294946

'''SEE ALSO'''

: [[ns_fmttime]], [[ns_gmtime]], [[ns_httptime]], [[ns_localtime]], [[ns_parsetime]], [[ns_time]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns localtime

2009-02-07T19:44:55Z

Gustafn:

<manpage>ns_localtime</manpage>

'''NAME'''

: ns_localtime - Return current time in local timezone

'''SYNOPSIS'''

: '''ns_localtime'''

'''DESCRIPTION'''

: This command returns a nine-element Tcl list representing the current time in the system's current timezone. The structure of the list corresponds to the Unix '''struct tm''' time structure:

:* seconds (0-59)
:* minutes (0-59)
:* hours (0-23)
:* dayofmonth (1-31)
:* monthofyear (0-11)
:* year (year-1900)
:* dayofweek (0-6, Sunday=0)
:* dayofyear (0-365)
:* isdst (>0 if Daylight Savings Time is in effect)

'''EXAMPLES'''

% ns_localtime
33 33 22 11 5 104 5 162 1

'''SEE ALSO'''

: [[ns_fmttime]], [[ns_gmtime]], [[ns_httptime]], [[ns_parsehttptime]], [[ns_parsetime]], [[ns_time]]

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns cookietime

2009-02-07T19:44:38Z

Gustafn:

'''NAME'''

: ns_cookietime - Convert seconds to Netscape's cookie date format

'''SYNOPSIS'''

: '''ns_cookietime''' ''time''

'''DESCRIPTION'''

: This command converts the time, specified as the number of seconds from 00:00:00 UTC Jan 1, 1970, to a string in Netscape's old cookie "Expires" date format (see [http://www.w3.org/Protocols/rfc2109/rfc2109.txt RFC 2109 Sec 10.1.2]).

'''CODE'''

: '''NOTE:''' This command is not yet part of the standard core Tcl API for AOLserver.

proc ns_cookietime {time} {
regsub {, (\d+) (\S+) (\d+)} [[ns_httptime $time]] {, \1-\2-\3} string
return $string
}

'''EXAMPLES'''

% ns_cookietime 0
Thu, 01-Jan-1970 00:00:00 GMT

% ns_cookietime 8675309
Sat, 11-Apr-1970 09:48:29 GMT

'''SEE ALSO'''

: [[ns_fmttime]], [[ns_gmtime]], [[ns_httptime]], [[ns_localtime]], [[ns_parsehttptime]], [[ns_parsetime]], [[ns_time]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns httptime

2009-02-07T19:44:21Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_httptime.html

----

'''NAME'''

: ns_httptime - Convert seconds to HTTP date format

'''SYNOPSIS'''

: '''ns_httptime''' ''time''

'''DESCRIPTION'''

: This command converts the time, specified as the number of seconds from 00:00:00 UTC Jan 1, 1970, to a string in HTTP date format (see [http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.3 RFC 2616 Sec 3.3]).

'''EXAMPLES'''

% ns_httptime 0
Thu, 01 Jan 1970 00:00:00 GMT

% ns_httptime 8675309
Sat, 11 Apr 1970 09:48:29 GMT

'''SEE ALSO'''

: [[ns_cookietime]], [[ns_fmttime]], [[ns_gmtime]], [[ns_localtime]], [[ns_parsehttptime]], [[ns_parsetime]], [[ns_time]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns fmttime

2009-02-07T19:43:53Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_fmttime.html

----

'''NAME'''

: ns_fmttime - Convert seconds to a human-readable format using templates

'''SYNOPSIS'''

: '''ns_fmttime''' ''time ?fmt?''

'''DESCRIPTION'''

: This command produces a string representation of ''time'' in seconds since 00:00:00 UTC Jan 1, 1970.

: '''ns_fmttime''' uses the '''strftime()''' system call, so valid ''fmt'' strings will vary from platform to platform. Consult your operating system's documentation for '''strftime()''' to see what valid ''fmt'' strings can contain. ''fmt'' defaults to "%c" which is supposed to be the preferred date and time representation for the current locale, which on some platforms should be "%a %b %e %H:%M:%S %Z %Y".

'''EXAMPLES'''

% ns_fmttime 0
Wed Dec 31 19:00:00 1969

% ns_fmttime 0 "%a %b %e %H:%M:%S %Z %Y"
Wed Dec 31 19:00:00 EST 1969

% ns_fmttime [[ns_time]] "%Y%m%d"
20040614

'''SEE ALSO'''

: [[ns_gmtime]], [[ns_httptime]], [[ns_localtime]], [[ns_parsehttptime]], [[ns_parsetime]], [[ns_time]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Nsv names

2009-02-07T19:42:06Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/nsv_names.html

----

'''NAME'''

: nsv_names - List the nsvs in use

'''SYNOPSIS'''

: '''nsv_names''' ''?pattern?''

'''DESCRIPTION'''

: Return a list of all the nsvs in use, optionally only those matching ''pattern''. If no matching nsvs are in use returns the empty string.

'''EXAMPLES'''

% nsv_names
shared_array

'''SEE ALSO'''

: [[Thread-shared Variables]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Nsv array

2009-02-07T19:41:46Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/nsv_array.html

----

'''NAME'''

: nsv_array - Tcl array functionality in nsvs

'''SYNOPSIS'''

: '''nsv_array''' get ''array'' ''?pattern?''

: '''nsv_array''' set ''array'' ''value-list''

: '''nsv_array''' reset ''array'' ''value-list''

: '''nsv_array''' exists ''array''

: '''nsv_array''' size ''array''

: '''nsv_array''' names ''array'' ''?pattern?''

'''DESCRIPTION'''

: nsv_array works much like the Tcl array command.

'''EXAMPLES'''

Basic
% nsv_array set shared_array { key1 value1 key2 value2 }

% nsv_array get shared_array
key1 value1 key2 value2

% nsv_array reset shared_array { key3 value3 }

% nsv_array exists shared_array
1

% nsv_array size shared_array
1

% nsv_array names shared_array
key3

Working with tcl arrays

% nsv_array set shared_array [array get tmp_shared_array]

% array set tmp_shared_array [nsv_array get shared_array]

% nsv_array reset shared_array [array get tmp_shared_array]

'''SEE ALSO'''

: [[Thread-shared Variables]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Nsv unset

2009-02-07T19:41:23Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/nsv_unset.html

----

'''NAME'''

: nsv_unset - Unset an array or a key

'''SYNOPSIS'''

: '''nsv_unset''' ''array'' ''?key?''

'''DESCRIPTION'''

: Unset an array or a single key from an array. If successful returns an empty string.

'''EXAMPLES'''

% nsv_unset shared_array key1

unset a key

%nsv_unset shared_array

unset an array

'''SEE ALSO'''

: [[Thread-shared Variables]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Nsv lappend

2009-02-07T19:41:04Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/nsv_lappend.html

----

'''NAME'''

: nsv_lappend - Append to the list specified by the key

'''SYNOPSIS'''

: '''nsv_lappend''' ''array'' ''key'' ''value'' ''?value ...?''

'''DESCRIPTION'''

: Append all of the value arguments as list elements to variable ''key'' in the array. If ''key'' doesn't exist, it is created as a list with elements given by the value arguments

'''EXAMPLES'''

% nsv_lappend shared_array key1 value2
value1 value2

'''SEE ALSO'''

: [[Thread-shared Variables]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Nsv append

2009-02-07T19:40:45Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/nsv_append.html

----

'''NAME'''

: nsv_append - Append to the value specified by the key

'''SYNOPSIS'''

: '''nsv_append''' ''array'' ''key'' ''value'' ''?value ...?''

'''DESCRIPTION'''

: Append all of the value arguments to the current value of variable ''key'' in the array. If ''key'' doesn't exist, it is given a value equal to the concatenation of all the value arguments

'''EXAMPLES'''

% nsv_append shared_array key1 foo
value1foo

'''SEE ALSO'''

: [[Thread-shared Variables]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Nsv set

2009-02-07T19:40:28Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/nsv_set.html

----

'''NAME'''

: nsv_set - Set a key value

'''SYNOPSIS'''

: '''nsv_set''' ''array'' ''key'' ''value''

'''DESCRIPTION'''

: Set the value for a key in an nsv array. Returns the value the key is set to.

'''EXAMPLES'''

% nsv_set shared_array key1 value1
value1

'''SEE ALSO'''

: [[Thread-shared Variables]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Nsv exists

2009-02-07T19:40:04Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/nsv_exists.html

----

'''NAME'''

: nsv_exists - Test whether a key exists

'''SYNOPSIS'''

: '''nsv_exists''' ''array'' ''key''

'''DESCRIPTION'''

: Test whether a key exists in the nsv array.

'''EXAMPLES'''

% nsv_exists shared_array key1
1

the key exists

% nsv_exists shared_array key2
0

the key does not exist

'''SEE ALSO'''

: [[Thread-shared Variables]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Nsv get

2009-02-07T19:39:43Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/nsv_get.html

----

'''NAME'''

: nsv_get - Get a key value

'''SYNOPSIS'''

: '''nsv_get''' ''array'' ''key''

'''DESCRIPTION'''

: Get the value for the key from the nsv array. Error occurs if key does not exist.

'''EXAMPLES'''

% nsv_get shared_array key1
value1

'''SEE ALSO'''

: [[Thread-shared Variables]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns schedule weekly

2009-02-07T19:37:58Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_schedule_weekly.html

----

'''NAME'''

: ns_schedule_weekly - Schedule a script to run on a certain day of the week at a certain time

'''SYNOPSIS'''

: '''ns_schedule_weekly''' ''?-once? ?-thread? day hour minute script''

'''DESCRIPTION'''

: This command schedules a ''script'' to be run on a certain ''day'' of the week at a certain ''hour'' and ''minute'' of that day. Returns the ID of the newly scheduled script. The week starts on Sunday as day zero and runs to Saturday as day six. If ''-once'' is specified, then the script is run once and then unscheduled, otherwise it will continue to run every week on that day at that time. If ''-thread'' is specified, then the script will be run in its own thread, otherwise it will run in the scheduler's thread. If the script is long-running, this may interfere with the running of other scheduled scripts, so long-running scripts should be run in their own threads.

: '''NOTE:''' ''day'', ''hour'' and ''minute'' are specified in local time. Beware of Daylight Savings Time shifts affecting the time of day when the script will execute.

'''EXAMPLES'''

% set id [[ns_schedule_weekly -once 2 5 35 { ns_log notice "It is now Tuesday at 5:35 AM." }]]
123

% ns_unschedule_proc $id

'''SEE ALSO'''

: [[ns_after]], [[ns_info]] scheduled, [[ns_pause]], [[ns_resume]], [[ns_schedule_proc]], [[ns_schedule_daily]], [[ns_unschedule_proc]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns schedule proc

2009-02-07T19:37:41Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_schedule_proc.html

----

'''NAME'''

: ns_schedule_proc - Schedule a script to run after a certain number of seconds

'''SYNOPSIS'''

: '''ns_schedule_proc''' ''?-once? ?-thread? interval script''

'''DESCRIPTION'''

: This command schedules a script to be run after a certain number of seconds. Returns the ID of the newly scheduled script. If ''-once'' is specified, then the script is run once and then unscheduled, otherwise it will continue to run every ''interval'' seconds. If ''-thread'' is specified, then the script will be run in its own thread, otherwise it will run in the scheduler's thread. If the script is long-running, this may interfere with the running of other scheduled scripts, so long-running scripts should be run in their own threads.

'''EXAMPLES'''

% set id [[ns_schedule_proc -once 60 { ns_log notice "this should run in 60 seconds" }]]
123

% ns_unschedule_proc $id

'''SEE ALSO'''

: [[ns_after]], [[ns_info]] scheduled, [[ns_pause]], [[ns_resume]], [[ns_schedule_daily]], [[ns_schedule_weekly]], [[ns_unschedule_proc]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns schedule daily

2009-02-07T19:37:18Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_schedule_daily.html

----

'''NAME'''

: ns_schedule_daily - Schedule a script to run daily at a certain time

'''SYNOPSIS'''

: '''ns_schedule_daily''' ''?-once? ?-thread? hour minute script''

'''DESCRIPTION'''

: This command schedules a ''script'' to be run at a certain ''hour'' and ''minute'' of the day. Returns the ID of the newly scheduled script. If ''-once'' is specified, then the script is run once and then unscheduled, otherwise it will continue to run every day at that time. If ''-thread'' is specified, then the script will be run in its own thread, otherwise it will run in the scheduler's thread. If the script is long-running, this may interfere with the running of other scheduled scripts, so long-running scripts should be run in their own threads.

: '''NOTE:''' ''hour'' and ''minute'' are specified in local time. Beware of Daylight Savings Time shifts affecting the time of day when the script will execute.

'''EXAMPLES'''

% set id [[ns_schedule_daily -once 5 35 { ns_log notice "It is now 5:35 AM." }]]
123

% ns_unschedule_proc $id

'''SEE ALSO'''

: [[ns_after]], [[ns_info]] scheduled, [[ns_pause]], [[ns_resume]], [[ns_schedule_proc]], [[ns_schedule_weekly]], [[ns_unschedule_proc]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns pause

2009-02-07T19:36:42Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_pause.html

----

'''NAME'''

: ns_pause - Pause a scheduled script from running

'''SYNOPSIS'''

: '''ns_pause''' ''id''

'''DESCRIPTION'''

: This command pauses a scheduled script from running at its next scheduled time. Returns 1 on success, 0 on failure.

'''EXAMPLES'''

% set id [[ns_schedule_daily 1 0 { ns_log notice "One AM and all is well. *gong*" }]]
19

% ns_pause $id
1

% ns_unschedule_proc $id

'''SEE ALSO'''

: [[ns_info]] scheduled, [[Ns_Resume]], [[ns_unschedule_proc]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns after

2009-02-07T19:36:22Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_after.html

----

'''NAME'''

: ns_after - Execute a command after a time delay

'''SYNOPSIS'''

: '''ns_after''' ''seconds script''

'''DESCRIPTION'''

: This command executes a script in the background after a number of seconds time delay. It does this by scheduling a one-shot event in the scheduler. Uncaught script errors will go to the server log. It returns an ID which can be used to unschedule the execution of the script (if ''seconds'' hasn't elapsed) using [[ns_unschedule_proc]].

: The script when executed will run in the scheduler thread. If the script is long-running, this may interfere with the execution of other scheduled scripts, in which case [[ns_schedule_proc]] should be used instead of '''ns_after'''.

'''EXAMPLES'''

% ns_after 5 { ns_log notice "ns_after script executed" }
123

'''SEE ALSO'''

: [[ns_info]] scheduled, [[ns_pause]], [[ns_resume]], [[ns_schedule_daily]], [[ns_schedule_proc]], [[ns_schedule_weekly]], [[ns_unschedule_proc]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns unschedule proc

2009-02-07T19:35:53Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_unschedule_proc.html

----

'''NAME'''

: ns_unschedule_proc - Unschedule a previously scheduled script

'''SYNOPSIS'''

: '''ns_unschedule_proc''' ''id''

'''DESCRIPTION'''

: This command unschedules a previous scheduled script. '''NOTE:''' Current behavior is to silently return without error if the ''id'' doesn't represent a currently scheduled ID.

'''EXAMPLES'''

% set id [[ns_schedule_proc -once 60 { test }]]
123

% ns_unschedule_proc $id

'''SEE ALSO'''

: [[ns_after]], [[ns_info]] scheduled, [[ns_pause]], [[ns_resume]], [[ns_schedule_proc]], [[ns_schedule_daily]], [[ns_schedule_weekly]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns server

2009-02-07T19:34:56Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_server.html

----

'''NAME'''

: ns_server - Get state of the server's connection pools and queues

'''SYNOPSIS'''

: '''ns_server''' ''option ?pool?''

'''DESCRIPTION'''

: This command provides a way to examine the current server's connection pools and queues. The legal ''option''s (which may be abbreviated) are:
* '''ns_server active''' ''?pool?''
* '''ns_server all''' ''?pool?''
* '''ns_server connections''' ''?pool?''
* '''ns_server keepalive''' ''?pool?''
* '''ns_server pools''' ''?pool?''
* '''ns_server queued''' ''?pool?''
* '''ns_server threads''' ''?pool?''

: Returns a list of key-value pairs identifying the number of connection threads and what state they are currently in.
* '''ns_server waiting''' ''?pool?''

'''NOTES'''

: See [http://sourceforge.net/tracker/index.php?func=detail&aid=745784&group_id=3152&atid=103152 Bug #745784] -- '''ns_server''' is not safe under load because: "The problem is either the connPtr or some of the data buried in the conn can be changing in the running connection thread. I wouldn't suggest this be fixed because it could complicate the code and introduce a performance problem."

'''EXAMPLES'''

% ns_server threads
{min 0} {max 10} {current 0} {idle 0} {stopping 0}

'''SEE ALSO'''

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns info

2009-02-07T19:34:25Z

Gustafn:

Man page: http://aolserver.com/man/4.0/tcl/ns_info.html

----

'''NAME'''

: ns_info - Return information about various aspects of the running AOLserver

'''SYNOPSIS'''

: '''ns_info''' ''option ?arg arg ...?''

'''DESCRIPTION'''

: This command provides information about the current state of the running AOLserver. The legal ''option''s (which may be abbreviated) are:
* '''ns_info address'''

: returns the primary IP address of this machine, or "0.0.0.0" if unable to determine
* '''ns_info argv0'''
* '''ns_info boottime'''

: returns the time in epoch seconds since the current server was started
* '''ns_info builddate'''

: returns the date and time at which the current server was compiled, e.g.: "Jul 20 2004 at 14:57:20"
* '''ns_info callbacks'''
* '''ns_info config'''

: returns the absolute path to the config file used to start the server
* '''ns_info home'''

: returns the current working directory of the server
* '''ns_info hostname'''

: returns the value of gethostname(), or "localhost" if that fails
* '''ns_info label'''

: returns the value of NSD_LABEL from nsd.h, e.g. "aolserver4_0"
* '''ns_info locks'''

: lists the mutexes that currently exist. A 5-element list is returned for each mutex: [[User:Dossy|Dossy]] mutex name, {}, unique id, lock counter, busy counter
* '''ns_info log'''

: returns the name of the error log specified by the "serverlog" parameter in the "ns/parameters" section, or "server.log" if not defined. Prepends the server's current working directory
* '''ns_info major'''

: returns the value of NS_MAJOR_VERSION from ns.h, e.g. "4"
* '''ns_info minor'''

: returns the value of NS_MINOR_VERSION from ns.h, e.g. "0"
* '''ns_info name'''

: returns the value of NSD_NAME from nsd.h (currently 'AOLserver')
* '''ns_info nsd'''

: returns the absolute path to the currently running nsd binary
* '''ns_info pageroot'''

: returns the absolute path to the page root
* '''ns_info patchlevel'''

: returns the value of NS_PATCH_LEVEL from ns.h, e.g. "4.0.7"
* '''ns_info pid'''

: returns the process ID of the current nsd process
* '''ns_info platform'''

: returns the name of the current platform, or "?" if unable to determine
* '''ns_info pools'''
* '''ns_info scheduled'''
* '''ns_info server'''
* '''ns_info servers'''
* '''ns_info sockcallbacks'''
* '''ns_info tag'''

: returns the CVS tag (NSD_TAG from nsd.h); not guaranteed to be useful
* '''ns_info tcllib'''
* '''ns_info threads'''
* '''ns_info uptime'''
* '''ns_info version'''
* '''ns_info winnt'''

'''EXAMPLES'''

'''SEE ALSO'''

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns env

2009-02-07T19:33:52Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_env.html

----

'''NAME'''

: ns_env - Return, change or add a value of an environment variable

'''SYNOPSIS'''

: '''ns_env''' ''option ?arg arg ...?''

'''DESCRIPTION'''

: This command provides thread-safe (unlike Tcl env array) access to the environemnt variables of the currently running [[nsd]] process. The legal ''option''s (which may '''NOT''' be abbreviated) are:
: '''ns_env names'''
: '''ns_env exists''' ''name''
: '''ns_env get''' ''?-nocomplain? name''
: '''ns_env set''' ''name value''
: '''ns_env unset''' ''?-nocomplain? name''

: This command has yet to be Tcl_Obj'ified.

'''EXAMPLES'''

<pre>
% ns_env names
CONSOLE TERM INIT_VERSION PATH RUNLEVEL PWD PREVLEVEL SHLVL HOME

% ns_env get PATH
/usr/local/sbin:/sbin:/bin:/usr/sbin:/usr/bin

% ns_env set USER nsd

% ns_env get USER
nsd

% ns_env unset USER
</pre>

'''SEE ALSO'''

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns atsignal

2009-02-07T19:33:02Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_atsignal.html

----

'''NAME'''

ns_atsignal - Queue a script to run when the server receives the SIGHUP signal

'''SYNOPSIS'''

'''ns_atsignal''' ''script ?arg?''

'''DESCRIPTION'''

This command queues a script to run when the server receives the SIGHUP signal. The script and optional arg are concatenated together and added to the list of signal callbacks. The scripts are executed in the global scope in LIFO (last in, first out) order.

'''EXAMPLES'''

'''SEE ALSO'''

[[ns_atclose]], [[ns_atexit]], [[ns_atshutdown]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns atshutdown

2009-02-07T19:32:38Z

Gustafn:

Man page: http://aolserver.com/docs/tcl/ns_atshutdown.html

----

'''NAME'''

ns_atshutdown - Queue a script to run when the server is shutting down

'''SYNOPSIS'''

'''ns_atshutdown''' ''script ?arg?''

'''DESCRIPTION'''

This command queues a script to run when the server is shutting down. The script and optional arg are concatenated together and added to the list of shutdown callbacks. The scripts are executed in the global scope in LIFO (last in, first out) order.

'''EXAMPLES'''

Use [[ns_atsignal]] to stop long running processes. It seems that [[ns_atshutdown]] and [[ns_atexit]] are called after connection and scheduled threads have been killed, so those commands can not be used for that type of signal.

# Create share variables for each signal
foreach signal {SIGHUP TERM EXIT} {
nsv_set . $signal 0
ns_log notice "Listening for $signal"
}
proc heard_signal signal {
nsv_set . $signal 1
ns_log notice "Heard $signal"
}
ns_atsignal heard_signal SIGHUP
ns_atshutdown heard_signal TERM
ns_atexit heard_signal EXIT

# Long running proc
proc infinite_loop {} {
set status "RUN"
while {1} {
# Do some work
ns_sleep 1
ns_log notice "infinite_loop working, status: $status"
# Poll for signals
foreach signal {SIGHUP TERM EXIT} {
if {[nsv_get . $signal]} {
set status $signal
}
}
if {$signal ne "RUN"} {
break
}
}
# Save work
ns_log notice "infinite_loop stopped, status: $status"
}
ns_schedule_proc -thread -once 10 infinite_loop

Sample log file output from AOLserver 4.0.3 for [[ns_atsignal]]:

[01/Aug/2006:10:30:56][1359.1][-main-] Notice: Heard SIGHUP
[01/Aug/2006:10:30:56][1359.8][-sched:12-] Notice: infinite_loop stopped, status: SIGHUP
[01/Aug/2006:10:30:56][1359.9][-conn:server::0] Notice: infinite_loop stopped, status: SIGHUP

Sample log file output from AOLserver 4.0.3 for [[ns_atshutdown]] and [[ns_atexit]]:

[31/Jul/2006:15:57:52][3583.1][-main-] Notice: nsmain: AOLserver/4.0.3 stopping
[31/Jul/2006:15:57:52][3583.1][-main-] Notice: serv: stopping server: server
[31/Jul/2006:15:57:52][3583.1][-main-] Notice: serv: connection threads stopped
[31/Jul/2006:15:57:52][3583.1][-main-] Notice: driver: shutdown complete
[31/Jul/2006:15:57:52][3583.1][-main-] Notice: sched: shutdown pending
[31/Jul/2006:15:57:52][3583.3][-sched-] Notice: sched: shutdown started
[31/Jul/2006:15:57:52][3583.3][-sched-] Notice: sched: waiting for event threads...
[31/Jul/2006:15:57:52][3583.8][-sched:idle0-] Notice: exiting
[31/Jul/2006:15:57:52][3583.3][-sched-] Notice: sched: shutdown complete
[31/Jul/2006:15:57:53][3583.9][-shutdown-] Notice: Heard TERM
[31/Jul/2006:15:57:53][3583.9][-shutdown-] Notice: nslog: closing '/var/log/aolserver/server.log'
[31/Jul/2006:15:57:53][3583.1][-main-] Notice: Heard EXIT

'''SEE ALSO'''

[[ns_atclose]], [[ns_atexit]], [[ns_atsignal]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]