Nsproxy - Revision history

Gustafn at 19:03, 7 February 2009

2009-02-07T19:03:28Z

Gustafn at 18:57, 7 February 2009

2009-02-07T18:57:19Z

Gustafn at 14:18, 31 January 2009

2009-01-31T14:18:17Z

Gustafn at 14:17, 31 January 2009

2009-01-31T14:17:56Z

Gustafn at 14:14, 31 January 2009

2009-01-31T14:14:02Z

Gustafn at 14:11, 31 January 2009

2009-01-31T14:11:52Z

Gustafn at 14:07, 31 January 2009

2009-01-31T14:07:29Z

Gustafn at 14:03, 31 January 2009

2009-01-31T14:03:51Z

Gustafn at 14:03, 31 January 2009

2009-01-31T14:03:19Z

Gustafn at 13:59, 31 January 2009

2009-01-31T13:59:06Z

← Older revision		Revision as of 19:03, 7 February 2009
Line 117:		Line 117:
	: [[ns_eval]]		: [[ns_eval]]

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

← Older revision		Revision as of 18:57, 7 February 2009
Line 116:		Line 116:

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

@@ Line 6: / Line 6: @@
 : '''ns_proxy active''' ''pool''
-: '''ns_proxy cleanup''
+: '''ns_proxy cleanup'''
 : '''ns_proxy config''' ''pool ?-opt val -opt val ...''
 : '''ns_proxy eval''' ''handle script ?timeout?''

@@ Line 5: / Line 5: @@
 '''SYNOPSIS'''
-: '''ns_proxy''' ''option ?arg arg ...?''
+: '''ns_proxy active''' ''pool''
 '''DESCRIPTION'''

@@ Line 1: / Line 1: @@
 '''NAME'''
-: ns_proxy - Set connection to streaming state for streaming content via ns_write
+: ns_proxy - Execute Tcl scripts in an external process (aolserver module)
 '''SYNOPSIS'''

@@ Line 29: / Line 29: @@
 : Evalutes script in the proxy specified by handle. The optional ''timeout'' argument specifies a maximum number of milliseconds to wait for the command to complete before raising an error (see ERROR HANDLING below for details on handling errors).
-* '''ns_proxy get''' ''poolname'' ''?'' '''-handles''' ''value?'' ''?'' '''-timeout''' ''value?''
+* '''ns_proxy get''' ''pool'' ''?'' '''-handles''' ''value?'' ''?'' '''-timeout''' ''value?''
 : Returns one or more handles to proxies from the specified pool. The pool will be created with default options if it does not already exist. The option ''-handle'' can be used to specify the number of handles allocated (default: 1). The option ''timeout'' specifies the maximum amount of time in milliseconds to wait for the handles to become available before raising an error. Requesting more than one handle in a single call (if more than one handle is required) is necessary as it is an error to request handles from a pool from which handles are already owned by the thread. This restriction is implemented to avoid possible deadlock conditions. The handle returned by this command can be used as a scalar value for other '''ns_proxy''' commands, or it can be used as Tcl command itself (see '''ns_proxy eval''' for more information).
-* '''ns_proxy release''' ''handle''
+* '''ns_proxy ping''' ''handle''
-: Release a single handle. All handles owned by a thread must be returned before any handles can be allocated again.
+: Check if ''handle'' is alive by sending an empty request. This command is not normally required as the '''ns_proxy eval''' command will also verify and restart proxies as needed.
-* '''ns_proxy ping''' ''handle''
+: Receives a response from a script that was sent via '''ns_proxy send''' and waited on via '''ns_proxy wait'''.
-: Check if ''handle'' is alive by sending an empty request.
+* '''ns_proxy release''' ''handle''
 * '''ns_proxy send''' ''handle script''
-: Sends ''script'' in the proxy specified by handle. Unlike with '''ns_proxy eval''', this option will return immediately while the script continues to execute in the proxy process. A later ns_proxy wait followed by an '''ns_proxy recv''' is expected.
+: Sends ''script'' in the proxy specified by handle. Unlike with '''ns_proxy eval''', this option will return immediately while the script continues to execute in the proxy process. A later '''ns_proxy wait''' followed by an '''ns_proxy recv''' is expected.
 * '''ns_proxy wait''' ''handle ?timeout?''
 : Waits for a script sent via '''ns_proxy send''' in the proxy specified by the ''handle'' argument to complete. The optional ''timeout'' parameter specifies the number of milliseconds to wait for the script to complete, the default is an indefinite wait.
@@ Line 82: / Line 80: @@
 '''EXAMPLES'''
-: ns_proxy get default
+The following demonstrates sending a script to a remote proxy:
 '''SEE ALSO'''
-: [[ns_limits]]
+: [[ns_eval]]

@@ Line 23: / Line 23: @@
 * '''ns_proxy config''' ''pool'' ''?'' '''-init''' ''script? ?'' '''-reinit''' ''script? ?'' '''-min''' ''value? ?'' '''-max''' ''value? ?'' '''-exec''' ''program? ?'' '''-gettimeout''' ''value? ?'' '''-evaltimeout''' ''value? ?'' '''-sendtimeout''' ''value? ?'' '''-recvtimeout''' ''value? ?'' '''-waittimeout''' ''value?
-: Configure the specified pool or obtain current configuration values. When '''ns_proxy config''' is called without options, a list of the current options in the form ''-opt val ...'' is returned. ''init'' can be used to specify a script to be evaluated, when the proxy (slave) is started. This can be used to load additional libraries and/or source script files. The default is no script. ''reinit'' Specifies a script to evaluate after being allocated and before being returned to the caller. This can be used to re-initalizes shared state. The default is no script. ''min'' and ''max'' are the minimum and maximum number of slaves ('''min''' defaults to 0, '''max''' 0 means to disable this pool).  ''exec'' names the program (filename) to be executed. This defaults to '''nsproxy''' in the '''bin''' subdirectory of the AOLserver process. It is possible to create a custom program and enter the proxy event loop with the Ns_ProxyMain application startup routine; see the source code for details. ''gettimeout'' specifies the maximum time in ms to wait to allocate handles from the pool (default 500). ''evaltimeout'' specifies the maximum time in ms to wait for a script to be evaluated in a proxy (default 100). This parameter can be overridden on a per-call basis with the optional ''timeout'' parameter to '''ns_proxy eval'''. The default is 0 milliseconds i.e. infinite. ''sendtimeout'' and ''recvtimeout'' specify the maximum time to wait to send a script and receive a result from a proxy (default 100 milliseconds). ''waittimeout'' specifies  the maximum time to wait for a proxy to exit. The wait is performed in a dedicated reaper thread. The reaper will close the connection pipe and wait the given timeout. If the timeout is exceeded, the reaper will send a SIGTERM signal and finally a SIGKILL signal to ensure the process eventually exits. The default is 100 milliseconds which should be ample time for a graceful exit unless the process is hung executing a very long, misbehaving script, resulting in a more disruptive SIGTERM or SIGKILL.
+: Configure the specified pool or obtain current configuration values. When '''ns_proxy config''' is called without options, a list of the current options in the form ''-opt val ...'' is returned. '''init''' can be used to specify a script to be evaluated, when the proxy (slave) is started. This can be used to load additional libraries and/or source script files. The default is no script. '''reinit''' Specifies a script to evaluate after being allocated and before being returned to the caller. This can be used to re-initalizes shared state. The default is no script. '''min''' and '''max''' are the minimum and maximum number of slaves ('''min''' defaults to 0, '''max''' 0 means to disable this pool).  '''exec''' names the program (filename) to be executed. This defaults to '''nsproxy''' in the '''bin''' subdirectory of the AOLserver process. It is possible to create a custom program and enter the proxy event loop with the Ns_ProxyMain application startup routine; see the source code for details. '''gettimeout''' specifies the maximum time in ms to wait to allocate handles from the pool (default 500). '''evaltimeout''' specifies the maximum time in ms to wait for a script to be evaluated in a proxy (default 100). This parameter can be overridden on a per-call basis with the optional ''timeout'' parameter to '''ns_proxy eval'''. The default is 0 milliseconds i.e. infinite. '''sendtimeout''' and '''recvtimeout''' specify the maximum time to wait to send a script and receive a result from a proxy (default 100 milliseconds). '''waittimeout''' specifies  the maximum time to wait for a proxy to exit. The wait is performed in a dedicated reaper thread. The reaper will close the connection pipe and wait the given timeout. If the timeout is exceeded, the reaper will send a SIGTERM signal and finally a SIGKILL signal to ensure the process eventually exits. The default is 100 milliseconds which should be ample time for a graceful exit unless the process is hung executing a very long, misbehaving script, resulting in a more disruptive SIGTERM or SIGKILL.
 * '''ns_proxy get''' ''poolname'' ''?'' '''-handles''' ''value?'' ''?'' '''-timeout''' ''value?''
-: Returns one or more handles to proxies from the specified pool. The pool will be created with default options if it does not already exist. The option ''-handle'' can be used to specify the number of handles allocated (default: 1). The option ''timeout'' specifies the maximum amount of time in milliseconds to wait for the handles to become available before raising an error. Requesting more than one handle in a single call (if more than one handle is required) is necessary as it is an error to request handles from a pool from which handles are already owned by the thread. This restriction is implemented to avoid possible deadlock conditions. The handle returned by this command can be used as a scalar value for other ''ns_proxy'' commands, or it can be used as Tcl command itself (see ns_proxy eval for more information).
+: Returns one or more handles to proxies from the specified pool. The pool will be created with default options if it does not already exist. The option ''-handle'' can be used to specify the number of handles allocated (default: 1). The option ''timeout'' specifies the maximum amount of time in milliseconds to wait for the handles to become available before raising an error. Requesting more than one handle in a single call (if more than one handle is required) is necessary as it is an error to request handles from a pool from which handles are already owned by the thread. This restriction is implemented to avoid possible deadlock conditions. The handle returned by this command can be used as a scalar value for other '''ns_proxy''' commands, or it can be used as Tcl command itself (see '''ns_proxy eval''' for more information).
 * '''ns_proxy release''' ''handle''
 : Release a single handle. All handles owned by a thread must be returned before any handles can be allocated again.

@@ Line 12: / Line 12: @@
 : The legal ''option''s are:
 * '''ns_proxy get''' ''poolname'' ''?'' '''-handles''' ''value?'' ''?'' '''-timeout''' ''value?''
@@ Line 25: / Line 37: @@
 : Evalutes script in the proxy specified by handle. The optional ''timeout'' argument specifies a maximum number of milliseconds to wait for the command to complete before raising an error.
 * '''ns_proxy ping''' ''handle''
@@ Line 37: / Line 45: @@
 : Check if ''handle'' is alive by sending an empty request.
 * '''ns_proxy send''' ''handle script''