InSim examples - Revision history

Flame CZE at 00:59, 2 December 2023

2023-12-02T00:59:46Z

Dygear: Changed to meet with defacto standard as set on page.

2009-07-17T09:35:43Z

Changed to meet with defacto standard as set on page.

Dygear: Changed to meet with defacto standard as set on page.

2009-07-17T09:35:06Z

Changed to meet with defacto standard as set on page.

Dygear: PHP example added to page.

2009-07-17T09:34:10Z

PHP example added to page.

DarkTimes: Added C# example.

2009-06-27T16:21:21Z

Added C# example.

DarkTimes at 15:57, 27 June 2009

2009-06-27T15:57:46Z

DarkTimes: Improved example

2009-06-27T15:57:07Z

Improved example

xergio: /* Example #1 */

2009-06-22T13:52:00Z

Example #1

xergio at 11:37, 22 June 2009

2009-06-22T11:37:53Z

xergio at 10:27, 22 June 2009

2009-06-22T10:27:35Z

←Older revision		Revision as of 00:59, 2 December 2023
Line 254:		Line 254:
	}		}
	?></pre></big>		?></pre></big>
		+
		+	[[Category:InSim]]

@@ Line 201: / Line 201: @@
 = PHP =
-== Example 1 ==
+== Example #1 ==
 <big><pre><?php
 $InSim = new InSim();

@@ Line 75: / Line 75: @@
 = Visual C# =
-== Example 1 ==
+== Example #1 ==
 How to connect, send a packet and receive the response.

←Older revision		Revision as of 09:34, 17 July 2009
Line 199:		Line 199:

	</pre></big>		</pre></big>
		+
		+	= PHP =
		+	== Example 1 ==
		+	<big><pre><?php
		+	$InSim = new InSim();
		+	class InSim {
		+	function __construct($AdminPass = '', $Address = '127.0.0.1', $Port = 29999, $PreFixChar = '!') {
		+	// Socket In;
		+	if ($this->skIn = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) {
		+	echo('Listen socket created!' . PHP_EOL);
		+	if (socket_bind($this->skIn, $Address, $Port + 1))
		+	echo('Binded to listen socket!' . PHP_EOL);
		+	else
		+	die('Could not bind to listen socket, address or port!' . PHP_EOL);
		+	} else
		+	die('Could not create listen socket!' . PHP_EOL);
		+
		+	// Socket Out;
		+	if ($this->skOt = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) {
		+	echo('Send socket created!' . PHP_EOL);
		+	if (socket_connect($this->skOt, $Address, $Port))
		+	echo('Conneceted to send socket!' . PHP_EOL);
		+	else
		+	die('Could not connect to send socket, address or port!' . PHP_EOL);
		+	} else
		+	die('Could not create send socket!');
		+
		+	# Connect To InSim;
		+	$this->send(pack('CCCxSSxCSa16a16', 44, 1, 1, $Port + 1, 4 \| 8, 36, 0, $AdminPass, 'phpInSim'));
		+	$this->main();
		+	}
		+	function send($packet) {
		+	return socket_write($this->skOt, $packet, strlen($packet));
		+	}
		+	function main() {
		+	while (TRUE) {
		+	# Keep Alive;
		+	if (time() > $this->time) {
		+	$this->send(pack('CCCC', 4, 3, 0, 0));
		+	$this->time = time() + 30;
		+	}
		+	# Get Packet;
		+	if ($data = $this->recv()) {
		+	print_r($data);
		+	}
		+	}
		+	}
		+	function recv() {
		+	return socket_read($this->skIn, 256, PHP_BINARY_READ);
		+	}
		+	function __destruct() {
		+	$this->send(pack('CCCC', 4, 3, 0, 2));
		+	}
		+	}
		+	?></pre></big>

@@ Line 66: / Line 66: @@
                  size, type, reqi, _, version, product, insimver = struct.unpack('BBBB8s6sH')
                  if insimver != INSIM_VERSION:
-                     print 'Invalid InSim version'
+                     break # Invalid version, break loop.
      else:
-         # InSim connection has been lost.
+         break # Connection has closed.
 # Release the socket.
 sock.close()</pre></big>

@@ Line 52: / Line 52: @@
          while len(buffer) > 0 and len(buffer) >= ord(buffer[0]):
-             # Copy the packet from the buffer and delete it.
+             # Copy the packet from the buffer.
              packet = buffer[:ord(buffer[0])]
              buffer = buffer[ord(buffer[0]):]
@@ Line 61: / Line 61: @@
                  size, type, reqi, subt = struct.unpack('BBBB', packet)
                  if subt == TINY_NONE:
-                     sock.send(packet)
+                     sock.send(packet) # Respond to keep-alive.
              elif ord(buffer[1]) == ISP_VER:
                  # Unpack the VER packet and check the InSim version.

@@ Line 5: / Line 5: @@
 How to connect, send a packet and receive the response.
-<big><pre># Import Python's socket module.
+<big><pre># Dependencies.
 import socket
-# Import Python's struct module, which allows us to pack and unpack strings.
+# Some constants.
-import struct
+INSIM_VERSION = 4
-# Initialise the socket in TCP mode.
+# Initailise the socket in TCP mode.
 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
@@ Line 17: / Line 25: @@
 sock.connect(('localhost', 29999))
-# Pack the IS_ISI data into a string.
+# Pack the ISI packet into a string.
-isi = struct.pack('BBBBHHBcH16s16s',
+isi = struct.pack('BBBBHHBBH16s16s',
-,           # Size
+,          # Size
-,            # Type
+                   ISP_ISI,     # Type
-,            # ReqI
+,           # ReqI - causes LFS to send an IS_VER.
-,            # Zero
+,           # Zero
-,            # UDPPort
+,           # UDPPort
-,            # Flags
+,           # Flags
-,            # Sp0
+,           # Sp0
-                   ' ',          # Prefix
+,           # Prefix
-,            # Interval
+,           # Interval
-                   'password',   # Admin
+                   'password',  # Admin
-                   'MyProgram',) # IName
+                   '^3example') # IName
-−
-# Send the string to InSim
+# Send the ISI packet to InSim.
 sock.send(isi)
 buffer = ''
 while True:
-    # Receive up to 1024 bytes of data.
+     data = sock.recv(BUFFER_SIZE)
      if data:
          buffer += data
-−
-         # Loop through each completed packet in the buffer. The first byte of
+         # Loop through completed packets.
          while len(buffer) > 0 and len(buffer) >= ord(buffer[0]):
              # Copy the packet from the buffer.
              packet = buffer[:ord(buffer[0])]
              buffer = buffer[ord(buffer[0]):]
-−
-             # check keep alive!
+            # Check packet type.
-            keepAlive(packet)
+             if ord(buffer[1]) == ISP_TINY:
+                # Unpack the TINY packet and check it for keep-alive signal.
-            # The packet is now complete! :)
+                size, type, reqi, subt = struct.unpack('BBBB', packet)
-             # doSomethingWithPacket(packet)
+                if subt == TINY_NONE:
      else:
          break
-−
 # Release the socket.
 sock.close()</pre></big>

←Older revision		Revision as of 11:37, 22 June 2009
Line 62:		Line 62:

	sock.close()</pre></big>		sock.close()</pre></big>
−
−
−	~~== Example #2 ==~~