LocalHost (UdpSocket property): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
mNo edit summary |
||
| Line 9: | Line 9: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%ipAddress</th> | <tr><th>%ipAddress</th> | ||
<td>A string to contain the returned IP address.</td></tr> | <td>A string to contain the returned IP address of the host to which <var class="term">udpSocket</var> is bound.</td></tr> | ||
<tr><th>udpSocket</th> | <tr><th>udpSocket</th> | ||
<td>A <var>UdpSocket</var> object.</td></tr> | <td>A <var>UdpSocket</var> object.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | |||
<ul> | |||
<li>If a local host is specified 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== | |||
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}} | ||
Revision as of 22:08, 10 December 2012
Local IP address for bound socket (UdpSocket class)
[Introduced in Sirius Mods 8.0]
This page is under construction.
Syntax
%ipAddress = udpSocket:LocalHost
Syntax terms
| %ipAddress | A string to contain the returned IP address of the host to which udpSocket is bound. |
|---|---|
| udpSocket | A UdpSocket object. |
Usage notes
- If a local host is specified 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.