ServerSocket (Socket function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
 
(4 intermediate revisions by one other user not shown)
Line 2: Line 2:


This [[Notation conventions for methods#Shared members|shared]] method obtains a reference to a
This [[Notation conventions for methods#Shared members|shared]] method obtains a reference to a
<var>Socket</var> object for the server socket (socket number 1 in the <var>$Sock_xxx</var> API,
<var>Socket</var> object for the server socket (socket number 1 in the [[Janus Sockets $functions|$Sock_xxx API]],
as described in [[Janus Sockets User Language coding considerations#Client versus Server Socket programming|"Client versus Server Socket programming"]].
as described in [[Janus Sockets User Language coding considerations#Client versus Server Socket programming|"Client versus Server Socket programming"]].
It returns a reference to a <var>Socket</var> object instance, which can then be
It returns a reference to a <var>Socket</var> object instance, which can then be
Line 16: Line 16:
<td>A declared socket object or a reference to a <var>Socket</var> object.
<td>A declared socket object or a reference to a <var>Socket</var> object.
</td></tr>
</td></tr>
<tr><th><var>%(Socket)</var></th>
<tr><th><var class="nobr">%(Socket)</var></th>
<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods and constructors|shared]] method. <var>ServerSocket</var> can also be invoked via a <var>Socket</var> object variable, which may be <var>Null</var>.</td></tr>
<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|virtual constructor]] method. See [[#Usage notes|"Usage notes]]" below, for more information about invoking a <var>Socket</var> constructor.  
</table>
</table>


==Usage notes==
==Usage notes==
<ul>
<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">%sock = ServerSocket
%sock = %(Socket):ServerSocket
%sock = %sock:ServerSocket
</p>
<li>After <var>ServerSocket</var> returns, the socket is no longer accessible by its
<li>After <var>ServerSocket</var> returns, the socket is no longer accessible by its
socket number (1).
socket number (1).
Line 30: Line 37:
</ul>
</ul>


==Example==
==Examples==


In the following code fragment, a server socket receives data and replies to its client.
In the following code fragment, a server socket receives data and replies to its client.

Latest revision as of 01:00, 16 February 2014

Get a reference to the server socket (Socket class)


This shared method obtains a reference to a Socket object for the server socket (socket number 1 in the $Sock_xxx API, as described in "Client versus Server Socket programming". It returns a reference to a Socket object instance, which can then be used with instance method calls to access the server socket. ServerSocket has no equivalent $function.

ServerSocket syntax

%socket = [%(Socket):]ServerSocket

Syntax terms

%socket A declared socket object or a reference to a Socket object.
%(Socket) The class name in parentheses denotes a virtual constructor method. See "Usage notes" below, for more information about invoking a Socket 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:

    %sock = ServerSocket %sock = %(Socket):ServerSocket %sock = %sock:ServerSocket

  • After ServerSocket returns, the socket is no longer accessible by its socket number (1). To access the socket by its number again, use GetSocketNumber.
  • ServerSocket can be used to obtain a Socket object reference for a socket already created by $Sock_Conn, or it can operate in an entirely object-oriented application.

Examples

In the following code fragment, a server socket receives data and replies to its client.

Begin %r Float %sepx Float %data is String len 255 %servsock is Object Socket %servsock = %(Socket):ServerSocket %r = %servsock:Set('PRSTOK', 'AMBIG|0D0A|0D|0A|07') %r = %servsock:Set('LINEND', '07') %r = %servsock:ReceiveAndParse(%data) If %r le 0 Then ... If %data eq 'Hello' Then ... %r = %servsock:SendWithLineEnd('OK') ...