ns_info(3)

NAME

Ns_HomePath, Ns_InfoAddress, Ns_InfoBootTime, Ns_In

foBuildDate, Ns_InfoConfigFile, Ns_InfoErrorLog, Ns_InfoHomePath,

Ns_InfoHostname, Ns_InfoLabel, Ns_InfoNameOfExecutable, Ns_In

foPid, Ns_InfoPlatform, Ns_InfoServerName, Ns_InfoServerVersion,

Ns_InfoServersStarted, Ns_InfoShutdownPending, Ns_InfoStarted,

Ns_InfoTag, Ns_InfoUptime, Ns_LibPath, Ns_PageRoot - Get server

information

SYNOPSIS

#include "ns.h"
char *
Ns_HomePath(Ns_DString *dest, ...)
char *
Ns_InfoAddress(void)
int
Ns_InfoBootTime(void)
char *
Ns_InfoBuildDate(void)
char *
Ns_InfoConfigFile(void)
char *
Ns_InfoErrorLog(void)
char *
Ns_InfoHomePath(void)
char *
Ns_InfoHostname(void)
char *
Ns_InfoLabel(void)
char *
Ns_InfoNameOfExecutable(void)
int
Ns_InfoPid(void)
char *
Ns_InfoPlatform(void)
char *
Ns_InfoServerName(void)
char *
Ns_InfoServerVersion(void)
int
Ns_InfoServersStarted(void)
int
Ns_InfoShutdownPending(void)
int
Ns_InfoStarted(void)
char *
Ns_InfoTag(void)
int
Ns_InfoUptime(void)
char *
Ns_LibPath(Ns_DString *dest, ...)
char *
Ns_PageRoot(char *server)

DESCRIPTION

These functions return information about the server.

Many of the functions return pointers to strings or other

types of information which, in most cases, you must not free.

These are denoted as "read-only" in the sections below.

Ns_HomePath(dest, ...)

Build a path relative to AOLserver's home directo

ry. The result is placed into dest. A string pointer that points

directly to the result string inside of the dest Ns_DString is

returned. This string pointer should be treated as read-only.

dest must only be freed by Ns_DStringFree.

Ns_InfoAddress()

Return the server IP address of the server. The IP

address is defined in the server configuration file. The IP ad

dress is returned as a string pointer which you must treat as

read-only. If you want to alter the string, you must use

ns_strdup to copy the string to another location in memory and

modify that instead.

Ns_InfoBootTime()

Return the time that the server was started as an

int. Treat the result as time_t.

Ns_InfoBuildDate()

Return the date and time that this server was com

piled as a string pointer. Treat the result as read-only.

Ns_InfoConfigFile()

Return the absolute path name of the configuration

file in use as a string pointer. Treat the result as read-only.

Ns_InfoErrorLog()

Return the name of the error log as a string point

er. Treat the result as read-only. The name may be just a name, a

relative path or an absolute path depending on how it is defined

in the server configuration file.

Ns_InfoHomePath()

Return the absolute directory path where AOLserver

is installed as a string pointer. Treat the result as read-only.

Ns_InfoHostname()

Return the hostname of the host that AOLserver is

running on as a string pointer. The gethostname(2) function is

used. If gethostname(2) fails to return a hostname, "localhost"

is used instead. Treat the result as read-only.

Ns_InfoLabel()

Return the source code label for AOLserver as a

string pointer. Statically defined in the source code. If no la

bel was used, "unlabeled" is returned. You can use these func

tions to provide the source code label when you report problems

with the server. Treat the result as read-only.

Ns_InfoNameOfExecutable()

Return the name of the running executable as a

string pointer. Treat the result as read-only.

Ns_InfoPid()

Return the pid of the running AOLserver executable

as an int.

Ns_InfoPlatform()

Return the platform name as a string pointer, e.g.

"linux". Treat the result as read-only.

Ns_InfoServerName()

Return the AOLserver name string, e.g. "AOLserver".

Statically defined in the source code. Treat the result as read

only.

Ns_InfoServerVersion()

Return the AOLserver version string, e.g. "3.5.2".

Statically defined in the source code. Treat the result as read

only.

Ns_InfoServersStarted()

Return TRUE if the server has started, i.e., if

initialization and module loading is complete. This is a compati

bility function that calls Ns_InfoStarted.

Ns_InfoShutdownPending()

Return TRUE if there is there a shutdown pending,

i.e. if an INTR signal has been received or if ns_shutdown has

been called.

Ns_InfoStarted()

Return TRUE if the server has started, i.e., if

initialization and module loading is complete.

Ns_InfoTag()

Return the CVS tag of this build of AOLserver.

Statically defined in the source code. The value may be meaning

less. Treat the result as read-only.

Ns_InfoUptime()

Return how long, in seconds, AOLserver has been

running.

Ns_LibPath(dest, ...)

Contsruct the path to AOLserver's lib directory

with the given path components appended to it. The result is

stored in dest. A string pointer that points directly to the re

sult string inside of the dest Ns_DString is returned. This

string pointer should be treated as read-only. dest must only be

freed by Ns_DStringFree.

For example, if AOLserver is running out of

/disk2/aolserver, then:

Ns_LibPath(dest, "foo", "bar", NULL);

would return "/disk2/aolserver/lib/foo/bar".

Ns_PageRoot(server)

Return the path name of the AOLserver pages direc

tory for a particular server as a string pointer. The server ar

gument is not used. Treat the result as read-only.

SEE ALSO

nsd(1), info(n)

KEYWORDS

Ns_Info(3)