$Web Response - Revision history

JAL: misc formatting

2016-07-05T23:38:01Z

misc formatting

← Older revision		Revision as of 23:38, 5 July 2016
Line 26:		Line 26:

	<tr><th>parameter</th>		<tr><th>parameter</th>
	<td>A String (or [[Longstrings\|Longstring]] if Model 204 7.7 or higher) containing the name of the HTTP response header parameter.</td></tr>		<td>A <var>String</var> (or <var>[[Longstrings\|Longstring]]</var> if Model 204 7.7 or higher) containing the name of the HTTP response header parameter.</td></tr>

	<tr><th>value</th>		<tr><th>value</th>
	<td>A String (or Longstring if Model 204 7.7 or higher) containing the value of the HTTP response header parameter.		<td>A <var>String</var> (or <var>Longstring</var> if Model 204 7.7 or higher) containing the value of the HTTP response header parameter.
	</td></tr>		</td></tr>
	</table>		</table>

JAL: add Longstring capability

2016-01-04T18:54:51Z

add Longstring capability

← Older revision		Revision as of 18:54, 4 January 2016
Line 11:		Line 11:

	===Syntax terms===		===Syntax terms===
	<table ~~class="syntaxTable"~~>		<table>
	<tr><th>%rc</th>		<tr><th>%rc</th>
	<td>A numeric variable to contain a return code. Possible values are:		<td>A numeric variable to contain a return code. Possible values are:
	<table class="~~syntaxTable~~">		<table class="thJustBold">
	<tr><th>0</th>		<tr><th>0</th>
	<td>Response header parameter set.</td></tr>		<td>Response header parameter set.</td></tr>

	<tr><th>-1</th>		<tr><th>-1</th>
	<td>Not a web thread</td></tr>		<td>Not a web thread</td></tr>

	<tr><th>-5</th>		<tr><th>-5</th>
	<td>Parameter name missing.</td></tr></table>		<td>Parameter name missing.</td></tr>
			</table></td></tr>

	<tr><th>parameter</th>		<tr><th>parameter</th>
	<td>~~The~~ name of the HTTP response header parameter.</td></tr>		<td>A String (or [[Longstrings\|Longstring]] if Model 204 7.7 or higher) containing the name of the HTTP response header parameter.</td></tr>

	<tr><th>value</th>		<tr><th>value</th>
	<td>~~The~~ value of the HTTP response header parameter.		<td>A String (or Longstring if Model 204 7.7 or higher) containing the value of the HTTP response header parameter.
	</td></tr></table>		</td></tr>
			</table>

	==Usage notes==		==Usage notes==
	Most response header parameters are set "under-the-covers" ~~either~~ automatically or as the result of other <var class="product">[[Janus Web Server]]</var> $function calls. These automatically set parameters should be adequate for most applications. In the cases where they're not, <var>$Web_Response</var> provides the ability to set response header parameters directly.		<ul>
	The response header parameter that is most likely to be useful and that can only be set with <var>$Web_Response</var> is the "Pragma" parameter which can be used to indicate that a response should not be cached by the browser as in the following example.		<li>Most response header parameters are set "under-the-covers" automatically or as the result of other <var class="product">[[Janus Web Server]]</var> $function calls. These automatically-set parameters should be adequate for most applications. In the cases where they're not, <var>$Web_Response</var> provides the ability to set response header parameters directly.
	<p class="code"> %RC = $Web_Response('Pragma', 'no-cache')		<p>
	</p>		The response header parameter that is most likely to be useful and that can only be set with <var>$Web_Response</var> is the "Pragma" parameter, which can be used to indicate that a response should not be cached by the browser, as in the following example:</p>
	The response header parameters are not sent until the size of the response has been determined, ~~either~~ as the result of a <var>$Web_Done</var> or a <var>$Web_ProcSend</var>. Until one of these is issued, it is possible to change the value of a response header parameter at will.		<p class="code">%rc = $Web_Response('Pragma', 'no-cache')
			</p></li>

			<li>The response header parameters are not sent until the size of the response has been determined, as the result of a <var>$Web_Done</var> or a <var>$Web_ProcSend</var>. Until one of these is issued, it is possible to change the value of a response header parameter at will. </li>

	Extreme caution should be used with this function since it provides direct access to the HTTP layer of the web protocols. <var>$Web_Response</var> does '''no''' validity checking for the parameter name or value specified. For more information about the HTTP ~~protocol including a specification of all the~~ standard response header parameters, visit http://www.~~ics.uci~~.~~edu~~/~~pub~~/~~ietf~~/~~http~~/.		<li><b>Attention:</b> Extreme caution should be used with this function since it provides direct access to the HTTP layer of the web protocols. <var>$Web_Response</var> does '''no''' validity checking for the parameter name or value specified. For more information about the HTTP standard response header parameters, visit https://en.wikipedia.org/wiki/List_of_HTTP_header_fields and http://www.iana.org/assignments/message-headers/message-headers.xml#perm-headers. </li>

	[[Category:Janus Web Server $functions\|$Web_Response]]		[[Category:Janus Web Server $functions\|$Web_Response]]

JALWiccan: Automatically generated page update

2013-04-12T20:36:14Z

Automatically generated page update

← Older revision		Revision as of 20:36, 12 April 2013
Line 7:		Line 7:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Web_Response</span>(<span class="term"> parameter, value )		<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Web_Response</span>(<span class="term"> parameter</span>, <span class="term">value</span> )
	</p>		</p>

JALWiccan: Automatically generated page update

2013-04-12T19:56:46Z

Automatically generated page update

← Older revision		Revision as of 19:56, 12 April 2013
Line 7:		Line 7:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%rc</span> = $Web_Response( parameter, value )		<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Web_Response</span>(<span class="term"> parameter, value )
	</p>		</p>

JALWiccan: Automatically generated page update

2013-04-10T18:18:23Z

Automatically generated page update

← Older revision		Revision as of 18:18, 10 April 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:$Web_Response}}		{{DISPLAYTITLE:$Web_Response}}
	<span class="pageSubtitle"~~><section begin="desc" /~~>Set HTTP response header parameter~~<section end="desc" />~~</span>		<span class="pageSubtitle">Set HTTP response header parameter</span>

	<var>$Web_Response</var> can be used to set any HTTP response header parameter.		<var>$Web_Response</var> can be used to set any HTTP response header parameter.
Line 7:		Line 7:

	==Syntax==		==Syntax==
	<p class="syntax"~~><section begin="syntax" /~~><span class="term">%rc</span> = $Web_Response( parameter, value )		<p class="syntax"><span class="term">%rc</span> = $Web_Response( parameter, value )
	~~<section end="syntax" />~~</p>		</p>

	===Syntax terms===		===Syntax terms===

JALWiccan: 1 revision

2012-10-18T22:43:14Z

1 revision

← Older revision	Revision as of 22:43, 18 October 2012
(No difference)

JALWiccan: 1 revision

2012-10-18T22:43:10Z

1 revision

← Older revision		Revision as of 22:43, 18 October 2012
Line 2:		Line 2:
	<span class="pageSubtitle"><section begin="desc" />Set HTTP response header parameter<section end="desc" /></span>		<span class="pageSubtitle"><section begin="desc" />Set HTTP response header parameter<section end="desc" /></span>

	$Web_Response can be used to set any HTTP response header parameter.		<var>$Web_Response</var> can be used to set any HTTP response header parameter.

	$Web_Response is a [[Calling_Sirius_Mods_$functions\|callable]] $function, and it takes two arguments and returns a numeric status code.		<var>$Web_Response</var> is a [[Calling_Sirius_Mods_$functions\|callable]] $function, and it takes two arguments and returns a numeric status code.

	==Syntax==		==Syntax==

JALWiccan: 1 revision

2012-10-18T22:17:11Z

1 revision

← Older revision	Revision as of 22:17, 18 October 2012
(No difference)

JALWiccan: 1 revision

2012-10-18T22:17:08Z

1 revision

← Older revision		Revision as of 22:17, 18 October 2012
Line 33:		Line 33:
	<p class="code"> %RC = $Web_Response('Pragma', 'no-cache')		<p class="code"> %RC = $Web_Response('Pragma', 'no-cache')
	</p>		</p>
	The response header parameters are not sent until the size of the response has been determined, either as the result of a <var>$Web_Done</var> or a $Web_ProcSend. Until one of these is issued, it is possible to change the value of a response header parameter at will.		The response header parameters are not sent until the size of the response has been determined, either as the result of a <var>$Web_Done</var> or a <var>$Web_ProcSend</var>. Until one of these is issued, it is possible to change the value of a response header parameter at will.

	Extreme caution should be used with this function since it provides direct access to the HTTP layer of the web protocols. <var>$Web_Response</var> does '''no''' validity checking for the parameter name or value specified. For more information about the HTTP protocol including a specification of all the standard response header parameters, visit http://www.ics.uci.edu/pub/ietf/http/.		Extreme caution should be used with this function since it provides direct access to the HTTP layer of the web protocols. <var>$Web_Response</var> does '''no''' validity checking for the parameter name or value specified. For more information about the HTTP protocol including a specification of all the standard response header parameters, visit http://www.ics.uci.edu/pub/ietf/http/.

	[[Category:Janus Web Server $functions\|$Web_Response]]		[[Category:Janus Web Server $functions\|$Web_Response]]

JALWiccan: 1 revision

2012-10-18T21:53:31Z

1 revision

← Older revision	Revision as of 21:53, 18 October 2012
(No difference)