C API Reference
Table of Contents
I.
Memory Allocation Functions
Ns_Calloc
— Allocate a zero-filled block of memory
Ns_Free
— Free a block of allocated memory
Ns_Malloc
— Allocate a block of memory
Ns_Realloc
— Resize a previously allocated block of memory
II.
Ns_Set Data Structure Functions
Ns_SetCopy
— Create a new copy of a set
Ns_SetCreate
— Create a new Ns_Set
Ns_SetDelete
— Remove a field from a set by field index
Ns_SetDeleteKey
— Remove a field from a set by key name
Ns_SetFind
— Locate the index of a field within an Ns_Set
Ns_SetFree
— Free memory used by an Ns_Set
Ns_SetGet
— Return the value for a field
Ns_SetIDeleteKey
— Remove a field from a set by key name case-insentively
Ns_SetIFind
— Locate the index of a field case-insensitively
Ns_SetIGet
— Return the value for a field case-insensitively
Ns_SetIUnique
— Check if a key in an Ns_Set is unique (case insensitive)
Ns_SetKey
— Return the key name of a field
Ns_SetLast
— Return the index of the last element of a set
Ns_SetListFind
— Locate a set by name in a set list
Ns_SetListFree
— Free a list of sets
Ns_SetMerge
— Merge two sets
Ns_SetMove
— Move fields from one set to the end of another
Ns_SetName
— Return the name of a set
Ns_SetPrint
— Print the contents of a set to the AOLserver error log
Ns_SetPut
— Add a field to an Ns_Set
Ns_SetPutValue
— Set the value of a field
Ns_SetSize
— Return the current size of a set
Ns_SetSplit
— Split a set into an array of new sets
Ns_SetTrunc
— Truncate an Ns_Set
Ns_SetUnique
— Check if a key in an Ns_Set is unique (case sensitive)
Ns_SetUpdate
— Update an Ns_Set value
Ns_SetValue
— Return the value of a field
Ns_TclEnterSet
— Make an Ns_Set accessible through Tcl
Ns_TclFreeSet
— Free an Ns_Set
Ns_TclGetSet2
— Return the Ns_Set for the specified set ID in a pointer
Ns_TclGetSet
— Return the Ns_Set for the specified set ID
III.
Ns_DString Data Structure Functions
Ns_DStringAppend
— Append a string to an Ns_DString
Ns_DStringAppendArg
— Append argument to an Ns_DString
Ns_DStringExport
— Export the string of an Ns_DString
Ns_DStringFree
— Free any allocated memory used by an Ns_DString
Ns_DStringInit
— Initialize an Ns_DString
Ns_DStringLength
— Return the current length of an Ns_DString
Ns_DStringNAppend
— Append n-characters of a string to an Ns_DString
Ns_DStringPrintf
— Append a formatted string to an Ns_DString
Ns_DStringTrunc
— Truncate an Ns_DString
Ns_DStringValue
— Return the current value of an Ns_DString
Ns_DStringVarAppend
— Append a variable number of strings to an Ns_DString
IV.
Ns_Conn Data Structure Functions
Ns_ConnAuthPasswd
— Return password
Ns_ConnAuthUser
— Return user name
Ns_ConnClose
— Close a connection
Ns_ConnCondSetHeaders
— Set the value for a header field conditionally
Ns_ConnConstructHeaders
— Put HTTP header into DString
Ns_ConnContentLength
— Return content length
Ns_ConnContentSent
— Check if browser sent content
Ns_ConnCopyToChannel
— Copy content to Tcl channel
Ns_ConnCopyToDString
— Copy data from connection to dynamic string
Ns_ConnCopyToFd
— Copy content to file descriptor
Ns_ConnCopyToFile
— Copy data from connection to a file
Ns_ConnDriverContext
— Return driver context
Ns_ConnDriverName
— Return driver name
Ns_ConnFlushContent
— Flush remaining content
Ns_ConnFlushHeaders
— Mark the end of the headers
Ns_ConnGetQuery
— Construct Ns_Set representing query data
Ns_ConnGets
— Read content into a buffer
Ns_ConnHeaders
— Return headers
Ns_ConnHost
— Return host
Ns_ConnInit
— Run socket init procedure
Ns_ConnLocation
— Return location
Ns_ConnModifiedSince
— Determine if content modified since a specified date
Ns_ConnOutputHeaders
— Get Ns_Set of headers to send to client
Ns_ConnPeer
— Return name of peer
Ns_ConnPeerPort
— Return peer port
Ns_ConnPort
— Return port
Ns_ConnPrintfHeader
— Return a formatted header
Ns_ConnPuts
— Send a string to a client
Ns_ConnRead
— Read content into buffer
Ns_ConnReadHeaders
— Read headers into Ns_Set
Ns_ConnReadLine
— Read a line from a connection
Ns_ConnRedirect
— Perform internal redirect
Ns_ConnReplaceHeaders
— Replace output headers for connection
Ns_ConnResponseLength
— Return response length
Ns_ConnResponseStatus
— Return response status
Ns_ConnReturnAdminNotice
— Return a short notice to a client to contact system administrator
Ns_ConnReturnBadRequest
— Return an "invalid request" HTTP status line.
Ns_ConnReturnData
— Return an HTML string to a client
Ns_ConnReturnFile
— Return a file to a client
Ns_ConnReturnForbidden
— Return a "request forbidden" HTTP status line.
Ns_ConnReturnHtml
— Return an HTML string to a client
Ns_ConnReturnInternalError
— Return an "internal error" HTTP status line.
Ns_ConnReturnNoResponse
— Return a "no response" HTTP status line.
Ns_ConnReturnNotFound
— Return a "not found" HTTP status line.
Ns_ConnReturnNotImplemented
— Return a "not implemented" HTTP status line.
Ns_ConnReturnNotModified
— Return a "not modified" HTTP status line.
Ns_ConnReturnNotice
— Return a short notice to a client
Ns_ConnReturnOk
— Return an "OK" HTTP status line.
Ns_ConnReturnOpenChannel
— Write channel content to conn
Ns_ConnReturnOpenFd
— Return a file to a client
Ns_ConnReturnOpenFile
— Return a file to a client
Ns_ConnReturnRedirect
— Return an HTTP redirect response to a client
Ns_ConnReturnStatus
— Return a status message to a client
Ns_ConnReturnUnauthorized
— Return an "unauthorized" HTTP status line.
Ns_ConnRunRequest
— Execute procedure for method and URL pattern
Ns_ConnSendChannel
— Send Tcl channel content to conn
Ns_ConnSendDString
— Write a DString to the conn
Ns_ConnSendFd
— Write file to connection content
Ns_ConnSendFp
— Write file to connection content
Ns_ConnServer
— Return name of server
Ns_ConnSetExpiresHeader
— Return an "expires" header for the given time
Ns_ConnSetHeaders
— Set the value for a header field
Ns_ConnSetLastModifiedHeader
— Return a last modified header using the given time
Ns_ConnSetLengthHeader
— Return a Content-Length header
Ns_ConnSetRequiredHeaders
— Return the required HTTP headers
Ns_ConnSetTypeHeader
— Return a Content-Type header
Ns_ConnWrite
— Send data to a client
Ns_DriverEnableKeepalive
— Enable HTTP keepalive on driver
V.
Configuration File Functions
Ns_ConfigGetBool
— Get a boolean configuration file variable
Ns_ConfigGetInt
— Get a configuration file integer variable
Ns_ConfigGetInt64
— Get a configuration file 64-bit integer variable
Ns_ConfigGetPath
— Return configuration file section name
Ns_ConfigGetSection
— Get the Ns_Set for a configuration file section
Ns_ConfigGetSections
— Return Ns_Sets with configuration file data
Ns_ConfigGetValue
— Get a configuration file variable
Ns_ConfigGetValueExact
— Get configuration variable case-sensitively
VI.
Cache Functions
Ns_CacheBroadcast
— Broadcast to condition variable
Ns_CacheCreate
— Create a new cache
Ns_CacheCreateEntry
— Create a cache entry
Ns_CacheCreateSz
— Create a size-based cache
Ns_CacheDeleteEntry
— Delete a cache entry
Ns_CacheFind
— Find a cache
Ns_CacheFindEntry
— Find a cache entry
Ns_CacheFirstEntry
— Get first cache entry
Ns_CacheFlush
— Flush all cache entries
Ns_CacheFlushEntry
— Delete a cache entry
Ns_CacheFree
— Free allocated memory
Ns_CacheGetValue
— Get value of cache entry
Ns_CacheKey
— Get key of cache entry
Ns_CacheLock
— Lock a cache
Ns_CacheMalloc
— Allocate memory
Ns_CacheName
— Get name of cache
Ns_CacheNextEntry
— Get next cache entry
Ns_CacheSetValue
— Set value of cache entry
Ns_CacheSetValueSz
— Set value of cache entry and adjust cache size
Ns_CacheSignal
— Signal cache's condition variable
Ns_CacheTimedWait
— Wait for condition variable to be set
Ns_CacheUnlock
— Unlock cache
Ns_CacheUnsetValue
— Reset cache entry to null
Ns_CacheWait
— Wait indefinitely for condition variable to be set
VII.
URL and File Functions
Ns_AbsoluteUrl
— Construct a URL from a URL and location
Ns_DecodeUrl
— Decode URL query data
Ns_EncodeUrl
— Encode URL query data
Ns_HomePath
— Construct a path name relative to the AOLserver home directory
Ns_MakePath
— Construct a path name from a list of path elements
Ns_ModulePath
— Construct a path from base path
Ns_NormalizePath
— Normalize a path name
Ns_PathIsAbsolute
— Check for an absolute path name
Ns_QueryToSet
— Parse query data into Ns_Set
Ns_RelativeUrl
— Get relative filename portion of URL
Ns_SetUrlToFileProc
— Customize relative file mapping
Ns_UrlIsDir
— Check if a directory that corresponds to a URL exists
Ns_UrlIsFile
— Check if a file that corresponds to a URL exists
Ns_UrlToFile
— Construct the filename that corresponds to a URL
VIII.
Database Functions
Ns_Db0or1Row
— Execute an SQL statement that must return £ 1 row
Ns_Db1Row
— Execute an SQL statement that must return one row
Ns_DbBindRow
— Return an Ns_Set structure of column names to be returned by the previously-executed SQL command
Ns_DbBouncePool
— Mark all database handles stale
Ns_DbCancel
— Cancel an active SQL select statement
Ns_DbDML
— Execute an SQL DML statement
Ns_DbDriverDbType
— Get database type
Ns_DbDriverName
— Get driver for database
Ns_DbExec
— Execute an SQL command
Ns_DbFlush
— Flush any waiting rows
Ns_DbGetRow
— Fetch the next waiting row after an Ns_DbSelect
Ns_DbInterpretSqlFile
— Parse DML statements and send to database
Ns_DbPoolAllowable
— Determine if pool is available
Ns_DbPoolDefault
— Get default pool
Ns_DbPoolDescription
— Get pool description
Ns_DbPoolGetHandle
— Get database handle from pool
Ns_DbPoolGetMultipleHandles
— Get multiple database handles from pool
Ns_DbPoolList
— Get a list of available pools for a server
Ns_DbPoolPutHandle
— Release a database handle for a pool
Ns_DbPoolTimedGetHandle
— Get database handle from pool with timeout
Ns_DbPoolTimedGetMultipleHandles
— Get multiple database handles from pool with timeout
Ns_DbQuoteValue
— Adds extra single quote to single quotes in string
Ns_DbRegisterDriver
— Register database driver with the server
Ns_DbSelect
— Send a row-generating query to the database
Ns_DbSetException
— Set last error message for database
Ns_DbSpExec
— Run a stored procedure
Ns_DbSpGetParams
— Get output parameters from a stored procedure
Ns_DbSpReturnCode
— Get return code from a stored procedure
Ns_DbSpSetParam
— Set input parameter for stored procedure
Ns_DbSpStart
— Start execution of a stored procedure
IX.
Mutex Functions
Ns_MutexDestroy
— Destroy a mutex object
Ns_MutexInit
— Initialize a mutex object
Ns_MutexLock
— Lock a mutex object
Ns_MutexUnlock
— Unlock a mutex object
X.
Critical Section Functions
Ns_CsDestroy
— Destroy a critical section object
Ns_CsEnter
— Enter a critical section
Ns_CsInit
— Initialize a critical section
Ns_CsLeave
— Leave a critical section
XI.
Thread Functions
Ns_ThreadCreate
— Create new thread
Ns_ThreadExit
— Free or exit thread
Ns_ThreadFree
— Free thread pool memory
Ns_ThreadGetName
— Get thread name
Ns_ThreadId
— Get thread ID
Ns_ThreadJoin
— Wait for thread exit
Ns_ThreadMalloc
— Allocate thread pool memory
Ns_ThreadPool
— Get thread pool memory
Ns_ThreadRealloc
— Realloc thread pool memory
Ns_ThreadSelf
— Get handle to thread
Ns_ThreadSetname
— Set thread name
Ns_ThreadYield
— Yield processor time to runnable threads
Ns_TlsAlloc
— Allocate thread local storage
Ns_TlsGet
— Get thread local storage
Ns_TlsSet
— Set thread local storage
XII.
Tcl Interpreter Functions
Ns_TclAllocateInterp
— Allocate an interpreter for a server
Ns_TclAppendInt
— Append integer to Tcl result
Ns_TclDeAllocateInterp
— Perform cleanup after deallocating a Tcl interpreter
Ns_TclDestroyInterp
— Mark Tcl interpreter for deletion
Ns_TclEnterSet
— Make an Ns_Set accessible through Tcl
Ns_TclEval
— Execute a Tcl script
Ns_TclFreeSet
— Free an Ns_Set
Ns_TclGetConn
— Get connection
Ns_TclGetOpenChannel
— Get open channel in interpreter
Ns_TclGetOpenFd
— Get open file descriptor
Ns_TclGetSet2
— Return the Ns_Set for the specified set ID in a pointer
Ns_TclGetSet
— Return the Ns_Set for the specified set ID
Ns_TclInitInterps
— Call a Tcl init procedure in the parent interpreter
Ns_TclInitModule
— Source Tcl module before server startup
Ns_TclInterpServer
— Return name of server
Ns_TclLibrary
— Return private Tcl directory
Ns_TclLogError
— Write errorInfo to log file
Ns_TclMarkForDelete
— Mark Tcl interpreter for deletion
Ns_TclRegisterAtCreate
— Register function for interpreter creation
Ns_TclRegisterDeferred
— Register a function for interpreter cleanup
XIII.
Utility Functions
Ns_StrCopy
— Copy a string or NULL value using Ns_Malloc
Ns_StrDup
— Copy a string using Ns_Malloc
Ns_StrToLower
— Lowercase string
Ns_StrToUpper
— Uppercase string
Ns_StrTrim
— Trim string
Ns_StrTrimLeft
— Trim blanks from left
Ns_StrTrimRight
— Trim blanks from right
Ns_StringPrint
— Print string
Ns_Strtok
— Perform strtok_r
XIV.
Server Information Functions
Ns_InfoBootTime
— Return server boot time
Ns_InfoBuildDate
— Return AOLserver build date
Ns_InfoConfigFile
— Return full path name of the configuration file in use.
Ns_InfoErrorLog
— Return error log name
Ns_InfoHomePath
— Return directory where the AOLserver is installed.
Ns_InfoHostname
— Return hostname of server
Ns_InfoLabel
— Return source code label for server
Ns_InfoPid
— Return server pid
Ns_InfoPlatform
— Return platform
Ns_InfoServerName
— Return AOLserver name string ("AOLserver").
Ns_InfoServerVersion
— Return AOLserver version string.
Ns_InfoServersStarted
— Determine if server has started
Ns_InfoShutdownPending
— Determine if a server shutdown is pending
Ns_InfoStarted
— Determine if server has started
Ns_InfoUptime
— Return time server has been running
XV.
Duplicated Verb-Noun Routines
Ns_UnlockMutex
— Unlock the mutual exclusion lock
Ns_WriteConn
— Send a specified length of data to the client
XVI.
Updated Validated Routines
Ns_AdpRegisterParser
— Register a parser for ADPs
Ns_AdjTime
— Adjust Ns_Time
Ns_Asctime
— Perform asctime_r
Ns_BindSock
— Bind socket as root
XVII.
2.x Backward-Compatibility Routines
Ns_AbsTimedWaitForEvent
— Wait for an event to be broadcast
Ns_AllocThreadLocalStorage
— Initialize a local thread storage variable.
Ns_BeginDetachedThread
— Create a detached thread
Ns_BeginThread
— Start a thread
Ns_BroadcastEvent
— Wake up events that are waiting to be triggered
XVIII.
2.x and 3.0 Routines Removed in 3.1
Ns_CacheTimedGetValue
— Wait for cache entry to be set
Ns_DestroyCriticalSection
— Free a critical section's resources
Ns_EnterCriticalSection
— Enter a critical section
Ns_InitializeCriticalSection
— Initialize a critical section
XIX.
All Functions, Alphabetically Listed
Ns_AbsoluteUrl
— Construct a URL from a URL and location
Ns_AuthorizeRequest
— Check access of a method and URL
Ns_AuthorizeUser
— Check username and password
Ns_CacheBroadcast
— Broadcast to condition variable
Ns_CacheCreate
— Create a new cache
Ns_CacheCreateEntry
— Create a cache entry
Ns_CacheCreateSz
— Create a size-based cache
Ns_CacheDeleteEntry
— Delete a cache entry
Ns_CacheFind
— Find a cache
Ns_CacheFindEntry
— Find a cache entry
Ns_CacheFirstEntry
— Get first cache entry
Ns_CacheFlush
— Flush all cache entries
Ns_CacheFlushEntry
— Delete a cache entry
Ns_CacheFree
— Free allocated memory
Ns_CacheGetValue
— Get value of cache entry
Ns_CacheKey
— Get key of cache entry
Ns_CacheLock
— Lock a cache
Ns_CacheMalloc
— Allocate memory
Ns_CacheName
— Get name of cache
Ns_CacheNextEntry
— Get next cache entry
Ns_CacheSetValue
— Set value of cache entry
Ns_CacheSetValueSz
— Set value of cache entry and adjust cache size
Ns_CacheSignal
— Signal cache's condition variable
Ns_CacheTimedWait
— Wait for condition variable to be set
Ns_CacheUnlock
— Unlock cache
Ns_CacheUnsetValue
— Reset cache entry to null
Ns_CacheWait
— Wait indefinitely for condition variable to be set
Ns_CheckStack
— Check for thread stack overflow
Ns_CloseOnExec
— Set close-on-exec flag
Ns_CondBroadcast
— Wake up all threads waiting on a cond
Ns_CondDestroy
— Free a cond's memory
Ns_CondInit
— Initialize a cond
Ns_CondSignal
— Wake up a single thread
Ns_CondTimedWait
— Block on a cond
Ns_CondWait
— Wait indefinitely on a cond
Ns_ConfigGetBool
— Get a boolean configuration file variable
Ns_ConfigGetInt64
— Get a configuration file 64-bit integer variable
Ns_ConfigGetInt
— Get a configuration file integer variable
Ns_ConfigGetPath
— Return configuration file section name
Ns_ConfigGetSection
— Get the Ns_Set for a configuration file section
Ns_ConfigGetSections
— Return Ns_Sets with configuration file data
Ns_ConfigGetValue
— Get a configuration file variable
Ns_ConfigGetValueExact
— Get configuration variable case-sensitively
Ns_ConnAuthPasswd
— Return password
Ns_ConnAuthUser
— Return user name
Ns_ConnClose
— Close a connection
Ns_ConnCondSetHeaders
— Set the value for a header field conditionally
Ns_ConnConstructHeaders
— Put HTTP header into DString
Ns_ConnContentLength
— Return content length
Ns_ConnContentSent
— Check if browser sent content
Ns_ConnCopyToChannel
— Copy content to Tcl channel
Ns_ConnCopyToDString
— Copy data from connection to dynamic string
Ns_ConnCopyToFd
— Copy content to file descriptor
Ns_ConnCopyToFile
— Copy data from connection to a file
Ns_ConnDriverContext
— Return driver context
Ns_ConnDriverName
— Return driver name
Ns_ConnFlushContent
— Flush remaining content
Ns_ConnFlushHeaders
— Mark the end of the headers
Ns_ConnGetQuery
— Construct Ns_Set representing query data
Ns_ConnGets
— Read content into a buffer
Ns_ConnHeaders
— Return headers
Ns_ConnHost
— Return host
Ns_ConnInit
— Run socket init procedure
Ns_ConnLocation
— Return location
Ns_ConnModifiedSince
— Determine if content modified since a specified date
Ns_ConnOutputHeaders
— Get Ns_Set of headers to send to client
Ns_ConnPeer
— Return name of peer
Ns_ConnPeerPort
— Return peer port
Ns_ConnPort
— Return port
Ns_ConnPrintfHeader
— Return a formatted header
Ns_ConnPuts
— Send a string to a client
Ns_ConnRead
— Read content into buffer
Ns_ConnReadHeaders
— Read headers into Ns_Set
Ns_ConnReadLine
— Read a line from a connection
Ns_ConnRedirect
— Perform internal redirect
Ns_ConnReplaceHeaders
— Replace output headers for connection
Ns_ConnResponseLength
— Return response length
Ns_ConnResponseStatus
— Return response status
Ns_ConnReturnAdminNotice
— Return a short notice to a client to contact system administrator
Ns_ConnReturnBadRequest
— Return an "invalid request" HTTP status line.
Ns_ConnReturnData
— Return an HTML string to a client
Ns_ConnReturnFile
— Return a file to a client
Ns_ConnReturnForbidden
— Return a "request forbidden" HTTP status line.
Ns_ConnReturnHtml
— Return an HTML string to a client
Ns_ConnReturnInternalError
— Return an "internal error" HTTP status line.
Ns_ConnReturnNoResponse
— Return a "no response" HTTP status line.
Ns_ConnReturnNotFound
— Return a "not found" HTTP status line.
Ns_ConnReturnNotImplemented
— Return a "not implemented" HTTP status line.
Ns_ConnReturnNotModified
— Return a "not modified" HTTP status line.
Ns_ConnReturnNotice
— Return a short notice to a client
Ns_ConnReturnOk
— Return an "OK" HTTP status line.
Ns_ConnReturnOpenChannel
— Write channel content to conn
Ns_ConnReturnOpenFd
— Return a file to a client
Ns_ConnReturnOpenFile
— Return a file to a client
Ns_ConnReturnRedirect
— Return an HTTP redirect response to a client
Ns_ConnReturnStatus
— Return a status message to a client
Ns_ConnReturnUnauthorized
— Return an "unauthorized" HTTP status line.
Ns_ConnRunRequest
— Execute procedure for method and URL pattern
Ns_ConnSendChannel
— Send Tcl channel content to conn
Ns_ConnSendDString
— Write a DString to the conn
Ns_ConnSendFd
— Write file to connection content
Ns_ConnSendFp
— Write file to connection content
Ns_ConnServer
— Return name of server
Ns_ConnSetExpiresHeader
— Return an "expires" header for the given time
Ns_ConnSetHeaders
— Set the value for a header field
Ns_ConnSetLastModifiedHeader
— Return a last modified header using the given time
Ns_ConnSetLengthHeader
— Return a Content-Length header
Ns_ConnSetRequiredHeaders
— Return the required HTTP headers
Ns_ConnSetTypeHeader
— Return a Content-Type header
Ns_ConnWrite
— Send data to a client
Ns_CsDestroy
— Destroy a critical section object
Ns_CsEnter
— Enter a critical section
Ns_CsInit
— Initialize a critical section
Ns_CsLeave
— Leave a critical section
Ns_Ctime
— Perform ctime_r
Ns_DStringAppend
— Append a string to an Ns_DString
Ns_DStringAppendArg
— Append argument to an Ns_DString
Ns_DStringExport
— Export the string of an Ns_DString
Ns_DStringFree
— Free any allocated memory used by an Ns_DString
Ns_DStringInit
— Initialize an Ns_DString
Ns_DStringLength
— Return the current length of an Ns_DString
Ns_DStringNAppend
— Append n-characters of a string to an Ns_DString
Ns_DStringPrintf
— Append a formatted string to an Ns_DString
Ns_DStringTrunc
— Truncate an Ns_DString
Ns_DStringValue
— Return the current value of an Ns_DString
Ns_DStringVarAppend
— Append a variable number of strings to an Ns_DString
Ns_Db0or1Row
— Execute an SQL statement that must return £ 1 row
Ns_Db1Row
— Execute an SQL statement that must return one row
Ns_DbBindRow
— Return an Ns_Set structure of column names to be returned by the previously-executed SQL command
Ns_DbBouncePool
— Mark all database handles stale
Ns_DbCancel
— Cancel an active SQL select statement
Ns_DbDML
— Execute an SQL DML statement
Ns_DbDriverDbType
— Get database type
Ns_DbDriverName
— Get driver for database
Ns_DbExec
— Execute an SQL command
Ns_DbFlush
— Flush any waiting rows
Ns_DbGetRow
— Fetch the next waiting row after an Ns_DbSelect
Ns_DbInterpretSqlFile
— Parse DML statements and send to database
Ns_DbPoolAllowable
— Determine if pool is available
Ns_DbPoolDefault
— Get default pool
Ns_DbPoolDescription
— Get pool description
Ns_DbPoolGetHandle
— Get database handle from pool
Ns_DbPoolGetMultipleHandles
— Get multiple database handles from pool
Ns_DbPoolList
— Get a list of available pools for a server
Ns_DbPoolPutHandle
— Release a database handle for a pool
Ns_DbPoolTimedGetHandle
— Get database handle from pool with timeout
Ns_DbPoolTimedGetMultipleHandles
— Get multiple database handles from pool with timeout
Ns_DbQuoteValue
— Adds extra single quote to single quotes in string
Ns_DbRegisterDriver
— Register database driver with the server
Ns_DbSelect
— Send a row-generating query to the database
Ns_DbSetException
— Set last error message for database
Ns_DbSpExec
— Run a stored procedure
Ns_DbSpGetParams
— Get output parameters from a stored procedure
Ns_DbSpReturnCode
— Get return code from a stored procedure
Ns_DbSpSetParam
— Set input parameter for stored procedure
Ns_DbSpStart
— Start execution of a stored procedure
Ns_DecodeUrl
— Decode URL query data
Ns_DestroyCriticalSection
— Free a critical section's resources
Ns_DestroyEvent
— Free an event's resources
Ns_DestroyMutex
— Free a mutual exclusion lock's resources
Ns_DestroyRWLock
— Destroy a read/write lock
Ns_DestroySemaphore
— Free a semaphore's resources
Ns_DiffTime
— Get difference between two times
Ns_DriverEnableKeepalive
— Enable HTTP keepalive on driver
Ns_DupHigh
— Move file descriptors
Ns_EncodeUrl
— Encode URL query data
Ns_Encrypt
— Encrypt key
Ns_EnterCriticalSection
— Enter a critical section
Ns_ExecArgblk
— Execute file with argument string
Ns_ExecArgv
— Execute file with argument array
Ns_ExecProc
— Execute file with argument array
Ns_ExecProcess
— Execute file with argument string
Ns_ExitThread
— Free a thread or mark as exited
Ns_Fatal
— Log a fatal error and shutdown
Ns_FetchPage
— Copy data from URL to dynamic string
Ns_FetchURL
— Fetch a remote URL.
Ns_Fork
— Perform a fork
Ns_Free
— Free a block of allocated memory
Ns_FreeRequest
— Free memory used by an Ns_Request
Ns_GetConnInterp
— Get the Tcl interpreter for the connection
Ns_GetDriver
— Get socket driver
Ns_GetDriverContext
— Get socket driver context
Ns_GetDriverLabel
— Get socket driver label
Ns_GetDriverName
— Get socket driver name
Ns_GetDriverProc
— Get a communications driver procedure
Ns_GetFirstDriver
— Get pointer to first socket driver
Ns_GetHostByAddr
— Convert an IP address to a hostname
Ns_GetMimeType
— Get Mime type
Ns_GetNextDriver
— Get pointer to next socket driver
Ns_GetRequest
— Return the parameters of a request
Ns_GetSockAddr
— Get socket driver address
Ns_GetThread
— Get the identifier for the current thread
Ns_GetThreadId
— Get the unique ID number for the current thread
Ns_GetThreadLocalStorage
— Get the thread local storage
Ns_GetTime
— Perform gettimeofday
Ns_GetUid
— Return UID of user
Ns_GetUserHome
— Get UNIX user's home directory
Ns_Gmtime
— Perform gmtime
Ns_HomePath
— Construct a path name relative to the AOLserver home directory
Ns_HttpTime
— Return a formatted time string
Ns_HtuuDecode
— Perform base64 decode
Ns_HtuuEncode
— Perform base64 encode
Ns_IncrTime
— Increment time by seconds and microseconds
Ns_InetNtoa
— Perform inet_ntoa
Ns_InfoBootTime
— Return server boot time
Ns_InfoBuildDate
— Return AOLserver build date
Ns_InfoConfigFile
— Return full path name of the configuration file in use.
Ns_InfoErrorLog
— Return error log name
Ns_InfoHomePath
— Return directory where the AOLserver is installed.
Ns_InfoHostname
— Return hostname of server
Ns_InfoLabel
— Return source code label for server
Ns_InfoPid
— Return server pid
Ns_InfoPlatform
— Return platform
Ns_InfoServerName
— Return AOLserver name string ("AOLserver").
Ns_InfoServerVersion
— Return AOLserver version string.
Ns_InfoServersStarted
— Determine if server has started
Ns_InfoShutdownPending
— Determine if a server shutdown is pending
Ns_InfoStarted
— Determine if server has started
Ns_InfoUptime
— Return time server has been running
Ns_InitializeCriticalSection
— Initialize a critical section
Ns_InitializeEvent
— Initialize an event object
Ns_InitializeMutex
— Initialize a mutual exclusion lock
Ns_InitializeRWLock
— Initialize a read/write lock
Ns_InitializeSemaphore
— Initialize a semaphore
Ns_LeaveCriticalSection
— Leave a critical section
Ns_LibPath
— Construct path relative to lib
Ns_Localtime
— Perform localtime
Ns_LockMutex
— Create a mutual exclusion lock
Ns_Log
— Log formatted message
Ns_LogRoll
— Roll server log
Ns_LogTime
— Construct local date and time for log file
Ns_MakePath
— Construct a path name from a list of path elements
Ns_Malloc
— Allocate a block of memory
Ns_Match
— Compare strings
Ns_ModLog
— Log a message within a realm
Ns_ModLogGetThreshold
— Get the severity of the logging threshold of a handle
Ns_ModLogLookupHandle
— Obtain the handle given a realm
Ns_ModLogLookupRealm
— Obtain the realm from the handle
Ns_ModLogRedirect
— Redirect logging of a realm to a file
Ns_ModLogRegister
— Register a new realm
Ns_ModLogSetThreshold
— Set the logging severity of a handle
Ns_ModuleLoad
— Load a module into AOLserver
Ns_ModulePath
— Construct a path from base path
Ns_ModuleSymbol
— Return symbol
Ns_MutexDestroy
— Destroy a mutex object
Ns_MutexInit
— Initialize a mutex object
Ns_MutexLock
— Lock a mutex object
Ns_MutexUnlock
— Unlock a mutex object
Ns_NextWord
— Find next word in string
Ns_NormalizePath
— Normalize a path name
Ns_PageRoot
— Return path name of the AOLserver pages directory for a server.
Ns_ParseHeader
— Parse Http headers
Ns_ParseHttpTime
— Convert Http time into time_t
Ns_ParseRequest
— Parse an HTTP request line into an Ns_Request
Ns_ParseUrl
— Parse a URL
Ns_PathIsAbsolute
— Check for an absolute path name
Ns_PermPasswordCheck
— Check user's encrypted password
Ns_PoolAlloc
— Allocate memory within a pool
Ns_PoolCreate
— Create a new memory pool
Ns_PoolDestroy
— Destroy a memory pool
Ns_PoolDump
— Debug a memory pool
Ns_PoolFree
— Free pool memory
Ns_PoolRealloc
— Reallocate pool memory
Ns_PoolTrace
— Trace a memory pool
Ns_QueryToSet
— Parse query data into Ns_Set
Ns_QueueConn
— Make and queue a new conn
Ns_QuoteHtml
— Quote an HTML string
Ns_RWLockDestroy
— Destroy a read/write lock
Ns_RWLockInit
— Initialize a read/write lock
Ns_RWLockRdLock
— Acquire a read lock
Ns_RWLockUnlock
— Release a read/write lock
Ns_RWLockWrLock
— Acquire a write lock
Ns_ReadLockRWLock
— Acquire a read lock
Ns_ReadUnlockRWLock
— Release a read lock
Ns_Readdir
— Perform readdir
Ns_Realloc
— Resize a previously allocated block of memory
Ns_RegisterAtExit
— Register an exit procedure.
Ns_RegisterAtPreStartup
— Register a procedure for pre-server startup
Ns_RegisterAtSignal
— Register a procedure at HUP signal
Ns_RegisterAtStartup
— Register a procedure for server startup
Ns_RegisterCleanup
— Register a procedure for connection cleanup trace
Ns_RegisterDriver
— Register a socket driver
Ns_RegisterFilter
— Register a filter function to handle a method/URL combination
Ns_RegisterLocation
— Register location for socket driver
Ns_RegisterProxyRequest
— Register a function to proxy requests for a method/protocol combination
Ns_RegisterRequest
— Register one or two functions to handle HTTP requests for a method/URL combination
Ns_RegisterReturn
— Register a return status for a URL
Ns_RegisterServerShutdown
— Register a shutdown procedure for a server.
Ns_RegisterServerTrace
— Register a trace procedure for a server.
Ns_RegisterShutdown
— Register a shutdown procedure.
Ns_RelativeUrl
— Get relative filename portion of URL
Ns_ReleaseSemaphore
— Increment the semaphore count
Ns_RollFile
— Rename a file and increment its backup number
Ns_ScheduleDaily
— Schedule a procedure to run once a day
Ns_ScheduleProc
— Schedule a procedure to run at specified intervals
Ns_ScheduleProcEx
— Schedule a procedure to run at specified intervals
Ns_ScheduleWeekly
— Schedule a procedure to run once a week
Ns_SemaDestroy
— Destroy a semaphore object
Ns_SemaInit
— Initialize a semaphore
Ns_SemaPost
— Increment the semaphore count
Ns_SemaWait
— Wait for a semaphore count to be greater than zero.
Ns_ServerSpecificAlloc
— Return unique integer to use in other functions
Ns_ServerSpecificDestroy
— Delete server-specific data
Ns_ServerSpecificGet
— Retrieve server-specific data
Ns_ServerSpecificSet
— Store server-specific data for subsequent retrieval
Ns_SetCopy
— Create a new copy of a set
Ns_SetCreate
— Create a new Ns_Set
Ns_SetDelete
— Remove a field from a set by field index
Ns_SetDeleteKey
— Remove a field from a set by key name
Ns_SetDriverProc
— Set socket driver callback
Ns_SetEvent
— Wake up one waiting event
Ns_SetFind
— Locate the index of a field within an Ns_Set
Ns_SetFree
— Free memory used by an Ns_Set
Ns_SetGet
— Return the value for a field
Ns_SetIDeleteKey
— Remove a field from a set by key name case-insentively
Ns_SetIFind
— Locate the index of a field case-insensitively
Ns_SetIGet
— Return the value for a field case-insensitively
Ns_SetIUnique
— Check if a key in an Ns_Set is unique (case insensitive)
Ns_SetKey
— Return the key name of a field
Ns_SetLast
— Return the index of the last element of a set
Ns_SetListFind
— Locate a set by name in a set list
Ns_SetListFree
— Free a list of sets
Ns_SetMerge
— Merge two sets
Ns_SetMove
— Move fields from one set to the end of another
Ns_SetName
— Return the name of a set
Ns_SetPrint
— Print the contents of a set to the AOLserver error log
Ns_SetPut
— Add a field to an Ns_Set
Ns_SetPutValue
— Set the value of a field
Ns_SetRequestAuthorizeProc
— Set function used by Ns_AuthorizeRequest
Ns_SetRequestUrl
— Fill in request structure
Ns_SetSize
— Return the current size of a set
Ns_SetSplit
— Split a set into an array of new sets
Ns_SetThreadLocalStorage
— Set thread local storage
Ns_SetTrunc
— Truncate an Ns_Set
Ns_SetUnique
— Check if a key in an Ns_Set is unique (case sensitive)
Ns_SetUpdate
— Update an Ns_Set value
Ns_SetUrlToFileProc
— Customize relative file mapping
Ns_SetUserAuthorizeProc
— Set function used by Ns_AuthorizeUser
Ns_SetValue
— Return the value of a field
Ns_Sigmask
— Perform sigprocmask
Ns_Signal
— Install signal handler
Ns_Sigwait
— Perform sigwait
Ns_SkipUrl
— Skip past path elements in the URL of a request
Ns_SockAsyncConnect
— Create a remote socket and return immediately
Ns_SockCallback
— Register a socket callback function
Ns_SockCancelCallback
— Remove a socket callback
Ns_SockConnect
— Create a socket to a remote host and port
Ns_SockListen
— Create a socket on a specified address and port
Ns_SockListenCallback
— Register a socket callback function and create socket
Ns_SockPipe
— Return a pair of connected sockets
Ns_SockPortBound
— Determine if port is bound
Ns_SockSetBlocking
— Set a socket in blocking mode
Ns_SockSetNonBlocking
— Set a socket in nonblocking mode
Ns_SockTimedConnect
— Create a remote socket within a specified time
Ns_StrCaseFind
— Perform strstr
Ns_StrCopy
— Copy a string or NULL value using Ns_Malloc
Ns_StrDup
— Copy a string using Ns_Malloc
Ns_StrToLower
— Lowercase string
Ns_StrToUpper
— Uppercase string
Ns_StrTrim
— Trim string
Ns_StrTrimLeft
— Trim blanks from left
Ns_StrTrimRight
— Trim blanks from right
Ns_StringPrint
— Print string
Ns_Strtok
— Perform strtok_r
Ns_TclAllocateInterp
— Allocate an interpreter for a server
Ns_TclAppendInt
— Append integer to Tcl result
Ns_TclDeAllocateInterp
— Perform cleanup after deallocating a Tcl interpreter
Ns_TclDestroyInterp
— Mark Tcl interpreter for deletion
Ns_TclEnterSet
— Make an Ns_Set accessible through Tcl
Ns_TclEval
— Execute a Tcl script
Ns_TclFreeSet
— Free an Ns_Set
Ns_TclGetConn
— Get connection
Ns_TclGetOpenChannel
— Get open channel in interpreter
Ns_TclGetOpenFd
— Get open file descriptor
Ns_TclGetSet2
— Return the Ns_Set for the specified set ID in a pointer
Ns_TclGetSet
— Return the Ns_Set for the specified set ID
Ns_TclInitInterps
— Call a Tcl init procedure in the parent interpreter
Ns_TclInitModule
— Source Tcl module before server startup
Ns_TclInterpServer
— Return name of server
Ns_TclLibrary
— Return private Tcl directory
Ns_TclLogError
— Write errorInfo to log file
Ns_TclMarkForDelete
— Mark Tcl interpreter for deletion
Ns_TclRegisterAtCreate
— Register function for interpreter creation
Ns_TclRegisterDeferred
— Register a function for interpreter cleanup
Ns_ThreadCreate
— Create new thread
Ns_ThreadExit
— Free or exit thread
Ns_ThreadFree
— Free thread pool memory
Ns_ThreadGetName
— Get thread name
Ns_ThreadId
— Get thread ID
Ns_ThreadJoin
— Wait for thread exit
Ns_ThreadMalloc
— Allocate thread pool memory
Ns_ThreadPool
— Get thread pool memory
Ns_ThreadRealloc
— Realloc thread pool memory
Ns_ThreadSelf
— Get handle to thread
Ns_ThreadSetname
— Set thread name
Ns_ThreadYield
— Yield processor time to runnable threads
Ns_TimedWaitForEvent
— Wait for an event for a specified time
Ns_TlsAlloc
— Allocate thread local storage
Ns_TlsGet
— Get thread local storage
Ns_TlsSet
— Set thread local storage
Ns_UTimedWaitForEvent
— Wait for an event for a specified time, in microseconds
Ns_UnRegisterProxyRequest
— Unregister a proxy request function
Ns_UnRegisterRequest
— Unregister a function
Ns_UnlockMutex
— Unlock the mutual exclusion lock
Ns_UnscheduleProc
— Stop a scheduled procedure
Ns_UrlIsDir
— Check if a directory that corresponds to a URL exists
Ns_UrlIsFile
— Check if a file that corresponds to a URL exists
Ns_UrlSpecificAlloc
— Return unique integer to use in other functions
Ns_UrlSpecificDestroy
— Delete URL-specific data
Ns_UrlSpecificGet
— Retrieve URL-specific data
Ns_UrlSpecificGetExact
— Retrieve URL-specific data
Ns_UrlSpecificSet
— Store URL-specific data for subsequent retrieval
Ns_UrlToFile
— Construct the filename that corresponds to a URL
Ns_WaitForEvent
— Wait for an event
Ns_WaitForProcess
— Wait for process to exit
Ns_WaitForSemaphore
— Wait for a semaphore count to be greater than zero.
Ns_WaitForStartup
— Block until server startup
Ns_WaitForThread
— Wait for a thread to exit
Ns_WaitProcess
— Wait for process to exit
Ns_WaitThread
— Wait for thread to exit
Ns_WriteConn
— Send a specified length of data to the client
Ns_WriteLockRWLock
— Acquire a write lock
Ns_WriteUnlockRWLock
— Release a write lock
Next
Memory Allocation Functions