renet 0.1.0

data/README

@@ -0,0 +1,81 @@
+=================================================
+ rENet
+ Ruby library for games networking
+-------------------------------------------------
+	     -= Work in Progress =-
+	     No docs or comments right now :|
+	     Just this readme ;x
+=================================================
+
+ Planned:
+ - ENet::Connection (client)
+ - ENet::Server     (server)
+ - Others
+ 
+ More or less finished:
+ - ENet::Connection
+ - ENet::Server
+ 
+-------------------------------------------------
+ Available binaries:
+ - Ruby 1.9 Windows 32bits (Mingw)
+ 
+=================================================
+ Under MIT license
+------------------------------------------------
+ Uses ENet as backend < http://enet.bespin.org/ >
+=================================================
+
+Library overview
+-------------------------------------------------
+module ENet
+	|- ENET_VERSION (string)
+	|- RENET_VERSION (string)
+	|
+	|- Connection (class)
+	|	|- attr_reader
+	|	|	|- online?
+	|	|	|- connected?
+	|	|
+	|	|- attr_accessor
+	|	|	|- total_sent_data
+	|	|	|- total_received_data
+	|	|	|- total_sent_packets
+	|	|	|- total_received_packets
+	|	|
+	|	|- methods
+	|		|- initialize (remote host, remote port, channels to allocate, download bw, upload bw)
+	|		|- connect (timeout in ms)
+	|		|- disconnect (timeout in ms)
+	|		|- send_packet (data to send, reliable or not, channel id)
+	|		|- send_queued_packets (nothing)
+	|		|- flush (nothing)
+	|		|- update (timeout in ms)
+	|		|- use_compression (true or false)
+	|		|- on_connection (method to call)
+	|		|- on_packet_receive (method to call)
+	|		|- on_disconnection (method to call)
+	|
+	|- Server (class)
+		|- attr_reader
+		|	|- max_clients
+		|	|- clients_count
+		|
+		|- attr_accessor
+		|	|- total_sent_data
+		|	|- total_received_data
+		|	|- total_sent_packets
+		|	|- total_received_packets
+		|
+		|- methods
+			|- initialize (local port, n� of allowed clients, channels to allocate, download bw, upload bw)
+			|- disconnect_client (client id)
+			|- send_packet (client id, data to send, reliable or not, channel id)
+			|- broadcast_packet (data to send, reliable or not, channel id)
+			|- send_queued_packets (nothing)
+			|- flush (nothing)
+			|- update (timeout in ms)
+			|- use_compression (true or false)
+			|- on_connection (method to call)
+			|- on_packet_receive (method to call)
+			|- on_disconnection (method to call)

data/examples/Console-Server.rb

@@ -0,0 +1,47 @@
+# require the lib!
+require './../bin/renet'
+
+# define a custom handler for new client connections, it will be automatically called
+def connections_handler(id, ip)
+	# show who connected
+	puts "[ID #{id}] connected from #{ip}"
+	# delete the hash entry if it already exists
+	@clients.delete_if {|key, value| key == id }
+	# add the new entry to the clients hash
+	@clients[id] = { :ip => ip }
+	#show how many clients we have
+	puts "Clients connected: #{@server.clients_count} of #{@server.max_clients}"
+end
+
+# define a custom handler for incoming data packets, it will be automatically called
+def packets_handler(id, data, channel)
+	# show who sent the packet, the data inside and the channel used
+	puts "packet from [peer #{id}] -> [#{data}] - [#{channel}]" 
+	# answer sending the same data to the client (client ID, data, reliable or not, channel ID)
+	@server.send_packet(id, data, true, channel)
+end
+
+# define a custom handler for client disconnections, it will be automatically called
+def disconnections_handler(id)
+	# show who left
+	puts "#{@clients[id][:ip]} with ID #{id} disconnected"
+	# delete its entry in the clients hash
+	@clients.delete_if {|key, value| key == id }
+	# sends a packet to all clients informing about the disconnection (data, reliable or not, channel ID)
+	@server.broadcast_packet("#{id} disconnected", true, 1)
+end
+# create a hash to store clients information
+@clients = {}
+# create a new server object ( port, clients allowed, number of channels, download bandwidth, upload badnwidth)
+@server = ENet::Server.new(8000, 32, 2, 0, 0)
+
+# Set our handlers to the server
+@server.on_connection(method(:connections_handler))
+@server.on_packet_receive(method(:packets_handler))
+@server.on_disconnection(method(:disconnections_handler))
+
+# loop forever
+loop do
+	# send queued packets and wait for new packets 1000 milliseconds
+	@server.update(1000)
+end

data/examples/Gosu-Client.rb

@@ -0,0 +1,71 @@
+# require gosu and renet libs!
+require 'gosu'
+require './../bin/renet'
+
+# define a new window class
+class GameWindow < Gosu::Window
+	def initialize
+		super(640, 480, false)
+		# set a descriptive caption
+		self.caption = "Gosu & ENet Test"
+		# create a font to draw the information
+		@font = Gosu::Font.new(self, Gosu::default_font_name, 20)
+		# create a new connection object (remote host address, remote host port, channels, download bandwidth, upload bandwidth)
+		@socket = ENet::Connection.new("localhost", 8000, 2, 0, 0)
+		# set the handler for the packets
+		@socket.on_packet_receive(method(:on_packet))
+		# an array to store the incoming packets
+		@packets = []
+	end
+
+	def update
+		# send queued packets and receive incoming ones (0 = non-blocking)
+		@socket.update(0)
+		# show our client FPS
+		self.caption = "Gosu & ENet Test  -  [FPS: #{Gosu::fps.to_s}]"
+	end
+
+	def draw
+		# show if we are connected to the server or not (@socket.connected? is valid too)
+		@font.draw("Connected: #{@socket.online?}", 10, 10, 0, 1.0, 1.0, 0xffffff00)
+		# show the controls
+		@font.draw("Press C to connect   Press P to send a packet", 10, 440, 0, 1.0, 1.0, 0xffffff00)
+		# Show the socket information
+		@font.draw("Packets Sent: #{@socket.total_sent_packets}", 450, 380, 0, 1.0, 1.0, 0xffffff00)
+		@font.draw("Packets Recv: #{@socket.total_received_packets}", 450, 400, 0, 1.0, 1.0, 0xffffff00)
+		@font.draw("Bytes Sent: #{@socket.total_sent_data}", 450, 420, 0, 1.0, 1.0, 0xffffff00)
+		@font.draw("Bytes Recv: #{@socket.total_received_data}", 450, 440, 0, 1.0, 1.0, 0xffffff00)
+		
+		# show the storaged packets
+		if !@packets.empty?
+			@packets.each_index do |i|
+				@font.draw("[PACKET] From channel #{@packets[i][1]}, containing \"#{@packets[i][0]}\"", 10, 30*(i+1), 0, 1.0, 1.0, @packets[i][2])
+			end
+		end
+	end
+  
+	def button_down(id)
+		case id
+			# connect to the server if we press C
+			when Gosu::KbC
+				# only connects if we are not already connected
+				@socket.connect(2000) 
+			# send a packet if we press P
+			when Gosu::KbP
+				# send a packet to the server (data, reliable or not, channel ID)
+				@socket.send_packet("test packet", true, 0)
+		end
+	end
+	
+	# define a custom handler to manage the packets
+	def on_packet(data, channel)
+		# delete the old packets if we get more than 10
+		@packets.slice!(0) if @packets.size >= 11
+		#storage the packet data, channel and a representative color
+		@packets << [data, channel, Gosu::Color.argb(255, rand(100)+155, rand(100)+155, rand(100)+155)]
+	end
+end
+
+# show the window
+window = GameWindow.new
+window.show

data/ext/renet/enet/callbacks.c

@@ -0,0 +1,47 @@
+/** 
+ @file callbacks.c
+ @brief ENet callback functions
+*/
+#define ENET_BUILDING_LIB 1
+#include "enet/enet.h"
+
+static ENetCallbacks callbacks = { malloc, free, abort };
+
+int
+enet_initialize_with_callbacks (ENetVersion version, const ENetCallbacks * inits)
+{
+   if (version < ENET_VERSION_CREATE (1, 3, 0))
+     return -1;
+
+   if (inits -> malloc != NULL || inits -> free != NULL)
+   {
+      if (inits -> malloc == NULL || inits -> free == NULL)
+        return -1;
+
+      callbacks.malloc = inits -> malloc;
+      callbacks.free = inits -> free;
+   }
+      
+   if (inits -> no_memory != NULL)
+     callbacks.no_memory = inits -> no_memory;
+
+   return enet_initialize ();
+}
+           
+void *
+enet_malloc (size_t size)
+{
+   void * memory = callbacks.malloc (size);
+
+   if (memory == NULL)
+     callbacks.no_memory ();
+
+   return memory;
+}
+
+void
+enet_free (void * memory)
+{
+   callbacks.free (memory);
+}
+

data/ext/renet/enet/callbacks.h

@@ -0,0 +1,27 @@
+/** 
+ @file  callbacks.h
+ @brief ENet callbacks
+*/
+#ifndef __ENET_CALLBACKS_H__
+#define __ENET_CALLBACKS_H__
+
+#include <stdlib.h>
+
+typedef struct _ENetCallbacks
+{
+    void * (ENET_CALLBACK * malloc) (size_t size);
+    void (ENET_CALLBACK * free) (void * memory);
+    void (ENET_CALLBACK * no_memory) (void);
+} ENetCallbacks;
+
+/** @defgroup callbacks ENet internal callbacks
+    @{
+    @ingroup private
+*/
+extern void * enet_malloc (size_t);
+extern void   enet_free (void *);
+
+/** @} */
+
+#endif /* __ENET_CALLBACKS_H__ */
+