Changeset 711

Timestamp:

11/04/07 18:09:10 (13 months ago)

Author:

michiel

Message:

add documentation to the socket handling so I can remember when/why/how it's done

Files:

• tools/nsa/nsa.py (modified) (2 diffs)

tools/nsa/nsa.py

@@ -149 +149 @@
                 PORT = 8764               # Arbitrary non-privileged port
                 if sock == None:
+                        # no socket yet, so lets create one
                         self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
                 else:
                         self.sock = sock
 
+                # Allow reuse of address
                 self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+                # Bind to specified host+port
                 self.sock.bind((HOST, PORT))
+                # listen with backlog of 1
                 self.sock.listen(1)
         
@@ -161 +165 @@
                 done = False
                 if self.sock:
+                        # test for something on the port.
+                        # the timeout can be set to something, this is just a non-blocking socket now
                         (r, w, e) = select.select([self.sock], [], [], 0)
                         if r:
+                                # we have data so let's accept it
                                 (client, addr) = self.sock.accept()
                                 while not done:
                                         data = None
                                         try:
+                                                # Here, we wait until the client starts sending data.
+                                                # if we don't wait (in a blocking fashion) here, we'll
+                                                # get NOTREADY errors (we take care of those below with
+                                                # the if e.args[0] == 11 just in case).
                                                 data = client.recv(1024)
                                         except socket.error, e:
+                                                # Socket not ready yet (err 11). Just try again.
                                                 if e.args[0] == 11:
                                                         pass
                                                 else:
                                                         raise e
+                                        # We recieved data? (no exception on recv?)
                                         if data:
+                                                # Append
                                                 alldata += data
+                                                # We recieve 1024 max on the socket each recv, so
+                                                # if the len of data is less than 1024, there could
+                                                # possibly be more left. If not, we're done reading.
                                                 if len(data) < 1024:
                                                         done = True
+                                # Close the connection so the client can terminate
                                 client.close()
+                                # Send the data to the channel
                                 bot.say_it(alldata)