Send (HttpRequest function) - Revision history

JAL: misc cleanup

2016-03-15T16:35:30Z

misc cleanup

← Older revision		Revision as of 16:35, 15 March 2016
Line 4:		Line 4:
	The HTTP method type is specified with the <var>Method</var> ([[Notation conventions for methods#Named parameters\|name required]]) parameter. If the <var>Method</var> value is <code>GET</code> or <code>POST</code>, the <var>Send</var> method invocation becomes equivalent to the <var>[[Get (HttpRequest function)\|Get]]</var> or <var>[[Post (HttpRequest function)\|Post]]</var> method.		The HTTP method type is specified with the <var>Method</var> ([[Notation conventions for methods#Named parameters\|name required]]) parameter. If the <var>Method</var> value is <code>GET</code> or <code>POST</code>, the <var>Send</var> method invocation becomes equivalent to the <var>[[Get (HttpRequest function)\|Get]]</var> or <var>[[Post (HttpRequest function)\|Post]]</var> method.

	Prior to the addition of the <var>Send</var> method in <var class="product">[[Sirius Mods]]</var> Version 7.2, the <var>[[HttpRequest class\|HttpRequest]]</var> class had methods only for HTTP GETs and POSTs. The <var>Send</var> method is the only way to carry out HTTP methods other than GET or POST.		The <var>Send</var> method is the only way to carry out HTTP methods other than GET or POST.

	==Syntax==		==Syntax==
	{{Template:HttpRequest:Send syntax}}		{{Template:HttpRequest:Send syntax}}

	===Syntax terms===		===Syntax terms===
	<table ~~class="syntaxTable"~~>		<table>
	<tr><th>%httpresponse</th>		<tr><th>%httpresponse</th>
	<td>A reference to the <var>[[HttpResponse class\|HttpResponse]]</var> object instantiated and returned by this <var>Send</var> method.		<td>A reference to the <var>[[HttpResponse class\|HttpResponse]]</var> object instantiated and returned by this <var>Send</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 ~~''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 default value is the [[MASTER]] port, if any is defined. However, if you do not specify a value 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 ~~wish~~.		<p>
	</td></tr>		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. </p></td></tr>

	<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 server 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>
			<p>
	When a connection is established, the passed function is called with the certificate (binary content, ASN.1 encoded, copied to a <var>Longstring</var>) as its method object.		When a connection is established, the passed function is called with the certificate (binary content, ASN.1 encoded, 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>

	For a <var>CertificateCheck</var> function example, see [[Get_(HttpRequest_function)#Examples\|"Examples"]] for the <var>Get</var> method.		For a <var>CertificateCheck</var> function example, see [[Get_(HttpRequest_function)#Examples\|Examples]] for the <var>Get</var> method.</td></tr>
	</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. </td></tr>

	<tr><th><var>Method</var></th>		<tr><th><var>Method</var></th>
	<td><var ~~class="term~~>Method</var> is both a required and [[Methods#Named parameters\|name required]] parameter that specifies the quoted name of any HTTP method type (for example, 'GET', 'PUT', 'MOVE').		<td><var>Method</var> is both a required and [[Methods#Named parameters\|name required]] parameter that specifies the quoted name of any HTTP method type (for example, <code>'GET'</code>, <code>'PUT'</code>, <code>'MOVE'</code>).
	The parameter name, <var ~~class="term~~>Method</var>, is not case sensitive, but it must be supplied. The type <var class="term">name</var> must be less than or equal to 16 characters, all uppercase.		The parameter name, <var>Method</var>, is not case sensitive, but it must be supplied. The type <var class="term">name</var> must be less than or equal to 16 characters, all uppercase. </td></tr>
	</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>Although you may specify the <var class="term>Method</var> parameter before the optional parameters, you receive a compilation error if you do so without also specifying the optional parameter names with the optional parameters.		<li>Although you may specify the <var class="term>Method</var> parameter before the optional parameters, you receive a compilation error if you do so without also specifying the optional parameter names with the optional parameters. </li>

	<li>For information about error handling, see the <var>Get</var> function [[Get (HttpRequest function)#Usage notes\|"Usage notes"]].		<li>For information about error handling, see the <var>Get</var> function [[Get (HttpRequest function)#Usage notes\|"Usage notes"]].
	<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>

	<li>To send an HTTP GET or POST, you can also use the <var>Get</var> method or the <var>Post</var> method, respectively.		<li>To send an HTTP GET or POST, you can also use the <var>Get</var> method or the <var>Post</var> method, respectively. </li>
	</ul>		</ul>

	==Examples==		==Examples==
	<var>Send</var> statements with argument variations are shown below:		<var>Send</var> statements with argument variations are shown below:
	<p class="code"> %resp = %req:send(method='DELETE')		<p class="code">%resp = %req:send(method='DELETE')

	%resp = %req:send('CLPORT', method='DELETE')		%resp = %req:send('CLPORT', method='DELETE')

	%resp = %req:send(method='POST', port='CLPORT', cancel=1)		%resp = %req:send(method='POST', port='CLPORT', cancel=1)
	</p>		</p>

	==See also==		==See also==
	<ul>		<ul>
	<li>For information about the HTTP protocol, refer to http://www.w3.org/Protocols/rfc2616/rfc2616.html.		<li>For information about the HTTP protocol, refer to http://www.w3.org/Protocols/rfc2616/rfc2616.html. </li>
	</ul>		</ul>

	{{Template:HttpRequest:Send footer}}		{{Template:HttpRequest:Send footer}}

JAL2 at 20:50, 17 November 2011

2011-11-17T20:50:03Z

JAL2: /* Usage notes */

2011-11-16T23:57:16Z

Usage notes

← Older revision		Revision as of 23:57, 16 November 2011
Line 51:		Line 51:
	<li>Although you may specify the <var class="term>Method</var> parameter before the optional parameters, you receive a compilation error if you do so without also specifying the optional parameter names with the optional parameters.		<li>Although you may specify the <var class="term>Method</var> parameter before the optional parameters, you receive a compilation error if you do so without also specifying the optional parameter names with the optional parameters.
	<li>For information about error handling, see the <var>Get</var> function [[Get (HttpRequest function)#Usage notes\|"Usage notes"]].		<li>For information about error handling, see the <var>Get</var> function [[Get (HttpRequest function)#Usage notes\|"Usage notes"]].
			<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).

	<li>To send an HTTP GET or POST, you can also use the <var>Get</var> method or the <var>Post</var> method, respectively.		<li>To send an HTTP GET or POST, you can also use the <var>Get</var> method or the <var>Post</var> method, respectively.
	</ul>		</ul>

JAL2: /* Syntax terms */

2011-11-16T17:16:18Z

Syntax terms

← Older revision		Revision as of 17:16, 16 November 2011
Line 11:		Line 11:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%httpresponse</th>		<tr><th>%httpresponse</th>
	<td>A reference to the <var>[[~~HTTPResponse~~]]</var> object instantiated and returned by this <var>Send</var> method.		<td>A reference to the <var>[[HttpResponse class\|HttpResponse]]</var> object instantiated and returned by this <var>Send</var> method.
	</td></tr>		</td></tr>
	<tr><th>httpRequest</th>		<tr><th>httpRequest</th>
Line 36:		Line 36:
	</ul>		</ul>

	For a <var>CertificateCheck</var> function example, see [[#Examples\|"Examples"]].		For a <var>CertificateCheck</var> function example, see [[Get_(HttpRequest_function)#Examples\|"Examples"]] for the <var>Get</var> method.
	</td></tr>		</td></tr>
	<tr><th><var>CheckKeepAliveCertificate</var></th>		<tr><th><var>CheckKeepAliveCertificate</var></th>

JAL2: /* Syntax terms */

2011-11-16T17:08:43Z

Syntax terms

@@ Line 24: / Line 24: @@
 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.
 </td></tr>
 <tr><th><var>Method</var></th>
 <td><var class="term>Method</var> is both a required and [[Methods#Named parameters|name required]] parameter that specifies the quoted name of any HTTP method type (for example, 'GET', 'PUT', 'MOVE').

Dme at 22:24, 21 June 2011

2011-06-21T22:24:33Z

← Older revision		Revision as of 22:24, 21 June 2011
Line 4:		Line 4:
	The HTTP method type is specified with the <var>Method</var> ([[Notation conventions for methods#Named parameters\|name required]]) parameter. If the <var>Method</var> value is <code>GET</code> or <code>POST</code>, the <var>Send</var> method invocation becomes equivalent to the <var>[[Get (HttpRequest function)\|Get]]</var> or <var>[[Post (HttpRequest function)\|Post]]</var> method.		The HTTP method type is specified with the <var>Method</var> ([[Notation conventions for methods#Named parameters\|name required]]) parameter. If the <var>Method</var> value is <code>GET</code> or <code>POST</code>, the <var>Send</var> method invocation becomes equivalent to the <var>[[Get (HttpRequest function)\|Get]]</var> or <var>[[Post (HttpRequest function)\|Post]]</var> method.

	Prior to the addition of the <var>Send</var> method in <var class="product">[[Sirius Mods]]</var> Version 7.2, the <var>[[HttpRequest]]</var> class had methods only for HTTP GETs and POSTs. The <var>Send</var> method is the only way to carry out HTTP methods other than GET or POST.		Prior to the addition of the <var>Send</var> method in <var class="product">[[Sirius Mods]]</var> Version 7.2, the <var>[[HttpRequest class\|HttpRequest]]</var> class had methods only for HTTP GETs and POSTs. The <var>Send</var> method is the only way to carry out HTTP methods other than GET or POST.

	==Syntax==		==Syntax==

JAL2: /* Usage notes */

2011-06-21T21:47:31Z

Usage notes

← Older revision		Revision as of 21:47, 21 June 2011
Line 34:		Line 34:
	<li>Although you may specify the <var class="term>Method</var> parameter before the optional parameters, you receive a compilation error if you do so without also specifying the optional parameter names with the optional parameters.		<li>Although you may specify the <var class="term>Method</var> parameter before the optional parameters, you receive a compilation error if you do so without also specifying the optional parameter names with the optional parameters.
	<li>For information about error handling, see the <var>Get</var> function [[Get (HttpRequest function)#Usage notes\|"Usage notes"]].		<li>For information about error handling, see the <var>Get</var> function [[Get (HttpRequest function)#Usage notes\|"Usage notes"]].
	<li>To send an HTTP GET or POST, you can also use the <var>[[Get ~~(HttpRequest function)\|Get]]~~</var> method or the <var>~~[[Post (HttpRequest function)\|~~Post]]</var> method, respectively.		<li>To send an HTTP GET or POST, you can also use the <var>Get</var> method or the <var>Post</var> method, respectively.
	</ul>		</ul>

JAL2 at 21:46, 21 June 2011

2011-06-21T21:46:03Z

← Older revision		Revision as of 21:46, 21 June 2011
Line 16:		Line 16:
	<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 ''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.
	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.
	</td></tr>		</td></tr>
	<tr><th>Method</th>		<tr><th><var>Method</var></th>
	<td><var class="term>Method</var> is both a required and ~~<var>~~[[Methods#Named parameters\|~~Name-Required~~]]~~</var>~~ parameter ~~specifying~~ the quoted name of any HTTP method type (for example, 'GET', 'PUT', 'MOVE').		<td><var class="term>Method</var> is both a required and [[Methods#Named parameters\|name required]] parameter that specifies the quoted name of any HTTP method type (for example, 'GET', 'PUT', 'MOVE').
	The <var class="term>Method</var> ~~name~~ is not case sensitive, but must be supplied~~; while the method~~ <i>~~string~~</i> must be less than or equal to 16 characters ~~long~~, all uppercase.		The parameter name, <var class="term>Method</var>, is not case sensitive, but it must be supplied. The type <var class="term">name</var> must be less than or equal to 16 characters, all uppercase.
	</td></tr>		</td></tr>
	</table>		</table>
Line 38:		Line 38:

	==Examples==		==Examples==
	~~<ol>~~
	~~<li>~~
	<var>Send</var> statements with argument variations are shown below:		<var>Send</var> statements with argument variations are shown below:
	<p class="code"> %resp = %req:send(method='DELETE')		<p class="code"> %resp = %req:send(method='DELETE')
Line 47:		Line 45:
	%resp = %req:send(method='POST', port='CLPORT', cancel=1)		%resp = %req:send(method='POST', port='CLPORT', cancel=1)
	</p>		</p>
	~~</ol>~~

	==See also==		==See also==

JAL2 at 21:35, 21 June 2011

2011-06-21T21:35:00Z

← Older revision		Revision as of 21:35, 21 June 2011
Line 2:		Line 2:
	The <var>Send</var> function sends an HTTP request to an HTTP server using a parameter value to identify which of the HTTP method types (GET, POST, DELETE, and so on) you want the function to perform. Any HTTP method type is valid as long as its name is 16 characters or less.		The <var>Send</var> function sends an HTTP request to an HTTP server using a parameter value to identify which of the HTTP method types (GET, POST, DELETE, and so on) you want the function to perform. Any HTTP method type is valid as long as its name is 16 characters or less.

	The HTTP method type is specified with the <var ~~class="term"~~>Method</var> ([[Notation conventions for methods#Named parameters\|name required]]) parameter. If the <var ~~class="term"~~>Method</var> value is <code>GET</code> or <code>POST</code>, the <var>Send</var> method invocation becomes equivalent to the <var>[[Get (HttpRequest function)\|Get]]</var> or [[Post (HttpRequest function)\|Post]] method.		The HTTP method type is specified with the <var>Method</var> ([[Notation conventions for methods#Named parameters\|name required]]) parameter. If the <var>Method</var> value is <code>GET</code> or <code>POST</code>, the <var>Send</var> method invocation becomes equivalent to the <var>[[Get (HttpRequest function)\|Get]]</var> or <var>[[Post (HttpRequest function)\|Post]]</var> method.

	Prior to the addition of the <var>Send</var> method in <var class="product">[[Sirius Mods]]</var> Version 7.2, the <var>[[HttpRequest]]</var> class had methods only for HTTP GETs and POSTs. The <var>Send</var> method is the only way to carry out HTTP methods other than GET or POST.		Prior to the addition of the <var>Send</var> method in <var class="product">[[Sirius Mods]]</var> Version 7.2, the <var>[[HttpRequest]]</var> class had methods only for HTTP GETs and POSTs. The <var>Send</var> method is the only way to carry out HTTP methods other than GET or POST.

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

2011-06-19T04:45:32Z

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

← Older revision		Revision as of 04:45, 19 June 2011
Line 1:		Line 1:
	{{Template:HttpRequest:Send subtitle}}		{{Template:HttpRequest:Send subtitle}}
			The <var>Send</var> function sends an HTTP request to an HTTP server using a parameter value to identify which of the HTTP method types (GET, POST, DELETE, and so on) you want the function to perform. Any HTTP method type is valid as long as its name is 16 characters or less.

	The ~~Send function sends an~~ HTTP ~~request to an HTTP server~~		The HTTP method type is specified with the <var class="term">Method</var> ([[Notation conventions for methods#Named parameters\|name required]]) parameter. If the <var class="term">Method</var> value is <code>GET</code> or <code>POST</code>, the <var>Send</var> method invocation becomes equivalent to the <var>[[Get (HttpRequest function)\|Get]]</var> or [[Post (HttpRequest function)\|Post]] method.
	~~using a~~ parameter value to ~~identify which of~~ the ~~HTTP method types~~
	(~~GET, POST, DELETE, and so on~~) ~~you want the~~ function ~~to perform.~~
	~~Any HTTP~~ method ~~type is valid as long as its name is 16 characters or less~~.

	~~The HTTP method type is specified with~~ the <var>~~Method~~</var>		Prior to the addition of the <var>Send</var> method in <var class="product">[[Sirius Mods]]</var> Version 7.2, the <var>[[HttpRequest]]</var> class had methods only for HTTP GETs and POSTs. The <var>Send</var> method is the only way to carry out HTTP methods other than GET or POST.
	([[~~Notation conventions for methods#Named parameters\|name required~~]]~~) parameter.~~
	~~If the Method value is <code>GET~~</~~code> or <code>POST</code~~>,
	the <var>~~Send~~</var> ~~method invocation becomes equivalent to the~~ <var>~~[[Get (HttpRequest function)\|Get]]~~</var>
	or ~~[[Post (HttpRequest function)\|Post]] method~~.

	~~Prior to the addition of the Send method in <var class="product">Sirius Mods</var> version 7.2, the~~
	~~HttpRequest class had methods only for HTTP GETs and POSTs.~~
	~~The Send method is the only way to carry out HTTP methods other than GET or POST.~~
	==Syntax==		==Syntax==
	{{Template:HttpRequest:Send syntax}}		{{Template:HttpRequest:Send syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~httpresp~~</th>		<tr><th>%httpresponse</th>
	<td>A reference to the HTTPResponse object instantiated and returned by this Send method.		<td>A reference to the <var>[[HTTPResponse]]</var> object instantiated and returned by this <var>Send</var> method.
	</td></tr>		</td></tr>
	<tr><th>~~%httpreq~~</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~~=name</var>~~</th>		<tr><th>Port</th>
	<td>A string expression that identifies a previously defined ~~Janus~~ CLSOCK port. The ''name'' default is the ~~<var>~~[[MASTER]]~~</var>~~ port, if any is defined. However, if you omit ''name'' and no <var>MASTER</var> port is defined, the request is ~~cancelled~~.		<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.
	This ~~argument~~ is optional~~, but if~~ you specify a value, the parameter name, <var>Port</var> (case not important)~~, is [[Notation conventions for methods#Named parameters\|allowed]] as a qualifier~~.		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.
	</td></tr>		</td></tr>
	<tr><th~~><var~~>Cancel~~=num</var>~~</th>		<tr><th>Cancel</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 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 ~~argument~~ is optional~~, but if~~ you specify a value, the parameter name, <var>Cancel</var> (case not important)~~, is allowed as a qualifier~~.		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.
	</td></tr>		</td></tr>
	<tr><th><var>Method~~=methodname~~</var><~~/th~~>		<tr><th>Method</th>
	<td>~~The~~ quoted name of any HTTP method type (for example, 'GET', 'PUT', 'MOVE'), ~~as long as it is~~ less than or equal to 16 characters long, all uppercase.		<td><var class="term>Method</var> is both a required and <var>[[Methods#Named parameters\|Name-Required]]</var> parameter specifying the quoted name of any HTTP method type (for example, 'GET', 'PUT', 'MOVE').
	~~This argument is required, and the parameter name,~~ <~~var~~>~~Method~~</~~var~~> ~~(case not important), is a required qualifier.~~		The <var class="term>Method</var> name is not case sensitive, but must be supplied; while the method <i>string</i> must be less than or equal to 16 characters long, all uppercase.
			</td></tr>
			</table>

	~~</td></tr></table>~~
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>Although you may specify the <var>Method</var> parameter before the optional		<li>Although you may specify the <var class="term>Method</var> parameter before the optional parameters, you receive a compilation error if you do so without also specifying the optional parameter names with the optional parameters.
	parameters, you receive a compilation error if you do so without		<li>For information about error handling, see the <var>Get</var> function [[Get (HttpRequest function)#Usage notes\|"Usage notes"]].
	also specifying the optional parameter names with the optional parameters.		<li>To send an HTTP GET or POST, you can also use the <var>[[Get (HttpRequest function)\|Get]]</var> method or the <var>[[Post (HttpRequest function)\|Post]]</var> method, respectively.
	~~<li>For information~~
	~~about the HTTP protocol, refer to http://www.w3.org/Protocols/rfc2616/rfc2616.html~~.
	<li>For information about error handling, see~~, for example,~~ the <var>Get</var> function
	[[Get (HttpRequest function)#Usage notes\|"Usage notes"]].
	<li>To send an HTTP GET or POST, you can also use the <var>[[Get (HttpRequest function)\|Get]]</var> method
	or the <var>[[Post (HttpRequest function)\|Post]]</var> method, respectively.
	</ul>		</ul>

	==Examples==		==Examples==
			<ol>
			<li>
	<var>Send</var> statements with argument variations are shown below:		<var>Send</var> statements with argument variations are shown below:
	<p class="code"> %resp = %req:send(method='DELETE')		<p class="code"> %resp = %req:send(method='DELETE')
Line 59:		Line 47:
	%resp = %req:send(method='POST', port='CLPORT', cancel=1)		%resp = %req:send(method='POST', port='CLPORT', cancel=1)
	</p>		</p>
			</ol>

	==See also==		==See also==
			<ul>
			<li>For information about the HTTP protocol, refer to http://www.w3.org/Protocols/rfc2616/rfc2616.html.
			</ul>
	{{Template:HttpRequest:Send footer}}		{{Template:HttpRequest:Send footer}}

← Older revision		Revision as of 20:50, 17 November 2011
Line 25:		Line 25:
	</td></tr>		</td></tr>
	<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 content, ASN.1 encoded, 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 52:		Line 52:
	<li>For information about error handling, see the <var>Get</var> function [[Get (HttpRequest function)#Usage notes\|"Usage notes"]].		<li>For information about error handling, see the <var>Get</var> function [[Get (HttpRequest function)#Usage notes\|"Usage notes"]].
	<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).~~

	<li>To send an HTTP GET or POST, you can also use the <var>Get</var> method or the <var>Post</var> method, respectively.		<li>To send an HTTP GET or POST, you can also use the <var>Get</var> method or the <var>Post</var> method, respectively.