From 0ae5b989908e4a28e8178f928f471a3618795547 Mon Sep 17 00:00:00 2001
From: Jonathan Roemer <jon@roemersoftworks.com>
Date: Sun, 8 Feb 2015 16:36:18 -0500
Subject: [PATCH] Added proper documentation and cleaned up the code.

---
 bin/networking/networking.class | Bin 2985 -> 2048 bytes
 src/networking/networking.java  | 198 +++++++++++++++++++-------------
 2 files changed, 116 insertions(+), 82 deletions(-)

diff --git a/bin/networking/networking.class b/bin/networking/networking.class
index c969b8e4426c24af601da5131ff7f6d507a3e3e7..1bcfda2acd1833121b620461f173d2622dd49798 100644
GIT binary patch
delta 953
zcma)(%TE(g6vn@SwnN83ptT5v;P|4nfUOEXTHidhLV2|yRU?k=4UDui&7IrE9r`Dj
z*}2k{ap?vUNi=SC;od*OwF@JjDMo5yBD1)e`<;8f^Sj@DbNFey^6BTh_W(w)_*VHW
zZL~esYkIt-o2&5&&Mn@8sD#NylQY{Y)mTw0SmlaQ(uHA}T7_GWO01mJ6#tlRnwHS2
zHq*qKVQYq|>6$I*T!C6l!JY_3K|cmn^k7IrXkdD8QdV%oTununq(caBR$xYrjWgTe
zte9iviZkaOOvyMcVVBNiBA&Gh>r5y};H>L7BBApij_K%<jC0N_Z&ynK7gStC()s9(
zw~XSF+jZIb?mdzo#Z?v8a9x62Ar4V8C3ps?)pZ|JF^-S~Z=qz_OhTYg<(!$q<zieH
zRZgPMW@eFb=cT99dDa{X-{FQ}JSCwuEA+y8Mz7>_3QESbv*YP<rhSpAwz6d!!s1!R
zYmBGoBm{pexi!YimK&X`9<-Tgh(ba~wNlgt8{5Nhp8H-%erHHddc#oA>#WOt8;GHq
zo)u8G(Vq_tY$5i6c1_S|^+BRFilcP}@M9PusvW1jhiWI#Nq_%$xYFQo3h@R9=c~Wt
zWFkM<(X+gTGns9S=7%<M-m`_&%y4)US6=UYOL|DU;j}B^$P`q}pc}L3LxxP}31tBh
zWa|TB1m)sPIP*#{GKrfss2g6~LYgjln`$bWen6Fx$jO+Z>tqmjzW9503G(|OSXm~I
zd*phb2=3C<2Sl(!1P}irn4#$0FNPoj6qHJ*_ro*mOdL4Yx>omUqJBT->Po3WnXfCA
S24%rjg5r-NQ6BCS=6(V5@5(U%

literal 2985
zcmcIlYf}?f7=AVc7Q!kBqDB<cT9J#2ws=cWte`c@O_Bl;FI_eVSP9v<*`W4*{U@FA
zbK4nkN?X78$MhFCrO(;jB%A1rPNz*~vU|>Zf8OVP^XK2c{sCYZKd1;P=*kP{v1PBB
z`IVvStBSCK_J{h0K9tibnO=G*3`fB}TNuLJ5Mw3V7I`Nv)(bP!vuOoNQo*h<D_?Z<
zyfdfgN}>ViUQp0k6#48c>SaIUqG;M8TlOPuGQLfnh_`<1akFSx8^WHkY=;ItIy03)
zD)&rC-Y+R=E()8P$r%M56V+-`j?Hot3N&X`*y|RPcBD@8h><h%rgK?ALtp=#g7BD?
z6)FzYVBuLuupb9CbfZf_(}-);0tJUP>_LZoJEEZz9SYhe%)FQ?tuF~XtuN(-OvN(v
z+?;Nk@?5@r6<Gz5YflVOa7^N=;us;Q)=-hCIL<D*0`_kx<yM@sj5Xmz(2IVV;{Z$P
zOZLynixV17;uMqC4e6Us`}#d>Tyxhjq2e@~?K(BBp{u3kWx+Ph3Oy@q74IvEmSxF&
zq2v$}p|5-52&r{W#aUKfP0IDE;XE!V*u5g0fR%#%<pdZiAV@@T2634_J9VJX%dt*H
zmNbM*Qi)CLtSWiABs}>Q4Iknv`^zk|vK<QcmSei~_6ZTeIIgR>reKeox+_cO9kC*8
z4IkkKT@-Y?D0oNA{b)fC{mB;G#Dt1lwUl{Ubi}%bNlcMiR!Le{>X{)KeFPKDAPr;b
zRS`4135(ILAZ*<!*&=2Z<FRAeSVZPIt04srp1L82ZF-sQVuu4H_wy!-b68L@UuF*x
z3`EqB!5xyJAd{ezk=GQp81U*Xf`lKa))zw!<F1B#awZy$oK+N(aCeDX&LjYNVYAtu
zvwEts#Z5(*B?Ld9;?a@rOvy9yz>_g>Eh%Z=;X@{uiH{g}Qp(YdwMo6;j+u(pG7N6l
z(yO-h*dNOBcByWpW~}+m$a<HrZ3cN>x8mGZ1Tgd2CAl~ZOLDa!RbJKLgsLD$-k6uc
zowrR#*wWU~P{IZSa)PEyPG#`qcvL$Ql&~d_@I;1us^DOCJZg0A$jlz$GYy~1O`*D6
z$mL~6xK?G;>d5M4M9AIB1B;qX@S&<{LM!w2_LAJPGJ7&Suy-RVt7IGEx+%9~TlHV)
zl$^pQ{<(nr9L<QL5luX)JcZnIOWipVIJZ(?t2^%soOe^+7C5)_%-v1jQMtMKR2gG0
zx)^aEPZt?ee!8}?KeL7CFE~_r>-mX-5Mum|xN1>8yYY^D3$)-}x(VSZ&tbZIPdZdO
z8N7)%i`(eU?CD<ELf@@{O$<(KV<@wYGnv6ne6WR!TNs%<v5C>=7`yy4k{#3G-_ek1
zIQ$&9Q=9mB{u#7*n7WJ6@C*5Pw)0!Ok&f<18(%PJJFfBzv|^TD5X%^U<JisLBfLFI
zjb0{rjBm#=h(3&>pBrWXH+Z_m=QO3WIE6HK?E+4_Weu>9R?Of5KB1p>+UQtfX-9Dg
z2C|GhNbCd)Y``)#dJ%q!Ru#QFIEN6QDhaKqSZUsoJ>Z3VB2?y^p(6Zm2i3#>4yv;(
z_W}z|5R5p>9ASZ%SoUQ?HA<+i5UNo^b)Ha-5vp-Qb?twKDu?xYR^dlBrjdXTY-2bx
z=+Y`bxs68|Qm7c-!sDrv2RHHQvz@=<VO~knux%PMm2CCM(c_NTP2Ns&7^cvJ2});J
z^=(pQwo(<NxGkn3-{kN}Pd)g8R0z?sk@jEu1kezA35{J(v*~Q}S8tI!`}{9+pJyI-
zn86~m$uQr0%>6!de^8VA*Y5nu+~vT(eeT~>mV(4gew6A0kQ)kwMT+FcXu-E{RyQl^
K3chm<zyAku7LIKI

diff --git a/src/networking/networking.java b/src/networking/networking.java
index c6e7523..2def963 100644
--- a/src/networking/networking.java
+++ b/src/networking/networking.java
@@ -7,101 +7,135 @@
 import java.net.Socket;
 
 public interface networking {
-	// Listen for the current temperature on port 7000
-    int receiveCurrentTempPORT = 7000;
-    // Send the current temperature on port 7000
-    int sendCurrentTempPORT = 7000;
-    // Listen for the desired temperature on port 7001
-    int receiveDesiredTempPORT = 7001;
-    // Send the desired temperature on port 7001
-    int sendDesiredTempPORT = 7001;
-    
-    // Discover protocol receiving port
-    int receiveDiscoverPort=7777;
-    // Discover protocol sending port
-    int sendDiscoverPORT=7778;
-    
-    // Server IP object
-    String serverIP = new String();
-    // Thermostat IP object
-    String thermostatIP = new String();
-    
-    // Listens on receiveCurrentTempPORT and outputs the received string to console.
-    public static void receiveCurrentTemp() throws Exception {
-        ServerSocket listener = new ServerSocket(receiveCurrentTempPORT);
-        try {
-        	// This stays running continuously once called.
-        	while (true) {
-        		Socket socket = listener.accept();
-        		try {
-        	        BufferedReader input =
-        	                new BufferedReader(new InputStreamReader(socket.getInputStream()));
-        	            int currentTemperature = Integer.parseInt(input.readLine());
-        			System.out.printf("The current temperature is: %d \n", currentTemperature);
-        		} finally {
-        			socket.close();
-        		}
-        	}
+
+  // Listen for the current temperature on port 7000
+  int receiveCurrentTempPORT = 7000;
+  // Send the current temperature on port 7000
+  int sendCurrentTempPORT = 7000;
+  // Listen for the desired temperature on port 7001
+  int receiveDesiredTempPORT = 7001;
+  // Send the desired temperature on port 7001
+  int sendDesiredTempPORT = 7001;
+
+  // Discover protocol receiving port
+  int receiveDiscoverPort=7777;
+  // Discover protocol sending port
+  int sendDiscoverPORT=7778;
+
+  // Server IP object
+  String serverIP = new String();
+  // Thermostat IP object
+  String thermostatIP = new String();
+
+  // Listens on receiveCurrentTempPORT and outputs the received int to console
+  public static void receiveCurrentTemp() throws Exception {
+    // Open a receiver socket
+    ServerSocket listener = new ServerSocket(receiveCurrentTempPORT);
+      try {
+        // This stays running continuously once called
+       	while (true) {
+          // Sets the socket to an accept state
+          Socket socket = listener.accept();
+          try {
+            // Creates a new input stream reader
+            BufferedReader input = new BufferedReader(new InputStreamReader 
+              (socket.getInputStream()));
+            // Parses the input stream
+            int currentTemperature = Integer.parseInt(input.readLine());
+            // Outputs the current temperature to the console
+            System.out.printf("The current temperature is: %d \n",
+              currentTemperature);
+          } finally {
+            socket.close();
+            }
         }
+      }
         finally {
-        	listener.close();
+          listener.close();
         }
-    }
-    
-    // Listens on receiveDesiredTempPORT and outputs the received string to console.
+  }
+
+    // Listens on receiveDesiredTempPORT and outputs the received int to console
     public static void receiveDesiredTemp() throws Exception {
+        // Open a receiver socket
         ServerSocket listener = new ServerSocket(receiveDesiredTempPORT);
         try {
-        	while (true) {
-        		Socket socket = listener.accept();
-        		try {
-        	        BufferedReader input =
-        	                new BufferedReader(new InputStreamReader(socket.getInputStream()));
-    	            int currentTemperature = Integer.parseInt(input.readLine());
-        	        System.out.printf("The desired temperature is: %d \n", currentTemperature);
-        		} finally {
-        			socket.close();
-        		}
-        	}
+          while (true) {
+            // Sets the socket to an accept state
+            Socket socket = listener.accept();
+            try {
+              // Creates a new input stream reader
+              BufferedReader input = new BufferedReader(new InputStreamReader
+                (socket.getInputStream()));
+              // Parses the input stream
+              int currentTemperature = Integer.parseInt(input.readLine());
+              // Outputs the desired temperature to the console
+              System.out.printf("The desired temperature is: %d \n",
+                currentTemperature);
+            } finally {
+              socket.close();
+            }
+          }
         }
         finally {
-        	listener.close();
+          listener.close();
         }
     }
-    
-    // Sends the current temperature on port sendCurrentTempPORT. 
-    public static void sendCurrentTemp(int currentTemperature, String serverIP) throws Exception {
-    	Socket sender = new Socket(serverIP, sendCurrentTempPORT);
-    	try {
-    		while (true) {
-    	    	PrintWriter out = new PrintWriter(sender.getOutputStream(), true);
-    	    	out.println(currentTemperature);
-    		}
-    	} finally {
-    		sender.close();
-    	}
+
+    // Sends the current temperature on port sendCurrentTempPORT
+    public static void sendCurrentTemp(int currentTemperature, String serverIP)
+    throws Exception {
+      // Open a sending port
+      Socket sender = new Socket(serverIP, sendCurrentTempPORT);
+      try {
+        while (true) {
+          // Instantiate a printwriter so we can write to the output stream
+          PrintWriter out = new PrintWriter(sender.getOutputStream(), true);
+          // Send out the value of currentTemperature
+          out.println(currentTemperature);
+        }
+      } finally {
+        // Immediately close the socket when finished.
+        sender.close();
+      }
     }
-    
-    // Sends the desired temperature on port sendDesiredTempPORT. 
-    public static void sendDesiredTemp(int desiredTemperature, String thermostatIP) throws Exception {
-    	Socket sender = new Socket(thermostatIP, sendDesiredTempPORT);
-    	try {
-    		while (true) {
-    	    	PrintWriter out = new PrintWriter(sender.getOutputStream(), true);
-    	    	out.println(desiredTemperature);
-    		}
-    	} finally {
-    		sender.close();
-    	}
+
+    // Sends the desired temperature on port sendDesiredTempPORT
+    public static void sendDesiredTemp(int desiredTemperature,
+      String thermostatIP)
+    throws Exception {
+      // Opens a sending port
+      Socket sender = new Socket(thermostatIP, sendDesiredTempPORT);
+      try {
+        while (true) {
+          // Instantiate a printwriter so we can write to the output stream
+          PrintWriter out = new PrintWriter(sender.getOutputStream(), true);
+          // Send out the value of desiredTemperature
+          out.println(desiredTemperature);
+        }
+      } finally {
+        // Immediately close the socket when finished
+        sender.close();
+      }
     }
     
-    // This discover protocol finds other instances of Thermocontroller running on the network, and updates the IP addresses accordingly for the server and the thermostat
-    public static void getServerIP() {
-    	
+    // This discover protocol finds other instances of Thermocontroller running
+    // on the network, and updates the IP addresses accordingly
+    // for the server and the thermostat
+    public static void monitorServerIP() {
+
     }
-    
-    public static void getThermostatIP() {
-    	
+
+    public static void monitorThermostatIP() {
+
     }
-    
+
+    public static void setDesiredTemp() {
+
+    }
+
+    public static void updateCurrentTemp() {
+
+    }
+
 }
\ No newline at end of file