add comments

brianc · brianc · commit ce72df3d0b08 · 2013-04-17T20:59:28.000-05:00
diff --git a/lib/connection.js b/lib/connection.js
@@ -83,8 +83,10 @@ Connection.prototype.connect = function(port, host) {
   }
 };
 
+//attach read listeners for incoming packet parsing
 Connection.prototype.attachListeners = function(stream) {
   var self = this;
+  //wrap stream for older node version
   var reader = new Readable();
   reader = reader.wrap(stream);
   reader.on('readable', function() {
@@ -296,20 +298,6 @@ Connection.prototype.sendCopyFail = function (msg) {
   this._send(0x66);
 };
 
-//parsing methods
-Connection.prototype.setBuffer = function(buffer) {
-  if(this.lastBuffer) {    //we have unfinished biznaz
-    //need to combine last two buffers
-    var remaining = this.lastBuffer.length - this.lastOffset;
-    var combinedBuffer = new Buffer(buffer.length + remaining);
-    this.lastBuffer.copy(combinedBuffer, 0, this.lastOffset);
-    buffer.copy(combinedBuffer, remaining, 0);
-    buffer = combinedBuffer;
-  }
-  this.buffer = buffer;
-  this.offset = 0;
-};
-
 Connection.prototype.readSslResponse = function() {
   var remaining = this.buffer.length - (this.offset);
   if(remaining < 1) {
@@ -324,11 +312,11 @@ Connection.prototype.readSslResponse = function() {
 };
 
 Connection.prototype.parseMessage =  function(reader) {
-  //I want to get rid of this bit here...
   if(!this.header) {
     //try to read the 5 byte header
     this.header = reader.read(5);
     if(!this.header) {
+      //try again once the stream becomes readable
       return false;
     }
   }
@@ -338,17 +326,25 @@ Connection.prototype.parseMessage =  function(reader) {
   //read message length
   var length = this.header.readInt32BE(1, true);
 
+  //packet length includes the 4 bytes of the length 32 bit int
   var bodyLength = length - 4;
+
   //some packets have an empty body
   if(bodyLength) {
+    //try to read the entire body packet
     var body = reader.read(bodyLength);
+    //could not read
+    //try again when more data comes in
     if(!body) {
       return false;
     }
-    //blow away header
+    //set buffer for further packet-specific parsing
     this.buffer = body;
+    //reset parse offset to 0 for this packet
     this.offset = 0;
   }
+  //if we have a full body packet
+  //we can remove the saved header
   this.header = false;
 
   var msg = {
