Protocol (HttpRequest property): Difference between revisions
Jump to navigation
Jump to search
m (match syntax table to syntax template; edits and tags) |
m (match syntax table to syntax template; edits and tags) |
||
| Line 1: | Line 1: | ||
{{Template:HttpRequest:Protocol subtitle}} | {{Template:HttpRequest:Protocol subtitle}} | ||
The <var>Protocol</var> property sets | The <var>Protocol</var> property sets or returns the TCP/IP protocol for the HTTP request. The protocols supported are <code>http</code> (standard web protocol) and <code>https</code> (Secure Sockets Layer, or, SSL). | ||
If left unset, it defaults to <code>http</code>. | If left unset, it defaults to <code>http</code>. | ||
| Line 7: | Line 7: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>currentString</th> | <tr><th>%currentString</th> | ||
<td>A string or [[Longstrings|Longstring]] variable for the assignment of the current value of <var>Protocol</var>.</td></tr> | <td>A string or [[Longstrings|Longstring]] variable for the assignment of the current value of <var>Protocol</var>.</td></tr> | ||
<tr><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> | ||
<tr><th>newString</th> | <tr><th>newString</th> | ||
Latest revision as of 04:15, 19 June 2011
HTTP request protocol (HttpRequest class)
The Protocol property sets or returns the TCP/IP protocol for the HTTP request. The protocols supported are http (standard web protocol) and https (Secure Sockets Layer, or, SSL).
If left unset, it defaults to http.
Syntax
%currentString = httpRequest:Protocol httpRequest:Protocol = newString
Syntax terms
| %currentString | A string or Longstring variable for the assignment of the current value of Protocol. |
|---|---|
| httpRequest | A previously defined and instantiated HttpRequest object. |
| newString | A string expression that identifies the protocol to use. It must have a value of http or https. It is case insensitive. If the value is not http or https, the request is cancelled. |
Usage notes
- You must not set a Protocol value that conflicts with the protocol specified on the JANUS CLSOCK port definition your HTTP request will reference. For example, to successfully use
httpsas the Protocol value, the Janus port definition must specify both the SSL and SSLOPT parameters. - Setting the TCP/IP protocol to
httpsautomatically sets the Port property to the standard SSL port (443). Setting the protocol tohttpautomatically sets Port to the standard HTTP port (80).