Document the ability to listen for packets

docs/connecting.rst

@@ -1,14 +1,14 @@
 Connecting to Servers
 ======================
 
-.. currentmodule:: network.connection
+.. module:: network.connection
 
 Your primary dealings when connecting to a server will deal with the Connection class
 
-.. automodule:: network.connection
+.. autoclass:: network.connection.Connection
 	:members:
 
-Dealing wih packets
+Writing Packets
 ~~~~~~~~~~~~~~~~~~~~
 
 The packet class uses a lot of magic to work, here is how to use them.
@@ -17,6 +17,7 @@ Look up the particular packet you need to deal with, for my example let's go wit
 .. autoclass:: network.packets.KeepAlivePacket
 	:undoc-members: 
 	:inherited-members:
+	:exclude-members: read, write
 
 Pay close attention to the definition attribute, we're gonna be using that to assign values within the packet::
 
@@ -25,3 +26,29 @@ Pay close attention to the definition attribute, we're gonna be using that to as
 	connection.write_packet(packet)
 
 and just like that, the packet will be written out to the server
+
+Listening for Certain Packets
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Let's look at how to listen for certain packets, the relevant method being
+
+.. automethod:: network.connection.Connection.register_packet_listener
+
+An example of this can be found in the ``start.py`` headless client, it is recreated here::
+
+    connection = Connection(address, port, login_response)
+    connection.connect()
+
+    def print_chat(chat_packet):
+        print "Position: " + str(chat_packet.position)
+        print "Data: " + chat_packet.json_data
+
+    from network.packets import ChatMessagePacket
+    connection.register_packet_listener(print_chat, ChatMessagePacket)
+
+The field names ``position`` and ``json_data`` are inferred by again looking at the definition attribute as before
+
+.. autoclass:: network.packets.ChatMessagePacket
+	:undoc-members: 
+	:inherited-members:
+	:exclude-members: read, write

network/connection.py

@@ -96,7 +96,6 @@ class Connection(object):
             return False
         else:
             packet = self._outgoing_packet_queue.popleft()
-            print "Writing out: " + hex(packet.id) + " / " + packet.packet_name
             if self.options.compression_enabled:
                 packet.write(self.socket, self.options.compression_threshold)
             else: