Timeout (HttpRequest property) - Revision history

JAL2 at 21:50, 21 June 2011

2011-06-21T21:50:52Z

← Older revision		Revision as of 21:50, 21 June 2011
Line 9:		Line 9:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>currentNumber</th>		<tr><th>%currentNumber</th>
	<td>The numeric variable for the assignment of the current value of Timeout.</td></tr>		<td>The numeric variable for the assignment of the current value of <var>Timeout</var>.</td></tr>
	<tr><th>httpRequest</th>		<tr><th>httpRequest</th>
	<td>A previously defined and instantiated <var>HttpRequest</var> object.</td></tr>		<td>A previously defined and instantiated <var>HttpRequest</var> object.</td></tr>
Line 21:		Line 21:
	<ul>		<ul>
	<li>Typically, you set <var>Timeout</var> to the maximum wait you want your end users to experience.		<li>Typically, you set <var>Timeout</var> to the maximum wait you want your end users to experience.
	<li>If a <var>Get</var>, <var>Post</var>, or <var>Send</var> function times out, the function response is set to <var>null</var>, $STATUSD is set to 101, and whether the request is cancelled depends on the value of the <var ~~class="term"~~>Cancel</var> parameter set on the <var>Get</var>, <var>Post</var>, or <var>Send</var> call.		<li>If a <var>Get</var>, <var>Post</var>, or <var>Send</var> function times out, the function response is set to <var>null</var>, $STATUSD is set to 101, and whether the request is cancelled depends on the value of the <var>Cancel</var> parameter set on the <var>Get</var>, <var>Post</var>, or <var>Send</var> call.
	</ul>		</ul>

	==See also==		==See also==
	{{Template:HttpRequest:Timeout footer}}		{{Template:HttpRequest:Timeout footer}}

Goff: match syntax table to syntax template; edits, tags and links

2011-06-19T04:54:39Z

match syntax table to syntax template; edits, tags and links

← Older revision		Revision as of 04:54, 19 June 2011
Line 1:		Line 1:
	{{Template:HttpRequest:Timeout subtitle}}		{{Template:HttpRequest:Timeout subtitle}}
			The <var>Timeout</var> method lets you set and query a timeout value for a <var>[[Get (HttpRequest function)\|Get]]</var>, <var>[[Post (HttpRequest function)\|Post]]</var>, or <var>[[Send (HttpRequest function)\|Send]]</var> method invocation. The timeout (in wall-clock seconds) is the sum of the elapsed time of all network transfers for the <var>Get</var>, <var>Post</var>, or <var>Send</var> request, including connecting, sending the HTTP request, and fetching all the data (independent of how many TCP/IP get operations or HTTP chunks are required to obtain the response).

	~~This method lets~~		The <var>Timeout</var> value is also the timeout for each of the individual <var>Get</var>, <var>Post</var>, or <var>Send</var> network operations. That is, for each TCP/IP read or write operation (as well as for the
	~~you set and query a~~ timeout ~~value~~ for a <var>[[Get ~~(HttpRequest function)\|Get]]~~</var>,		sum of these operations), the <var>Timeout</var> property value overrides any <var class="product">Janus</var> port definition <var>[[TIMEOUT]]</var> setting for the socket. If no <var>Timeout</var> property value is set, the port <var>TIMEOUT</var> setting (if any) is used.
	<var>[[Post ~~(HttpRequest function)\|Post]]~~</var>,
	or <var>[[Send ~~(HttpRequest function)\|Send]]~~</var> ~~method invocation~~.
	~~The timeout~~ (~~in wall-clock seconds)~~
	~~is the~~ sum of the ~~elaped time of all network transfers for a~~ <var>~~Get~~</var>, <var>~~Post~~</var>~~, or~~ <var>~~Send~~</var>,
	~~including connecting, sending~~ the ~~HTTP request~~,
	~~and fetching all~~ the ~~data~~ (~~independent of how many~~
	~~TCP/IP get operations or HTTP chunks are required to obtain the~~
	~~response~~).

	~~The <var>Timeout</var> value is also the timeout for each of the~~
	~~inidvidual <var>Get</var>, <var>Post</var>, or <var>Send</var> network operations.~~
	~~That is, for each TCP/IP read or write operation (as well as for the~~
	~~sum of these operations),~~
	~~the <var>Timeout</var> property value overrides any <var class="product">Janus</var> port definition~~
	~~<var>[[TIMEOUT]]</var> setting for the socket.~~
	~~If no <var>Timeout</var> property value is set, the port <var>TIMEOUT</var> setting (if any) is used.~~
	==Syntax==		==Syntax==
	{{Template:HttpRequest:Timeout syntax}}		{{Template:HttpRequest:Timeout syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>~~%httpreq~~</th>		<tr><th>currentNumber</th>
	<td>An instantiated <var>HttpRequest</var> object.		<td>The numeric variable for the assignment of the current value of Timeout.</td></tr>
			<tr><th>httpRequest</th>
			<td>A previously defined and instantiated <var>HttpRequest</var> object.</td></tr>
			<tr><th>newNumber</th>
			<td>A numeric expression that evaluates to an integer from 0 through 32767, which indicates the maximum number of wall-clock seconds that a <var>Get</var>, <var>Post</var>, or <var>Send</var> method invocation may take. If an invalid or out of range value is specified, the request is canceled. A value of 0 (the default) means no timeout is enforced.
	</td></tr>		</td></tr>
	~~<tr><th>value</th>~~		</table>
	<td>A numeric expression that evaluates to an integer from 0 through 32767, which indicates the maximum number of wall-clock seconds that a Get, Post, or Send method invocation may take. If an invalid or out of range value is specified, the request is canceled. A value of 0 (the default) means no timeout is enforced.
	~~</td></tr>~~
	~~<tr><th>%curr~~</~~th>~~
	~~<td~~>~~The numeric variable for the assignment of the current value of Timeout.~~

	~~</td></tr></table>~~
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>Typically, you set <var>Timeout</var>		<li>Typically, you set <var>Timeout</var> to the maximum wait you want your end users to experience.
	to the maximum wait you want your end users to experience.		<li>If a <var>Get</var>, <var>Post</var>, or <var>Send</var> function times out, the function response is set to <var>null</var>, $STATUSD is set to 101, and whether the request is cancelled depends on the value of the <var class="term">Cancel</var> parameter set on the <var>Get</var>, <var>Post</var>, or <var>Send</var> call.
	<li>If a <var>Get</var>, <var>Post</var>, or <var>Send</var> function times out, the function response is
	set to null,
	$STATUSD is set to 101, and whether the request is cancelled depends
	on the value of the <var>Cancel</var> parameter on the
	<var>Get</var>, <var>Post</var>, or <var>Send</var> call.
	</ul>		</ul>

	==See also==		==See also==
	{{Template:HttpRequest:Timeout footer}}		{{Template:HttpRequest:Timeout footer}}

DmeWiccan: 1 revision

2011-06-16T20:17:36Z

1 revision

← Older revision	Revision as of 20:17, 16 June 2011
(No difference)

DmeWiccan: 1 revision

2011-06-16T20:17:33Z

1 revision

← Older revision		Revision as of 20:17, 16 June 2011
Line 2:		Line 2:

	This method lets		This method lets
	you set and query a timeout value for a <var>[[Get (~~HTTPRequest~~ function)\|Get]]</var>,		you set and query a timeout value for a <var>[[Get (HttpRequest function)\|Get]]</var>,
	<var>[[Post (~~HTTPRequest~~ function)\|Post]]</var>,		<var>[[Post (HttpRequest function)\|Post]]</var>,
	or <var>[[Send (~~HTTPRequest~~ function)\|Send]]</var> method invocation.		or <var>[[Send (HttpRequest function)\|Send]]</var> method invocation.
	The timeout (in wall-clock seconds)		The timeout (in wall-clock seconds)
	is the sum of the elaped time of all network transfers for a <var>Get</var>, <var>Post</var>, or <var>Send</var>,		is the sum of the elaped time of all network transfers for a <var>Get</var>, <var>Post</var>, or <var>Send</var>,
Line 24:		Line 24:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%httpreq</th>		<tr><th>%httpreq</th>
	<td>An instantiated <var>~~HTTPRequest~~</var> object.		<td>An instantiated <var>HttpRequest</var> object.
	</td></tr>		</td></tr>
	<tr><th>value</th>		<tr><th>value</th>

DmeWiccan: 1 revision

2011-06-16T20:16:26Z

1 revision

← Older revision	Revision as of 20:16, 16 June 2011
(No difference)

Dme: moved Timeout (HTTPRequest property) to Timeout (HttpRequest property)

2011-06-16T20:16:23Z

moved Timeout (HTTPRequest property) to Timeout (HttpRequest property)

← Older revision		Revision as of 20:16, 16 June 2011
Line 1:		Line 1:
	{{Template:~~HTTPRequest~~:Timeout subtitle}}		{{Template:HttpRequest:Timeout subtitle}}

	This method lets		This method lets
Line 20:		Line 20:
	If no <var>Timeout</var> property value is set, the port <var>TIMEOUT</var> setting (if any) is used.		If no <var>Timeout</var> property value is set, the port <var>TIMEOUT</var> setting (if any) is used.
	==Syntax==		==Syntax==
	{{Template:~~HTTPRequest~~:Timeout syntax}}		{{Template:HttpRequest:Timeout syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 44:		Line 44:
	</ul>		</ul>
	==See also==		==See also==
	{{Template:~~HTTPRequest~~:Timeout footer}}		{{Template:HttpRequest:Timeout footer}}

Dme: moved Timeout (HTTPRequest property) to Timeout (HttpRequest property)

2011-06-16T19:15:31Z

moved Timeout (HTTPRequest property) to Timeout (HttpRequest property)

← Older revision	Revision as of 19:15, 16 June 2011
(No difference)

JALWiccan: 1 revision

2011-06-15T22:42:48Z

1 revision

← Older revision	Revision as of 22:42, 15 June 2011
(No difference)

JALWiccan: 1 revision

2011-06-15T22:42:45Z

1 revision

← Older revision		Revision as of 22:42, 15 June 2011
Line 24:		Line 24:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%httpreq</th>		<tr><th>%httpreq</th>
	<td>An instantiated HTTPRequest object.		<td>An instantiated <var>HTTPRequest</var> object.
	</td></tr>		</td></tr>
	<tr><th>value</th>		<tr><th>value</th>

JALWiccan: 1 revision

2011-06-15T18:29:26Z

1 revision

← Older revision	Revision as of 18:29, 15 June 2011
(No difference)