Post (HttpRequest function) - Revision history

JAL: misc cleanup

2015-12-08T20:29:23Z

misc cleanup

← Older revision		Revision as of 20:29, 8 December 2015
Line 6:		Line 6:
	==Syntax==		==Syntax==
	{{Template:HttpRequest:Post syntax}}		{{Template:HttpRequest:Post syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%httpResponse</th>		<tr><th>%httpResponse</th>
	<td>A reference to the [[HttpResponse_class\|HTTPResponse]] object instantiated and returned by this <var>Post</var> method.		<td>A reference to the <var>[[HttpResponse_class\|HTTPResponse]]</var> object instantiated and returned by this <var>Post</var> method.
	</td></tr>		</td></tr>

	<tr><th>httpRequest</th>		<tr><th>httpRequest</th>
	<td>An instantiated <var>HttpRequest</var> object that contains the request (its methods were used to create the request).		<td>An instantiated <var>HttpRequest</var> object that contains the request (its methods were used to create the request).
	</td></tr>		</td></tr>

	<tr><th><var>Port</var></th>		<tr><th><var>Port</var></th>
	<td>A string expression that identifies a previously defined <var>CLSOCK</var> port. The <var class="term">string</var> default is the <var>[[MASTER]]</var> port, if any is defined. However, if you omit <var class="term">string</var> and no <var>MASTER</var> port is defined, the request is canceled.		<td>A string expression that identifies a previously defined <var>CLSOCK</var> port. The <var class="term">string</var> default is the <var>[[MASTER]]</var> port, if any is defined. However, if you omit <var class="term">string</var> and no <var>MASTER</var> port is defined, the request is canceled.
	This is an optional and ~~(as of <var class="product">[[Sirius Mods]]</var> version 7.2)~~ [[Notation conventions for methods#Named parameters\|name-allowed]] parameter. If you specify a value, you may (but don't have to) specify the parameter name, <var>Port</var> (case not important).		<p>
	</td></tr>		This is an optional and [[Notation conventions for methods#Named parameters\|name-allowed]] parameter. If you specify a value, you may (but don't have to) specify the parameter name, <var>Port</var> (case not important). </p></td></tr>

	<tr><th><var>Cancel</var></th>		<tr><th><var>Cancel</var></th>
	<td>A numeric expression that controls whether the request is cancelled if a communication/socket error occurs. If zero, the request is not cancelled on these errors. If non-zero, the request is cancelled (though a message is still issued). If not specified, it defaults to 1 (cancel). See "Usage notes," below, for further discussion of error handling.		<td>A numeric expression that controls whether the request is cancelled if a communication/socket error occurs. If zero, the request is not cancelled on these errors. If non-zero, the request is cancelled (though a message is still issued). If not specified, it defaults to 1 (cancel). See "Usage notes," below, for further discussion of error handling.
	This is an optional and ~~(as of <var class="product">Sirius Mods</var> version 7.2)~~ name-allowed parameter. If you specify a value, you may (but don't have to) specify the parameter name, <var>Cancel</var> (case not important) if you want.		This is an optional and name-allowed parameter. If you specify a value, you may (but don't have to) specify the parameter name, <var>Cancel</var> (case not important) if you want.

	<tr><th><var>CertificateCheck</var></th>		<tr><th><var>CertificateCheck</var></th>
Line 26:		Line 30:
	The argument value (<var class="term">certificateChecker</var>) must be a function, presumably [[Local and Common entities#Defining and invoking a local method\|local]], with this [[Method variables#Method template in method variable declaration\|method template]]:		The argument value (<var class="term">certificateChecker</var>) must be a function, presumably [[Local and Common entities#Defining and invoking a local method\|local]], with this [[Method variables#Method template in method variable declaration\|method template]]:
	<p class="syntax"><span class="literal">Function (String):</span><span class="term">methname</span> <span class="literal">Is Boolean</span> </p>		<p class="syntax"><span class="literal">Function (String):</span><span class="term">methname</span> <span class="literal">Is Boolean</span> </p>
			<p>
	When a connection is established, the passed function is called with the certificate (binary, ASN.1 encoded, content copied to a <var>Longstring</var>) as its method object.		When a connection is established, the passed function is called with the certificate (binary, ASN.1 encoded, content copied to a <var>Longstring</var>) as its method object. </p>
	<ul>		<ul>
	<li>If the function returns a <code>True</code>, the request is completed.		<li>If the function returns a <code>True</code>, the request is completed. </li>

	<li>If the function returns a <code>False</code>, the connection is closed and <var>HttpRequest</var> returns a null.		<li>If the function returns a <code>False</code>, the connection is closed and <var>HttpRequest</var> returns a null.
	In this case, the request is canceled unless the <var>Cancel</var> argument setting prevents it.		In this case, the request is canceled unless the <var>Cancel</var> argument setting prevents it. </li>
	</ul>		</ul>
			<p>
			For a <var>CertificateCheck</var> function example, see [[Get_(HttpRequest_function)#Examples\|Examples]] for the <var>Get</var> method. </p></td></tr>

	~~For a <var>CertificateCheck</var> function example, see [[Get_(HttpRequest_function)#Examples\|"Examples"]] for the <var>Get</var> method.~~
	~~</td></tr>~~
	<tr><th><var>CheckKeepAliveCertificate</var></th>		<tr><th><var>CheckKeepAliveCertificate</var></th>
	<td>This optional, name required, argument controls how frequently a specified <var>CertificateCheck</var> function is invoked for a an HTTP [[HTTP Helper#Keep-Alive support\|keep-alive]] connection. If <code>False</code>, the default, the <var class="term">certificateChecker</var> function is called only when the physical connection is first established and not for every HTTP request on that connection. If set to <code>True</code>, the <var>CertificateCheck</var> method is called for every request, keep-alive or not.		<td>This optional, name required, argument controls how frequently a specified <var>CertificateCheck</var> function is invoked for a an HTTP [[HTTP Helper#Keep-Alive support\|keep-alive]] connection. If <code>False</code>, the default, the <var class="term">certificateChecker</var> function is called only when the physical connection is first established and not for every HTTP request on that connection. If set to <code>True</code>, the <var>CertificateCheck</var> method is called for every request, keep-alive or not.
Line 50:		Line 55:
	<li>While attempting the HTTP request, a socket or communication error occurred. Examples of such errors include failure to connect to the server host, and a communication failure on a TCP/IP send or receive.		<li>While attempting the HTTP request, a socket or communication error occurred. Examples of such errors include failure to connect to the server host, and a communication failure on a TCP/IP send or receive.

	For this class of errors, no instance of <var>HTTPResponse</var> is created, and a <var>Null</var> object is returned. In addition, $Status is set to 1, and $StatusD is set to one of these:		For this class of errors, no instance of <var>HTTPResponse</var> is created, and a <var>Null</var> object is returned. In addition, <var>[[$Status]]</var> is set to 1, and <var>[[$StatusD]]</var> is set to one of these:
	<ul>		<ul>
	<li>A negative return code that indicates an error in connecting to the target HTTP server. These codes are the same as those in [[~~Get_~~(~~HttpRequest_function~~)#~~Get_method_return_values~~\|"Get method return values"]].		<li>A negative return code that indicates an error in connecting to the target HTTP server. These codes are the same as those in [[Get (HttpRequest function)#Get method return values\|Get method return values]]. </li>
	<li>A positive return code indicating a communications error after the connection was made.
			<li>A positive return code indicating a communications error after the connection was made. </li>
	</ul>		</ul>
	The request may or may not be cancelled based on the setting of the <var>Cancel</var> parameter.		The request may or may not be cancelled based on the setting of the <var>Cancel</var> parameter.
			<p>
	Some of these errors are relatively benign (for example, inability to connect because remote partner down, timeout value exceeded), so they produce information-only messages, and they are treated as non-counting. These errors can still be detected and handled by the application (by checking for a <var>Null</var> result object, checking <var>[[$Status]]</var> and <var>[[$StatusD]]</var>, or both).		Some of these errors are relatively benign (for example, inability to connect because remote partner down, timeout value exceeded), so they produce information-only messages, and they are treated as non-counting. These errors can still be detected and handled by the application (by checking for a <var>Null</var> result object, checking <var>$Status</var> and <var>$StatusD</var>, or both). </p>

	<blockquote class="note">		<blockquote class="note">
Line 70:		Line 76:
	<p class="code">content-type: application/x-www-form-urlencoded		<p class="code">content-type: application/x-www-form-urlencoded
	</p>		</p>
	<li>For HTTP Version 1.1 mode only, the HTTP request header ~~“~~connection: close~~”~~ is automatically sent on HTTP requests to ensure that the server closes the connection with the client when the HTTP request completes. The HTTP Helper does '''not''' support persistent connections.		<li>For HTTP Version 1.1 mode only, the HTTP request header "connection: close" is automatically sent on HTTP requests to ensure that the server closes the connection with the client when the HTTP request completes. The HTTP Helper does '''not''' support persistent connections. </li>
	<li>The HTTP request header ~~“~~Content-Length~~”~~ is automatically sent on POSTs, accompanied by the value of the number of bytes in the non-header posted data.
	<li>If the ports associated with the sockets in the HTTP request are not using SSL, and the <var>CertificateCheck</var> argument is specified, the <var class="term">certificateChecker</var> function does not get called.		<li>The HTTP request header "Content-Length" is automatically sent on POSTs, accompanied by the value of the number of bytes in the non-header posted data. </li>

			<li>If the ports associated with the sockets in the HTTP request are not using SSL, and the <var>CertificateCheck</var> argument is specified, the <var class="term">certificateChecker</var> function does not get called. </li>
	</ul>		</ul>

Mlarocca: /* Usage notes */

2014-07-29T19:07:03Z

Usage notes

← Older revision		Revision as of 19:07, 29 July 2014
Line 50:		Line 50:
	<li>While attempting the HTTP request, a socket or communication error occurred. Examples of such errors include failure to connect to the server host, and a communication failure on a TCP/IP send or receive.		<li>While attempting the HTTP request, a socket or communication error occurred. Examples of such errors include failure to connect to the server host, and a communication failure on a TCP/IP send or receive.

	For this class of errors, no instance of <var>HTTPResponse</var> is created, and a <var>Null</var> object is returned. In addition, $~~STATUS~~ is set to 1, and $~~STATUSD~~ is set to one of these:		For this class of errors, no instance of <var>HTTPResponse</var> is created, and a <var>Null</var> object is returned. In addition, $Status is set to 1, and $StatusD is set to one of these:
	<ul>		<ul>
	<li>A negative return code that indicates an error in connecting to the target HTTP server. These codes are the same as those in [[Get_(HttpRequest_function)#Get_method_return_values\|"Get method return values"]].		<li>A negative return code that indicates an error in connecting to the target HTTP server. These codes are the same as those in [[Get_(HttpRequest_function)#Get_method_return_values\|"Get method return values"]].
Line 57:		Line 57:
	The request may or may not be cancelled based on the setting of the <var>Cancel</var> parameter.		The request may or may not be cancelled based on the setting of the <var>Cancel</var> parameter.

	Some of these errors are relatively benign (for example, inability to connect because remote partner down, timeout value exceeded), so they produce information-only messages, and they are treated as non-counting. These errors can still be detected and handled by the application (by checking for a <var>Null</var> result object, checking <var>[[$~~STATUS~~]]</var> and <var>[[$~~STATUSD~~]]</var>, or both).		Some of these errors are relatively benign (for example, inability to connect because remote partner down, timeout value exceeded), so they produce information-only messages, and they are treated as non-counting. These errors can still be detected and handled by the application (by checking for a <var>Null</var> result object, checking <var>[[$Status]]</var> and <var>[[$StatusD]]</var>, or both).

	<blockquote class="note">		<blockquote class="note">

JAL at 00:22, 12 September 2013

2013-09-12T00:22:39Z

← Older revision		Revision as of 00:22, 12 September 2013
Line 1:		Line 1:
	{{Template:HttpRequest:Post subtitle}}		{{Template:HttpRequest:Post subtitle}}
	The <var>Post</var> method sends an HTTP request to an HTTP server in the HTTP Post format: the request syntax sent to the server is the same as if a METHOD="POST" HTML form was submitted from a web browser.		The <var>Post</var> method sends an HTTP request to an HTTP server in the HTTP Post format: the request syntax sent to the server is the same as if a <code>METHOD="POST"</code> HTML form was submitted from a web browser.

	For more information about the HTTP POST request format, and for information about the HTTP protocol, refer to http://www.w3.org/Protocols/rfc2616/rfc2616.html.		For more information about the HTTP POST request format, and for information about the HTTP protocol, refer to http://www.w3.org/Protocols/rfc2616/rfc2616.html.

JAL at 00:21, 12 September 2013

2013-09-12T00:21:57Z

← Older revision		Revision as of 00:21, 12 September 2013
Line 57:		Line 57:
	The request may or may not be cancelled based on the setting of the <var>Cancel</var> parameter.		The request may or may not be cancelled based on the setting of the <var>Cancel</var> parameter.

	Some of these errors are relatively benign (for example, inability to connect because remote partner down, timeout value exceeded), so they produce information-only messages, and they are treated as non-counting. These errors can still be detected and handled by the application (by checking for a <var>Null</var> result object, checking $STATUS and $STATUSD, or both).		Some of these errors are relatively benign (for example, inability to connect because remote partner down, timeout value exceeded), so they produce information-only messages, and they are treated as non-counting. These errors can still be detected and handled by the application (by checking for a <var>Null</var> result object, checking <var>[[$STATUS]]</var> and <var>[[$STATUSD]]</var>, or both).

	'''Note:''' The distinctions between some of the return codes might or might not be meaningful, depending on the situation. For example, network problems can cause a 101 return code (indicating a timeout) or a 102 (indicating a connection closed). Connecting to a server that is using a non-HTTP protocol can result in a 100 (invalid format data received from the server) or a 101 or 102, depending on the protocol used by the server to which the request is sent: a request sent to a telnet port '''usually''' results in a timeout (return code 101), while a request sent to an SSL port without using <code>https</code> to indicate SSL '''usually''' results in the target server breaking the connection (return code 102).		<blockquote class="note">
			<p>'''Note:''' The distinctions between some of the return codes might or might not be meaningful, depending on the situation. For example, network problems can cause a 101 return code (indicating a timeout) or a 102 (indicating a connection closed). Connecting to a server that is using a non-HTTP protocol can result in a 100 (invalid format data received from the server) or a 101 or 102, depending on the protocol used by the server to which the request is sent: a request sent to a telnet port '''usually''' results in a timeout (return code 101), while a request sent to an SSL port without using <code>https</code> to indicate SSL '''usually''' results in the target server breaking the connection (return code 102).</p>
	In general, it is risky to take action based on the distinction between the various non-zero error codes returned by this method.		<p>
			In general, it is risky to take action based on the distinction between the various non-zero error codes returned by this method.</p></blockquote>
	</ul>		</ul>

Line 67:		Line 68:

	<li>If form fields are defined with <var>[[AddField (HttpRequest subroutine)\|AddField]]</var>, no explicit content type is set with <var>[[AddHeader (HttpRequest subroutine)\|AddHeader]]</var>, and multipart form encoding is ''not'' enabled with <var>[[MultiPartFormEncoding (HttpRequest property)\|MultiPartFormEncoding]]</var>, the <var class="product">HTTP Helper</var> automatically sends the following request header on <var>Post</var> calls:		<li>If form fields are defined with <var>[[AddField (HttpRequest subroutine)\|AddField]]</var>, no explicit content type is set with <var>[[AddHeader (HttpRequest subroutine)\|AddHeader]]</var>, and multipart form encoding is ''not'' enabled with <var>[[MultiPartFormEncoding (HttpRequest property)\|MultiPartFormEncoding]]</var>, the <var class="product">HTTP Helper</var> automatically sends the following request header on <var>Post</var> calls:
	<p class="code"> content-type: application/x-www-form-urlencoded		<p class="code">content-type: application/x-www-form-urlencoded
	</p>		</p>
	<li>For HTTP Version 1.1 mode only, the HTTP request header “connection: close” is automatically sent on HTTP requests to ensure that the server closes the connection with the client when the HTTP request completes. The HTTP Helper does '''not''' support persistent connections.		<li>For HTTP Version 1.1 mode only, the HTTP request header “connection: close” is automatically sent on HTTP requests to ensure that the server closes the connection with the client when the HTTP request completes. The HTTP Helper does '''not''' support persistent connections.
Line 77:		Line 78:
	==See also==		==See also==
	<ul>		<ul>
	<li>For more information about $STATUS and $STATUSD, see the <i>[http://www.rocketsoftware.com/m204/products/index/documentation/v7r4/M204-User-Language/view Rocket Model 204 User Language Manual]</i>.
	<li>You can also send an HTTP POST using the <var>[[Send (HttpRequest function)\|Send]]</var> method.		<li>You can also send an HTTP POST using the <var>[[Send (HttpRequest function)\|Send]]</var> method.
	</ul>		</ul>
	{{Template:HttpRequest:Post footer}}		{{Template:HttpRequest:Post footer}}

JAL: /* See also */

2012-10-10T20:44:15Z

JAL2 at 20:45, 17 November 2011

2011-11-17T20:45:52Z

JAL2: /* Usage notes */

2011-11-17T00:02:37Z

Usage notes

← Older revision		Revision as of 00:02, 17 November 2011
Line 46:		Line 46:
	<li>The HTTP request completed, but the server indicated a failure of the request (an HTTP return code of 400 or greater). An example of this is the "404 not found" message issued by a web server when a non-existent document is referenced. In this class of error there was no TCP/IP communication error.		<li>The HTTP request completed, but the server indicated a failure of the request (an HTTP return code of 400 or greater). An example of this is the "404 not found" message issued by a web server when a non-existent document is referenced. In this class of error there was no TCP/IP communication error.

	For these errors, the request is never cancelled, and an <var>[[~~HTTPResponse~~ class\|~~HTTPResponse~~]]</var> object is always returned. The application handles these errors by [[The ~~HTTPResponse methods#Status reporting~~\|checking]] the <var>HTTPResponse</var> <var>[[Code_(HttpResponse_function)\|Code]]</var>, <var>[[StatusLine_(HttpResponse_function)\|StatusLine]]</var>, <var>[[Message_(HttpResponse_function)\|Message]]</var>, and <var>[[Success_(HttpResponse_function)\|Success]]</var> methods.		For these errors, the request is never cancelled, and an <var>[[HttpResponse class\|HttpResponse]]</var> object is always returned. The application handles these errors by [[HTTP Helper#The HttpResponse class\|checking]] the <var>HTTPResponse</var> <var>[[Code_(HttpResponse_function)\|Code]]</var>, <var>[[StatusLine_(HttpResponse_function)\|StatusLine]]</var>, <var>[[Message_(HttpResponse_function)\|Message]]</var>, and <var>[[Success_(HttpResponse_function)\|Success]]</var> methods.
	<li>While attempting the HTTP request, a socket or communication error occurred. Examples of such errors include failure to connect to the server host, and a communication failure on a TCP/IP send or receive.		<li>While attempting the HTTP request, a socket or communication error occurred. Examples of such errors include failure to connect to the server host, and a communication failure on a TCP/IP send or receive.

JAL2: /* Usage notes */

2011-11-16T23:58:13Z

Usage notes

← Older revision		Revision as of 23:58, 16 November 2011
Line 70:		Line 70:
	<li>For HTTP Version 1.1 mode only, the HTTP request header “connection: close” is automatically sent on HTTP requests to ensure that the server closes the connection with the client when the HTTP request completes. The HTTP Helper does '''not''' support persistent connections.		<li>For HTTP Version 1.1 mode only, the HTTP request header “connection: close” is automatically sent on HTTP requests to ensure that the server closes the connection with the client when the HTTP request completes. The HTTP Helper does '''not''' support persistent connections.
	<li>The HTTP request header “Content-Length” is automatically sent on POSTs, accompanied by the value of the number of bytes in the non-header posted data.		<li>The HTTP request header “Content-Length” is automatically sent on POSTs, accompanied by the value of the number of bytes in the non-header posted data.
			<li>If the ports associated with the sockets in the HTTP request are not using SSL, and the <var>CertificateCheck</var> argument is specified, the <var class="term">certificateChecker</var> function does not get called.

			<li>Specifying a <code>CertificateCheck</code> function has no effect if issued over a Janus <var>[[SSL]]</var> port whose definition includes <var>[[SSLCLCERT and SSLCLCERTR\|SSLCLCERT]]</var> or <var>[[SSLCLCERT and SSLCLCERTR\|SSLCLCERTR]]</var>. These parameters request a client certificate at connection-establishment time, and a client certificate
			may only be requested once for an SSL session (whether or not the request successfully gets a certificate in return).
	</ul>		</ul>

JAL2: /* Syntax terms */

2011-11-16T23:53:51Z

Syntax terms

@@ Line 20: / Line 20: @@
 <tr><th><var>Cancel</var></th>
 <td>A numeric expression that controls whether the request is cancelled if a communication/socket error occurs. If zero, the request is not cancelled on these errors. If non-zero, the request is cancelled (though a message is still issued). If not specified, it defaults to 1 (cancel). See "Usage notes," below, for further discussion of error handling.
-This is an optional and (as of <var class="product">Sirius Mods</var> version 7.2) name-allowed parameter.  If you specify a value, you may (but don't have to) specify the parameter name, <var>Cancel</var> (case not important) if you wish.
+This is an optional and (as of <var class="product">Sirius Mods</var> version 7.2) name-allowed parameter.  If you specify a value, you may (but don't have to) specify the parameter name, <var>Cancel</var> (case not important) if you want.
 </td></tr>
 </table>

JAL2 at 20:55, 21 June 2011

2011-06-21T20:55:44Z

← Older revision		Revision as of 20:55, 21 June 2011
Line 14:		Line 14:
	<td>An instantiated <var>HttpRequest</var> object that contains the request (its methods were used to create the request).		<td>An instantiated <var>HttpRequest</var> object that contains the request (its methods were used to create the request).
	</td></tr>		</td></tr>
	<tr><th>Port</th>		<tr><th><var>Port</var></th>
	<td>A string expression that identifies a previously defined <var>CLSOCK</var> port. The ~~''name''~~ default is the [[MASTER]] port, if any is defined. However, if you omit ~~''name''~~ and no <var>MASTER</var> port is defined, the request is canceled.		<td>A string expression that identifies a previously defined <var>CLSOCK</var> port. The <var class="term">string</var> default is the <var>[[MASTER]]</var> port, if any is defined. However, if you omit <var class="term">string</var> and no <var>MASTER</var> port is defined, the request is canceled.
	This is an optional and (as of <var class="product">[[Sirius Mods]]</var> version 7.2) [[Notation conventions for methods#Named parameters\|name-allowed]] parameter. If you specify a value, you may (but don't have to) specify the parameter name, <var>Port</var> (case not important) ~~if you wish~~.		This is an optional and (as of <var class="product">[[Sirius Mods]]</var> version 7.2) [[Notation conventions for methods#Named parameters\|name-allowed]] parameter. If you specify a value, you may (but don't have to) specify the parameter name, <var>Port</var> (case not important).
	</td></tr>		</td></tr>
	<tr><th>Cancel</th>		<tr><th><var>Cancel</var></th>
	<td>A numeric expression that controls whether the request is cancelled if a communication/socket error occurs. If zero, the request is not cancelled on these errors. If non-zero, the request is cancelled (though a message is still issued). If not specified, it defaults to 1 (cancel). See "Usage notes," below, for further discussion of error handling.		<td>A numeric expression that controls whether the request is cancelled if a communication/socket error occurs. If zero, the request is not cancelled on these errors. If non-zero, the request is cancelled (though a message is still issued). If not specified, it defaults to 1 (cancel). See "Usage notes," below, for further discussion of error handling.
	This is an optional and (as of <var class="product">Sirius Mods</var> version 7.2) name-allowed parameter. If you specify a value, you may (but don't have to) specify the parameter name, <var>Cancel</var> (case not important) if you wish.		This is an optional and (as of <var class="product">Sirius Mods</var> version 7.2) name-allowed parameter. If you specify a value, you may (but don't have to) specify the parameter name, <var>Cancel</var> (case not important) if you wish.
Line 38:		Line 38:
	<li>A positive return code indicating a communications error after the connection was made.		<li>A positive return code indicating a communications error after the connection was made.
	</ul>		</ul>
	The request may or may not be cancelled based on the setting of the <var ~~class="term"~~>~~cancel~~</var> parameter.		The request may or may not be cancelled based on the setting of the <var>Cancel</var> parameter.

	Some of these errors are relatively benign (for example, inability to connect because remote partner down, timeout value exceeded), so they produce information-only messages, and they are treated as non-counting. These errors can still be detected and handled by the application (by checking for a <var>Null</var> result object, checking $STATUS and $STATUSD, or both).		Some of these errors are relatively benign (for example, inability to connect because remote partner down, timeout value exceeded), so they produce information-only messages, and they are treated as non-counting. These errors can still be detected and handled by the application (by checking for a <var>Null</var> result object, checking $STATUS and $STATUSD, or both).
Line 49:		Line 49:
	For more information about an error, you may want to issue a <var>[[JANUS TRACE]]</var> command with a value of 8 or 15 for the <var>[[JANUS CLSOCK\|CLSOCK]]</var> port that is handling your HTTP request.		For more information about an error, you may want to issue a <var>[[JANUS TRACE]]</var> command with a value of 8 or 15 for the <var>[[JANUS CLSOCK\|CLSOCK]]</var> port that is handling your HTTP request.

	<li>If form fields are defined with <var>[[AddField (HttpRequest subroutine)\|AddField]]</var>, no explicit content type is set with [[AddHeader (HttpRequest subroutine)\|AddHeader]], and multipart form encoding is ''not'' enabled with <var>[[MultiPartFormEncoding (HttpRequest property)\|MultiPartFormEncoding]]</var>, the HTTP Helper automatically sends the following request header on <var>Post</var> calls:		<li>If form fields are defined with <var>[[AddField (HttpRequest subroutine)\|AddField]]</var>, no explicit content type is set with <var>[[AddHeader (HttpRequest subroutine)\|AddHeader]]</var>, and multipart form encoding is ''not'' enabled with <var>[[MultiPartFormEncoding (HttpRequest property)\|MultiPartFormEncoding]]</var>, the <var class="product">HTTP Helper</var> automatically sends the following request header on <var>Post</var> calls:
	<p class="code"> content-type: application/x-www-form-urlencoded		<p class="code"> content-type: application/x-www-form-urlencoded
	</p>		</p>
Line 58:		Line 58:
	==See also==		==See also==
	<ul>		<ul>
	<li>For more information about $STATUS and $STATUSD, see the <var class="product">Model 204</var> <i>~~<b>~~User Language Manual~~</b>~~</i>.		<li>For more information about $STATUS and $STATUSD, see the <var class="product">Model 204</var> <i>[http://cca-int.com/custsupp/zips/Userlang.zip User Language Manual]</i>.
	<li>You can also send an HTTP POST using the <var>[[Send (HttpRequest function)\|Send]]</var> method.		<li>You can also send an HTTP POST using the <var>[[Send (HttpRequest function)\|Send]]</var> method.
	</ul>		</ul>
	{{Template:HttpRequest:Post footer}}		{{Template:HttpRequest:Post footer}}

← Older revision		Revision as of 20:44, 10 October 2012
Line 77:		Line 77:
	==See also==		==See also==
	<ul>		<ul>
	<li>For more information about $STATUS and $STATUSD, see the ~~<var class="product">Model 204</var>~~ <i>[http://~~cca-int~~.com/~~custsupp~~/~~zips~~/~~Userlang.zip~~ User Language Manual]</i>.		<li>For more information about $STATUS and $STATUSD, see the <i>[http://www.rocketsoftware.com/m204/products/index/documentation/v7r4/M204-User-Language/view Rocket Model 204 User Language Manual]</i>.
	<li>You can also send an HTTP POST using the <var>[[Send (HttpRequest function)\|Send]]</var> method.		<li>You can also send an HTTP POST using the <var>[[Send (HttpRequest function)\|Send]]</var> method.
	</ul>		</ul>
	{{Template:HttpRequest:Post footer}}		{{Template:HttpRequest:Post footer}}

← Older revision		Revision as of 20:45, 17 November 2011
Line 21:		Line 21:
	<td>A numeric expression that controls whether the request is cancelled if a communication/socket error occurs. If zero, the request is not cancelled on these errors. If non-zero, the request is cancelled (though a message is still issued). If not specified, it defaults to 1 (cancel). See "Usage notes," below, for further discussion of error handling.		<td>A numeric expression that controls whether the request is cancelled if a communication/socket error occurs. If zero, the request is not cancelled on these errors. If non-zero, the request is cancelled (though a message is still issued). If not specified, it defaults to 1 (cancel). See "Usage notes," below, for further discussion of error handling.
	This is an optional and (as of <var class="product">Sirius Mods</var> version 7.2) name-allowed parameter. If you specify a value, you may (but don't have to) specify the parameter name, <var>Cancel</var> (case not important) if you want.		This is an optional and (as of <var class="product">Sirius Mods</var> version 7.2) name-allowed parameter. If you specify a value, you may (but don't have to) specify the parameter name, <var>Cancel</var> (case not important) if you want.

	<tr><th><var>CertificateCheck</var></th>		<tr><th><var>CertificateCheck</var></th>
	<td>This optional ([[Notation conventions for methods#Named parameters\|name required]]) argument invokes an SSL certificate request from the ~~client~~ at the time of the method call.		<td>This optional ([[Notation conventions for methods#Named parameters\|name required]]) argument invokes an SSL certificate request from the server at the time of the method call.
	The argument value (<var class="term">certificateChecker</var>) must be a function, presumably [[Local and Common entities#Defining and invoking a local method\|local]], with this [[Method variables#Method template in method variable declaration\|method template]]:		The argument value (<var class="term">certificateChecker</var>) must be a function, presumably [[Local and Common entities#Defining and invoking a local method\|local]], with this [[Method variables#Method template in method variable declaration\|method template]]:
	<p class="syntax"><span class="literal">Function (String):</span><span class="term">methname</span> <span class="literal">Is Boolean</span> </p>		<p class="syntax"><span class="literal">Function (String):</span><span class="term">methname</span> <span class="literal">Is Boolean</span> </p>

	When a connection is established, the passed function is called with the certificate (copied to a <var>Longstring</var>) as its method object.		When a connection is established, the passed function is called with the certificate (binary, ASN.1 encoded, content copied to a <var>Longstring</var>) as its method object.
	<ul>		<ul>
	<li>If the function returns a <code>True</code>, the request is completed.		<li>If the function returns a <code>True</code>, the request is completed.
Line 72:		Line 73:
	<li>If the ports associated with the sockets in the HTTP request are not using SSL, and the <var>CertificateCheck</var> argument is specified, the <var class="term">certificateChecker</var> function does not get called.		<li>If the ports associated with the sockets in the HTTP request are not using SSL, and the <var>CertificateCheck</var> argument is specified, the <var class="term">certificateChecker</var> function does not get called.

	<li>Specifying a <code>CertificateCheck</code> function has no effect if issued over a Janus <var>[[SSL]]</var> port whose definition includes <var>[[SSLCLCERT and SSLCLCERTR\|SSLCLCERT]]</var> or <var>[[SSLCLCERT and SSLCLCERTR\|SSLCLCERTR]]</var>. These parameters request a client certificate at connection-establishment time, and a client certificate
	~~may only be requested once for an SSL session (whether or not the request successfully gets a certificate in return).~~
	</ul>		</ul>