Protocol (HttpRequest property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 1: Line 1:
<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
{{Template:HTTPRequest:Protocol subtitle}}
[[Category:HTTPRequest methods|Protocol property]]


This property sets and returns the TCP/IP protocol for the HTTP request.
This property sets and returns the TCP/IP protocol for the HTTP request.
Line 8: Line 7:
If left unset, it defaults to <code>http</code>.
If left unset, it defaults to <code>http</code>.
==Syntax==
==Syntax==
<p class="syntax">%httpreq:Protocol = protocolval
{{Template:HTTPRequest:Protocol syntax}}
 
%curr = %httpreq:Protocol
</p>
 
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
Line 38: Line 33:
automatically sets <var>Port</var> to the standard HTTP port (80).
automatically sets <var>Port</var> to the standard HTTP port (80).
</ul>
</ul>
==See also==
{{Template:HTTPRequest:Protocol footer}}

Revision as of 18:26, 15 June 2011

Template:HTTPRequest:Protocol subtitle

This property sets and 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

Template:HTTPRequest:Protocol syntax

Syntax terms

%httpreq A previously defined and instantiated HTTPRequest object.
protocolval 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.
%curr A string or longstring variable for the assignment of the current value of Protocol.

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 https as the Protocol value, the Janus port definition must specify both the SSL and SSLOPT parameters.
  • Setting the TCP/IP protocol to https automatically sets the Port property to the standard SSL port (443). Setting the protocol to http automatically sets Port to the standard HTTP port (80).

See also

Template:HTTPRequest:Protocol footer