LocalHost (UdpSocket property): Difference between revisions
Jump to navigation
Jump to search
m (Automatically generated page update) |
m (add IPV6 address format) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:UdpSocket:LocalHost subtitle}} | {{Template:UdpSocket:LocalHost subtitle}} | ||
==Syntax== | ==Syntax== | ||
{{Template:UdpSocket:LocalHost syntax}} | {{Template:UdpSocket:LocalHost syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%ipAddress</th><td>string</td></tr> | <tr><th>%ipAddress</th> | ||
<td>A string to contain the returned IP address of the host to which <var class="term">udpSocket</var> is bound. <var class="term">%ipAddress</var> might contain an IP address specified in either: | |||
<ul> | |||
<li>IPV4 standard 32-bit "dotted-decimal" form: for example, <code>198.242.244.97</code>. </li> | |||
<li>IPV6 standard ([https://tools.ietf.org/html/rfc5952 RFC 5952]) 128-bit form: for example, <code>2011:0ab4:15a1::4a0e:0280:5274</code> | |||
<p> | |||
The IPV6 form is supported as of version 7.7 of Model 204. </p></li> | |||
</ul> | |||
<p> | |||
The address format is IPV4 unless the <var>[[TCPTYPE parameter|TCPTYPE]]</var> parameter is explicitly set to an IPV6 value.</p></td></tr> | |||
<tr><th>udpSocket</th> | <tr><th>udpSocket</th> | ||
<td>UdpSocket object</td></tr> | <td>A <var>UdpSocket</var> object.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | |||
<li>If a local host was defined for a <var>UdpSocket</var> object (by a <var>[[BINDADDR (JANUS DEFINE parameter)|BINDADDR]]</var> specification on the <var>CLSOCKU</var> port used for the <var>UdpSocket</var>, or by a <var>LocalHost</var> parameter setting on the <var>[[New (UdpSocket constructor)|New]]</var> method that created the <var>UdpSocket</var> object), | |||
the socket only receives messages that are sent to that local host IP address. | |||
</ul> | |||
==Examples== | ==Examples== | ||
For <var>UdpSocket</var> examples of interest, see the [[New (UdpSocket constructor)#Examples|Examples]] section of the <var>UdpSocket</var> <var>New</var> method. | |||
==See also== | ==See also== | ||
{{Template:UdpSocket:LocalHost footer}} | {{Template:UdpSocket:LocalHost footer}} | ||
Latest revision as of 21:54, 6 December 2016
Local IP address for bound socket (UdpSocket class)
[Introduced in Sirius Mods 8.0]
Syntax
%ipAddress = udpSocket:LocalHost
Syntax terms
| %ipAddress | A string to contain the returned IP address of the host to which udpSocket is bound. %ipAddress might contain an IP address specified in either:
The address format is IPV4 unless the TCPTYPE parameter is explicitly set to an IPV6 value. |
|---|---|
| udpSocket | A UdpSocket object. |
Usage notes
- If a local host was defined for a UdpSocket object (by a BINDADDR specification on the CLSOCKU port used for the UdpSocket, or by a LocalHost parameter setting on the New method that created the UdpSocket object), the socket only receives messages that are sent to that local host IP address.
Examples
For UdpSocket examples of interest, see the Examples section of the UdpSocket New method.