Close (Socket function): Difference between revisions

Revision as of 23:02, 14 November 2011

Close this socket connection (Socket class)

This method terminates the sending and receiving of data on, and removes from use, a Janus Sockets connection. The Close method, which may be invoked with a Call statement, has an effect similar to its equivalent $function, $Sock_Close.

Syntax

Close this socket connection (Socket class)

Syntax terms

%conn	If specified, this is a numeric variable to contain the returned value `1` from `Close`, indicating the connection is closed.
%socko	A variable or an expression that is a reference to a `Socket` object.

Usage notes

In addition to closing the socket, the Close method destroys (discards) the object.
Close is not affected by any ONRESET setting. If the socket for which it is invoked is in the RESET state, Close continues to the next statement and does not set the last socket error information.

Example

The Close call signals that the program has completed all processing on the %sok socket:

%sok:Close

Socket class	List of Socket methods	Socket methods syntax
Notation conventions for methods

@@ Line 1: / Line 1: @@
+{{Template:Socket:Close subtitle}}
-<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
-[[Category:Socket methods|Close function]]
-<p>
-<var>Close</var> is a member of the <var>[[Socket class|Socket]]</var> class.
-</p>
 This method terminates the sending and receiving of data on, and removes from use,
@@ Line 10: / Line 5: @@
 The <var>Close</var> method, which may be invoked with a <var>Call</var> statement, has an effect
 similar to its equivalent $function, <var>[[$Sock_Close]]</var>.
 ==Syntax==
-<p class="syntax">[%conn =] %socko:Close
+{{Template:Socket:Close subtitle}}
-</p>
 ===Syntax terms===
 <table class="syntaxTable">
@@ Line 37: / Line 33: @@
 <p class="code">%sok:Close
 </p>
+{{Template:Socket:Close footer}}