Core Function SSDrop

From Sputnik Wiki
(Difference between revisions)
Jump to: navigation, search
m (1 revision)
 
Line 1: Line 1:
 
<pre>
 
<pre>
SDrop( <server>, <client socket> )
+
SDrop( <client socket> )
 
</pre>
 
</pre>
  
Line 8: Line 8:
  
 
=== Parameters ===
 
=== Parameters ===
 
==== <server> ====
 
 
The server object to use.
 
  
 
==== <client socket> ====
 
==== <client socket> ====
Line 19: Line 15:
 
=== Return Value ===
 
=== Return Value ===
  
Success: Returns 1.  
+
Success: Returns true.  
  
Failure: Returns 0.  
+
Failure: Returns false.  
  
 
=== Remarks ===
 
=== Remarks ===

Latest revision as of 06:23, 15 June 2015

SDrop( <client socket> )

Contents

Description

Kick a client off the server.

Parameters

<client socket>

The client to kick.

Return Value

Success: Returns true.

Failure: Returns false.

Remarks

This is NOT a generic socket toolset; You can't use this to connect to anything instead it is used to connect Sputnik clients with Sputnik servers in a very easy to use way.

Example

See the Listen() and Connect() for examples

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox