Initial commit

examples/example.sp

@@ -0,0 +1,54 @@
+// example for the socket extension
+
+#include <sourcemod>
+#include <socket>
+
+public Plugin:myinfo = {
+	name = "socket example",
+	author = "Player",
+	description = "This example demonstrates downloading a http file with the socket extension",
+	version = "1.1.0",
+	url = "http://www.player.to/"
+};
+ 
+public OnPluginStart() {
+	// create a new tcp socket
+	new Handle:socket = SocketCreate(SOCKET_TCP, OnSocketError);
+	// open a file handle for writing the result
+	new Handle:hFile = OpenFile("dl.htm", "wb");
+	// pass the file handle to the callbacks
+	SocketSetArg(socket, hFile);
+	// connect the socket
+	SocketConnect(socket, OnSocketConnected, OnSocketReceive, OnSocketDisconnected, "www.sourcemod.net", 80)
+}
+
+public OnSocketConnected(Handle:socket, any:arg) {
+	// socket is connected, send the http request
+
+	decl String:requestStr[100];
+	Format(requestStr, sizeof(requestStr), "GET /%s HTTP/1.0\r\nHost: %s\r\nConnection: close\r\n\r\n", "index.php", "www.sourcemod.net");
+	SocketSend(socket, requestStr);
+}
+
+public OnSocketReceive(Handle:socket, String:receiveData[], const dataSize, any:hFile) {
+	// receive another chunk and write it to <modfolder>/dl.htm
+	// we could strip the http response header here, but for example's sake we'll leave it in
+
+	WriteFileString(hFile, receiveData, false);
+}
+
+public OnSocketDisconnected(Handle:socket, any:hFile) {
+	// Connection: close advises the webserver to close the connection when the transfer is finished
+	// we're done here
+
+	CloseHandle(hFile);
+	CloseHandle(socket);
+}
+
+public OnSocketError(Handle:socket, const errorType, const errorNum, any:hFile) {
+	// a socket error occured
+
+	LogError("socket error %d (errno %d)", errorType, errorNum);
+	CloseHandle(hFile);
+	CloseHandle(socket);
+}

examples/listenexample.sp

@@ -0,0 +1,64 @@
+// listening socket example for the socket extension
+
+#include <sourcemod>
+#include <socket>
+
+public Plugin:myinfo = {
+	name = "listen socket example",
+	author = "Player",
+	description = "This example provides a simple echo server",
+	version = "1.0.1",
+	url = "http://www.player.to/"
+};
+ 
+public OnPluginStart() {
+	// enable socket debugging (only for testing purposes!)
+	SocketSetOption(INVALID_HANDLE, DebugMode, 1);
+
+
+	// create a new tcp socket
+	new Handle:socket = SocketCreate(SOCKET_TCP, OnSocketError);
+	// bind the socket to all interfaces, port 50000
+	SocketBind(socket, "0.0.0.0", 50000);
+	// let the socket listen for incoming connections
+	SocketListen(socket, OnSocketIncoming);
+}
+
+public OnSocketIncoming(Handle:socket, Handle:newSocket, String:remoteIP[], remotePort, any:arg) {
+	PrintToServer("%s:%d connected", remoteIP, remotePort);
+
+	// setup callbacks required to 'enable' newSocket
+	// newSocket won't process data until these callbacks are set
+	SocketSetReceiveCallback(newSocket, OnChildSocketReceive);
+	SocketSetDisconnectCallback(newSocket, OnChildSocketDisconnected);
+	SocketSetErrorCallback(newSocket, OnChildSocketError);
+
+	SocketSend(newSocket, "send quit to quit\n");
+}
+
+public OnSocketError(Handle:socket, const errorType, const errorNum, any:ary) {
+	// a socket error occured
+
+	LogError("socket error %d (errno %d)", errorType, errorNum);
+	CloseHandle(socket);
+}
+
+public OnChildSocketReceive(Handle:socket, String:receiveData[], const dataSize, any:hFile) {
+	// send (echo) the received data back
+	SocketSend(socket, receiveData);
+	// close the connection/socket/handle if it matches quit
+	if (strncmp(receiveData, "quit", 4) == 0) CloseHandle(socket);
+}
+
+public OnChildSocketDisconnected(Handle:socket, any:hFile) {
+	// remote side disconnected
+
+	CloseHandle(socket);
+}
+
+public OnChildSocketError(Handle:socket, const errorType, const errorNum, any:ary) {
+	// a socket error occured
+
+	LogError("child socket error %d (errno %d)", errorType, errorNum);
+	CloseHandle(socket);
+}

examples/selftest.sp

@@ -0,0 +1,309 @@
+/**
+ * Socket extension selftest
+ */
+
+#include <sourcemod>
+#include <socket>
+
+public Plugin:myinfo = {
+	name = "socket extension selftest",
+	author = "Player",
+	description = "basic functionality testing",
+	version = "1.1.0",
+	url = "http://www.player.to/"
+};
+
+new goalsReached;
+new trapsReached;
+
+new test;
+public OnGameFrame() {
+	if (test == 0) {
+		test++;
+
+		SocketSetOption(INVALID_HANDLE, DebugMode, 1);
+
+		selfTest1();
+	}
+}
+
+/**
+ * TEST #1 - binary data over tcp
+ *
+ * stuff tested:
+ * - create, close
+ * - connect
+ * - send, receive
+ * - listen
+ * - sendQueueEmpty
+ * - setoption reuseaddr
+ * - data containing x00
+ *
+ * This test is using three sockets:
+ * - Listening socket on port 12345
+ * - A socket which tries to connect to the listening socket and receives data
+ * - the child socket which sends the data
+ */
+selfTest1() {
+	goalsReached = 0;
+	trapsReached = 0;
+	CreateTimer(3.0, selfTest1Terminate);
+	PrintToServer("* |socket selftest| test #1 running");
+
+	new Handle:socket = SocketCreate(SOCKET_TCP, OnSocketErrorTrap);
+
+	SocketSetOption(socket, SocketReuseAddr, 1);
+
+	SocketBind(socket, "0.0.0.0", 12345);
+	SocketListen(socket, Test1_OnListenSocketIncoming);
+
+	new Handle:socket2 = SocketCreate(SOCKET_TCP, OnSocketErrorTrap);
+	SocketConnect(socket2, OnSocketConnectGoal, Test1_OnReceiveSocketReceive, Test1_OnReceiveSocketDisconnect, "127.0.0.1", 12345);
+}
+
+public Action:selfTest1Terminate(Handle:timer) {
+	if (goalsReached == 6 && trapsReached == 0) {
+		PrintToServer("* |socket selftest| ** test #1 passed **");
+		selfTest2();
+	} else {
+		PrintToServer("* |socket selftest| ** test #1 failed **");
+	}
+
+	return Plugin_Stop;
+}
+
+/**
+ * TEST #2 - reuse listening address from test #1
+ *
+ * stuff tested:
+ * - create, close
+ * - listen
+ * - setoption reuseaddr
+ *
+ * This test is using one socket:
+ * - Listening socket on port 12345
+ */
+selfTest2() {
+	goalsReached = 0;
+	trapsReached = 0;
+	CreateTimer(4.0, selfTest2Terminate);
+	PrintToServer("* |socket selftest| test #2 running");
+
+	new Handle:socket = SocketCreate(SOCKET_TCP, OnSocketErrorTrap);
+
+	SocketSetOption(socket, SocketReuseAddr, 1);
+
+	SocketBind(socket, "0.0.0.0", 12345);
+	SocketListen(socket, OnSocketIncomingTrap);
+
+	CloseHandle(socket);
+
+	goalsReached++;
+}
+
+public Action:selfTest2Terminate(Handle:timer) {
+	if (goalsReached == 1 && trapsReached == 0) {
+		PrintToServer("* |socket selftest| ** test #2 passed **");
+		selfTest3();
+	} else {
+		PrintToServer("* |socket selftest| ** test #2 failed **");
+	}
+
+	return Plugin_Stop;
+}
+
+selfTest3() {
+	goalsReached = 0;
+	trapsReached = 0;
+	CreateTimer(1.0, selfTest3Terminate);
+	PrintToServer("* |socket selftest| test #3 running");
+
+	decl Handle:socket[20];
+	
+	for (new count=1; count <= 20; count++) {
+		for (new i=0; i<count; i++) {
+			socket[i] = SocketCreate(SOCKET_TCP, OnSocketErrorTrap);
+		}
+
+		for (new i=0; i<count; i++) {
+			CloseHandle(socket[i]);
+		}
+	}
+
+	goalsReached++;
+}
+
+public Action:selfTest3Terminate(Handle:timer) {
+	if (goalsReached == 1 && trapsReached == 0) {
+		PrintToServer("* |socket selftest| ** test #3 passed **");
+		selfTest4();
+	} else {
+		PrintToServer("* |socket selftest| ** test #3 failed **");
+	}
+
+	return Plugin_Stop;
+}
+
+/**
+ * TEST #4 - connect, closehandle
+ *
+ * stuff tested:
+ * - create, close
+ * - connect
+ * - listen
+ */
+selfTest4() {
+	goalsReached = 0;
+	trapsReached = 0;
+	CreateTimer(5.0, selfTest4Terminate);
+	PrintToServer("* |socket selftest| test #4 running");
+
+	new Handle:listenSocket = SocketCreate(SOCKET_TCP, OnSocketErrorTrap);
+
+	SocketSetOption(listenSocket, SocketReuseAddr, 1);
+
+	SocketBind(listenSocket, "0.0.0.0", 12345);
+	SocketListen(listenSocket, Test3_OnListenSocketIncoming);
+
+	decl Handle:socket[8];
+	
+	for (new count=1; count <= 8; count++) {
+		for (new i=0; i<count; i++) {
+			socket[i] = SocketCreate(SOCKET_TCP, OnSocketErrorTrap);
+		}
+
+		for (new i=0; i<count; i++) {
+			SocketConnect(socket[i], OnSocketConnectGoal, OnSocketReceiveTrap, OnSocketDisconnectGoal, "127.0.0.1", 12345);
+		}
+	}
+
+	CloseHandle(listenSocket);
+
+	goalsReached++;
+}
+
+public Action:selfTest4Terminate(Handle:timer) {
+	if (goalsReached == 109 && trapsReached == 0) {
+		PrintToServer("* |socket selftest| ** test #4 passed **");
+		selfTest5();
+	} else {
+		PrintToServer("* |socket selftest| ** test #4 failed ** (%d goals of 109)", goalsReached);
+	}
+
+	return Plugin_Stop;
+}
+
+selfTest5() {
+}
+
+// ------------------------------------- TEST 1 callbacks -------------------------------------
+
+public Test1_OnListenSocketIncoming(Handle:socket, Handle:newSocket, String:remoteIP[], remotePort, any:arg) {
+	SocketSetReceiveCallback(newSocket, OnSocketReceiveTrap);
+	SocketSetDisconnectCallback(newSocket, OnSocketDisconnectTrap);
+	SocketSetErrorCallback(newSocket, OnSocketErrorTrap);
+
+	SocketSend(newSocket, "\x00abc\x00def\x01\x02\x03\x04", 12);
+	SocketSetSendqueueEmptyCallback(newSocket, Test1_OnChildSocketSQEmpty);
+
+	PrintToServer("* |socket selftest| goal Test1_OnListenSocketIncoming reached");
+	goalsReached++;
+
+	// close listening socket
+	CloseHandle(socket);
+
+	PrintToServer("* |socket selftest| goal Test1_OnListenSocketIncoming - CloseHandle reached");
+	goalsReached++;
+}
+
+public Test1_OnChildSocketSQEmpty(Handle:socket, any:arg) {
+	CloseHandle(socket);
+	PrintToServer("* |socket selftest| goal Test1_OnChildSocketSQEmpty reached");
+	goalsReached++;
+}
+
+new String:recvBuffer[128];
+new recvBufferPos = 0;
+
+public Test1_OnReceiveSocketReceive(Handle:socket, String:receiveData[], const dataSize, any:arg) {
+	PrintToServer("received %d bytes", dataSize);
+
+	if (recvBufferPos < 512) {
+		for (new i=0; i<dataSize && recvBufferPos<sizeof(recvBuffer); i++, recvBufferPos++) {
+			recvBuffer[recvBufferPos] = receiveData[i];
+		}
+	}
+}
+
+public Test1_OnReceiveSocketDisconnect(Handle:socket, any:arg) {
+	PrintToServer("* |socket selftest| goal Test1_OnReceiveSocketDisconnect reached");
+	goalsReached++;
+
+	new String:cmp[] = "\x00abc\x00def\x01\x02\x03\x04";
+	new i;
+	for (i=0; i<recvBufferPos && i<12; i++) {
+		if (recvBuffer[i] != cmp[i]) {
+			PrintToServer("comparison failed");
+			break;
+		}
+	}
+
+	CloseHandle(socket);
+
+	if (i == 12) {
+		PrintToServer("* |socket selftest| goal Test1_OnReceiveSocketDisconnect - i=12 reached");
+		goalsReached++;
+	} else {
+		PrintToServer("* |socket selftest| trap Test1_OnReceiveSocketDisconnect - i=%d!=12 triggered", i);
+		trapsReached++;
+	}
+}
+
+// ------------------------------------- TEST 3 callbacks -------------------------------------
+
+public Test3_OnListenSocketIncoming(Handle:socket, Handle:newSocket, String:remoteIP[], remotePort, any:arg) {
+	CloseHandle(newSocket);
+	goalsReached++;
+}
+
+// ------------------------------------- common callbacks -------------------------------------
+
+public OnSocketConnectGoal(Handle:socket, any:arg) {
+	goalsReached++;
+}
+public OnSocketReceiveGoal(Handle:socket, String:receiveData[], const dataSize, any:arg) {
+	goalsReached++;
+}
+public OnSocketDisconnectGoal(Handle:socket, any:arg) {
+	goalsReached++;
+}
+public OnSocketErrorGoal(Handle:socket, const errorType, const errorNum, any:arg) {
+	goalsReached++;
+}
+public OnSocketIncomingGoal(Handle:socket, Handle:newSocket, String:remoteIP[], remotePort, any:arg) {
+	goalsReached++;
+}
+
+public OnSocketConnectTrap(Handle:socket, any:arg) {
+	PrintToServer("* |socket selftest| trap OnSocketConnectTrap triggered");
+	trapsReached++;
+}
+public OnSocketReceiveTrap(Handle:socket, String:receiveData[], const dataSize, any:arg) {
+	PrintToServer("* |socket selftest| trap OnSocketReceiveTrap triggered (%d bytes received)", dataSize);
+	trapsReached++;
+}
+public OnSocketDisconnectTrap(Handle:socket, any:arg) {
+	PrintToServer("* |socket selftest| trap OnSocketDisconnectTrap triggered");
+	trapsReached++;
+}
+public OnSocketErrorTrap(Handle:socket, const errorType, const errorNum, any:arg) {
+	PrintToServer("* |socket selftest| trap OnSocketErrorTrap triggered (error %d, errno %d)", errorType, errorNum);
+	trapsReached++;
+}
+public OnSocketIncomingTrap(Handle:socket, Handle:newSocket, String:remoteIP[], remotePort, any:arg) {
+	PrintToServer("* |socket selftest| trap OnSocketIncomingTrap triggered");
+	trapsReached++;
+}
+
+// EOF
+

examples/sendto_test.sp

@@ -0,0 +1,116 @@
+/**
+ * Socket extension sendto selftest
+ */
+
+#include <sourcemod>
+#include <socket>
+
+public Plugin:myinfo = {
+	name = "socket extension sendto selftest",
+	author = "Player",
+	description = "basic functionality testing",
+	version = "1.0.0",
+	url = "http://www.player.to/"
+};
+ 
+public OnPluginStart() {
+	SocketSetOption(INVALID_HANDLE, DebugMode, 1);
+	
+	new port = 12346;
+
+	new Handle:socket = SocketCreate(SOCKET_UDP, OnLSocketError);
+
+	SocketBind(socket, "0.0.0.0", port);
+	SocketListen(socket, OnLSocketIncoming);
+
+	new Handle:socket2 = SocketCreate(SOCKET_UDP, OnCSocketError);
+	//SocketConnect(socket2, OnCSocketConnect, OnCSocketReceive, OnCSocketDisconnect, "127.0.0.1", port);
+}
+
+public OnLSocketIncoming(Handle:socket, Handle:newSocket, String:remoteIP[], remotePort, any:arg) {
+	PrintToServer("%s:%d connected", remoteIP, remotePort);
+
+	SocketSetReceiveCallback(newSocket, OnChildSocketReceive);
+	SocketSetDisconnectCallback(newSocket, OnChildSocketDisconnect);
+	SocketSetErrorCallback(newSocket, OnChildSocketError);
+
+	SocketSend(newSocket, "\x00abc\x00def\x01\x02\x03\x04", 12);
+	SocketSetSendqueueEmptyCallback(newSocket, OnChildSocketSQEmpty);
+}
+
+public OnLSocketError(Handle:socket, const errorType, const errorNum, any:arg) {
+	LogError("listen socket error %d (errno %d)", errorType, errorNum);
+	CloseHandle(socket);
+}
+
+public OnChildSocketReceive(Handle:socket, String:receiveData[], const dataSize, any:arg) {
+	// send (echo) the received data back
+	//SocketSend(socket, receiveData);
+	// close the connection/socket/handle if it matches quit
+	//if (strncmp(receiveData, "quit", 4) == 0) CloseHandle(socket);
+}
+
+public OnChildSocketSQEmpty(Handle:socket, any:arg) {
+	PrintToServer("sq empty");
+	CloseHandle(socket);
+}
+
+public OnChildSocketDisconnect(Handle:socket, any:arg) {
+	// remote side disconnected
+	PrintToServer("disc");
+	CloseHandle(socket);
+}
+
+public OnChildSocketError(Handle:socket, const errorType, const errorNum, any:arg) {
+	// a socket error occured
+
+	LogError("child socket error %d (errno %d)", errorType, errorNum);
+	CloseHandle(socket);
+}
+
+public OnCSocketConnect(Handle:socket, any:arg) {
+	// send (echo) the received data back
+	//SocketSend(socket, receiveData);
+	// close the connection/socket/handle if it matches quit
+	//if (strncmp(receiveData, "quit", 4) == 0) CloseHandle(socket);
+}
+
+new String:recvBuffer[128];
+new recvBufferPos = 0;
+
+public OnCSocketReceive(Handle:socket, String:receiveData[], const dataSize, any:arg) {
+	PrintToServer("received %d bytes", dataSize);
+
+	if (recvBufferPos < 512) {
+		for (new i=0; i<dataSize && recvBufferPos<sizeof(recvBuffer); i++, recvBufferPos++) {
+			recvBuffer[recvBufferPos] = receiveData[i];
+		}
+	}
+	// send (echo) the received data back
+	//SocketSend(socket, receiveData);
+	// close the connection/socket/handle if it matches quit
+	//if (strncmp(receiveData, "quit", 4) == 0) CloseHandle(socket);
+}
+
+public OnCSocketDisconnect(Handle:socket, any:arg) {
+	new String:cmp[] = "\x00abc\x00def\x01\x02\x03\x04";
+	new i;
+	for (i=0; i<recvBufferPos && i<12; i++) {
+		if (recvBuffer[i] != cmp[i]) {
+			PrintToServer("comparison failed");
+			break;
+		}
+	}
+
+	PrintToServer("comparison finished at pos %d/%d", i, recvBufferPos);
+
+	CloseHandle(socket);
+}
+
+public OnCSocketError(Handle:socket, const errorType, const errorNum, any:arg) {
+	// a socket error occured
+
+	LogError("connect socket error %d (errno %d)", errorType, errorNum);
+	CloseHandle(socket);
+}
+

examples/sockettest.sp

@@ -0,0 +1,68 @@
+// http://forums.alliedmods.net/showpost.php?p=717597&postcount=67
+
+#pragma semicolon 1
+#include <sourcemod>
+#include <socket>
+
+#define PLUGIN_VERSION "1.0.0"
+
+public Plugin:myinfo = 
+{
+    name = "Socket Test",
+    author = "Unknown",
+    description = "Test",
+    version = "1.0",
+    url = ""
+}
+
+public OnPluginStart()
+{
+	SocketSetOption(INVALID_HANDLE,DebugMode,1);
+    RegAdminCmd("sm_socket_test", CommandTest, ADMFLAG_CONVARS, "test");
+}
+
+public Action:CommandTest(client, args)
+{
+    // create a new tcp socket
+    new Handle:socket = SocketCreate(SOCKET_TCP, OnSocketError);
+    // open a file handle for writing the result
+    //new Handle:hFile = OpenFile("dl.htm", "wb");
+    // pass the file handle to the callbacks
+    //SocketSetArg(socket, hFile);
+    // connect the socket
+    SocketConnect(socket, OnSocketConnected, OnSocketReceive, OnSocketDisconnected, "www.sourcemod.net", 80);
+
+    return Plugin_Handled;
+}
+
+public OnSocketConnected(Handle:socket, any:hFile) {
+    // socket is connected, send the http request
+
+    decl String:requestStr[100];
+    Format(requestStr, sizeof(requestStr), "GET /%s HTTP/1.0\r\nHost: %s\r\nConnection: close\r\n\r\n", "index.php", "www.sourcemod.net");
+    SocketSend(socket, requestStr);
+}
+
+public OnSocketReceive(Handle:socket, String:receiveData[], const dataSize, any:hFile) {
+    // receive another chunk and write it to <modfolder>/dl.htm
+    // we could strip the http response header here, but for example's sake we'll leave it in
+
+    //WriteFileString(hFile, receiveData, false);
+}
+
+public OnSocketDisconnected(Handle:socket, any:hFile) {
+    // Connection: close advises the webserver to close the connection when the transfer is finished
+    // we're done here
+
+    //CloseHandle(hFile);
+    CloseHandle(socket);
+}
+
+public OnSocketError(Handle:socket, const errorType, const errorNum, any:hFile) {
+    // a socket error occured
+
+    LogError("socket error %d (errno %d)", errorType, errorNum);
+    //CloseHandle(hFile);
+    CloseHandle(socket);
+}
+