REMOTE (JANUS DEFINE parameter): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (remove displaytitle) |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<span class="pageSubtitle">REMOTE hostID portnum | * — remote host and port identifier</span> | |||
<span class="pageSubtitle" | |||
<var>REMOTE</var> is a parameter on [[JANUS DEFINE]], which defines and sets characteristics of a Janus port | <var>REMOTE</var> is a parameter on <var>[[JANUS DEFINE]]</var>, which defines and sets characteristics of a Janus port. | ||
This parameter identifies the remote server and the remote port number to be used with a set of | This parameter identifies the remote server and the remote port number to be used with a set of <var class="product">[[Janus Sockets]]</var> <var>[[JANUS DEFINE#type|CLSOCK]]</var> connections or with <var>[[JANUS DEFINE#type|DEBUGGERCLIENT]]</var> connections. | ||
<var class="term">hostID</var> can be any one of the following: | |||
<ul> | <ul> | ||
<li>An IP address. | <li>An IP address. | ||
<li>A host name. | |||
<li>Pattern matching characters that identify the host name. In this case, the $function or object method that establishes the remote host | <li>A host name. | ||
<li>Pattern matching characters that identify the host name. In this case, the $function or object method that establishes the remote host — <var>[[$Sock_Conn]]</var>, the <var>Socket</var> class <var>[[New (Socket constructor)|New]]</var> constructor, or the <var class="product">[[HTTP Helper]]</var> <var>[[URL (HttpRequest property)|URL]]</var> or <var>[[Host (HttpRequest property)|Host]]</var> methods — must specify the actual host ID, which must satisfy the pattern. | |||
<li>An asterisk (*), which means whatever host is specified on the $function or object method that establishes the remote host. This is the default. | <li>An asterisk (*), which means whatever host is specified on the $function or object method that establishes the remote host. This is the default. | ||
</ul> | </ul> | ||
<var class="term">portnum</var> can be either of the following: | |||
<ul> | <ul> | ||
| Line 22: | Line 24: | ||
</ul> | </ul> | ||
If you use a pattern or asterisk for | If you use a pattern or asterisk for <var class="term">hostId</var>, or an asterisk for <var class="term">portnum</var>, the identity of the remote server is not fully determined until the invocation of the $function or object method that establishes the remote host. Any host ID and port number specified as arguments on that invocation must be a match for the <var class="term">hostID</var> and <var class="term">portnum</var> combination. If you specify <code>REMOTE * *</code>, any <var class="term">hostID</var> and <var class="term">portnum</var> on that invocation are a match. | ||
If the default setting, <code>REMOTE * *</code>, is in effect for a CLSOCK or <var> | If the default setting, <code>REMOTE * *</code>, is in effect for a <var>CLSOCK</var> or <var>DEBUGGERCLIENT</var> port, <code>REMOTE * *</code> is not included in <var>[[JANUS DISPLAY]]</var> output. | ||
The [[JANUS CLSOCK]] command is required to allow a User Language application to access the CLSOCK or <var> | The <var>[[JANUS CLSOCK]]</var> command is required to allow a <var class="product">User Language</var> application to access the <var>CLSOCK</var> or <var>DEBUGGERCLIENT</var> port, and it can be used to further restrict both the <var class="term">hostID</var> and <var class="term">portnum</var> specified on the port definition. (System administrators are not subject to <var>CLSOCK</var> or <var>DEBUGGERCLIENT</var> access restrictions.) | ||
See [[$Sock_Conn]] or the | See <var>[[$Sock_Conn]]</var> or the <var>Socket</var> class <var>[[New (Socket constructor)|New]]</var> constructor for a discussion of the arguments provided to <var>$Sock_Conn</var> or to <var>New</var> and their interaction with <var>JANUS DEFINE REMOTE</var>. | ||
<var>REMOTE</var> is valid only for CLSOCK and <var> | <var>REMOTE</var> is valid only for <var>CLSOCK</var> and <var>DEBUGGERCLIENT</var> ports, for which it is a required parameter. | ||
==See also== | ==See also== | ||
<ul> | <ul> | ||
<li>[[List of Janus commands]] | <li>[[List of Janus commands]] | ||
Latest revision as of 23:00, 7 June 2016
REMOTE hostID portnum | * — remote host and port identifier
REMOTE is a parameter on JANUS DEFINE, which defines and sets characteristics of a Janus port.
This parameter identifies the remote server and the remote port number to be used with a set of Janus Sockets CLSOCK connections or with DEBUGGERCLIENT connections.
hostID can be any one of the following:
- An IP address.
- A host name.
- Pattern matching characters that identify the host name. In this case, the $function or object method that establishes the remote host — $Sock_Conn, the Socket class New constructor, or the HTTP Helper URL or Host methods — must specify the actual host ID, which must satisfy the pattern.
- An asterisk (*), which means whatever host is specified on the $function or object method that establishes the remote host. This is the default.
portnum can be either of the following:
- A TCP/IP port number in the range 1 through 65535.
- An asterisk (*), which means whatever port number is specified on the $function or object method that establishes the remote host. This is the default.
If you use a pattern or asterisk for hostId, or an asterisk for portnum, the identity of the remote server is not fully determined until the invocation of the $function or object method that establishes the remote host. Any host ID and port number specified as arguments on that invocation must be a match for the hostID and portnum combination. If you specify REMOTE * *, any hostID and portnum on that invocation are a match.
If the default setting, REMOTE * *, is in effect for a CLSOCK or DEBUGGERCLIENT port, REMOTE * * is not included in JANUS DISPLAY output.
The JANUS CLSOCK command is required to allow a User Language application to access the CLSOCK or DEBUGGERCLIENT port, and it can be used to further restrict both the hostID and portnum specified on the port definition. (System administrators are not subject to CLSOCK or DEBUGGERCLIENT access restrictions.)
See $Sock_Conn or the Socket class New constructor for a discussion of the arguments provided to $Sock_Conn or to New and their interaction with JANUS DEFINE REMOTE.
REMOTE is valid only for CLSOCK and DEBUGGERCLIENT ports, for which it is a required parameter.