ServerSocket (UdpSocket function): Difference between revisions
Jump to navigation
Jump to search
m (Automatically generated page update) |
m (→Usage notes) |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
This page is [[under construction]]. | This page is [[under construction]]. | ||
==Syntax== | ==Syntax== | ||
{{Template:UdpSocket:ServerSocket syntax}} | {{Template:UdpSocket:ServerSocket syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%outUdpSocket</th><td><var>UdpSocket</var> object</td></tr> | <tr><th>%outUdpSocket</th> | ||
<td>A <var>UdpSocket</var> object.</td></tr> | |||
<tr><th nowrap="true"><var>[%(UdpSocket):]</var></th> | <tr><th nowrap="true"><var>[%(UdpSocket):]</var></th> | ||
<td>The optional class name in parentheses denotes a [[Notation conventions for methods#Constructors|virtual constructor]]. See [[#Usage notes|"Usage notes"]], below, for more information about invoking a virtual constructor.</td></tr> | <td>The optional class name in parentheses denotes a [[Notation conventions for methods#Constructors|virtual constructor]]. See [[#Usage notes|"Usage notes"]], below, for more information about invoking a virtual constructor.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | |||
<li><var>ServerSocket</var> is a [[Object variables#Virtual Constructor methods|virtual constructor]] and as such can be called with no method object, with an explicit class name, or with an object variable, even if that object is <var>Null</var>: | |||
<p class="code">%udpSock = ServerSocket | |||
%udpSock = %(UdpSocket):ServerSocket | |||
%udpSock = %udpSock:ServerSocket | |||
</p> | |||
<li>The <var>ServerSocket</var> method turns the server socket into a client | |||
socket — any server activity (line input, etc.) results in request | |||
cancellation for any subsequent <var>ServerSocket</var> calls and results in logout for any line input. | |||
</ul> | |||
==Examples== | ==Examples== | ||
==See also== | ==See also== | ||
{{Template:UdpSocket:ServerSocket footer}} | {{Template:UdpSocket:ServerSocket footer}} | ||
Latest revision as of 23:23, 10 December 2012
Get server UdpSocket object (UdpSocket class)
[Introduced in Sirius Mods 8.0]
This page is under construction.
Syntax
%udpSocket = [%(UdpSocket):]ServerSocket
Syntax terms
| %outUdpSocket | A UdpSocket object. |
|---|---|
| [%(UdpSocket):] | The optional class name in parentheses denotes a virtual constructor. See "Usage notes", below, for more information about invoking a virtual constructor. |
Usage notes
- ServerSocket is a virtual constructor and as such can be called with no method object, with an explicit class name, or with an object variable, even if that object is Null:
%udpSock = ServerSocket %udpSock = %(UdpSocket):ServerSocket %udpSock = %udpSock:ServerSocket
- The ServerSocket method turns the server socket into a client socket — any server activity (line input, etc.) results in request cancellation for any subsequent ServerSocket calls and results in logout for any line input.