add option to return a message to a client after processing one

Author: chris-piekarski

examples/example_servers.py

@@ -24,6 +24,7 @@ def _process_message(self, obj):
 		if obj != '':
 			if obj['message'] == "new connection":
 				logger.info("new connection.")
+				return {'message': 'welcome to jsocket server'}
 
 class MyFactoryThread(jsocket.ServerFactoryThread):
 	"""	This is an example factory thread, which the server factory will
@@ -37,25 +38,29 @@ def _process_message(self, obj):
 		""" virtual method - Implementer must define protocol """
 		if obj != '':
 			if obj['message'] == "new connection":
-				logger.info("new connection.")
+				logger.info("new connection...")
+				return {'message': 'welcome to jsocket server'}
 			else:
 				logger.info(obj)
 
 if __name__ == "__main__":
 	import time
 	import jsocket
 
-	server = jsocket.ServerFactory(MyFactoryThread, address='127.0.0.1', port=5490)
+	server = jsocket.ServerFactory(MyFactoryThread, address='127.0.0.1', port=5491)
 	server.timeout = 2.0
 	server.start()
 
 	time.sleep(1)
 	cPids = []
 	for i in range(10):
-		client = jsocket.JsonClient(address='127.0.0.1', port=5490)
+		client = jsocket.JsonClient(address='127.0.0.1', port=5491)
 		cPids.append(client)
 		client.connect()
 		client.send_obj({"message": "new connection", "test": i})
+		logger.info(client.read_obj())
+
+
 		client.send_obj({"message": i, "key": 1 })
 
 	time.sleep(2)

jsocket/tserver.py

@@ -20,7 +20,7 @@
 	GNU General Public License for more details.
 
 	You should have received a copy of the GNU General Public License
-	along with tserver module.  If not, see <http://www.gnu.org/licenses/>."""
+	along with tserver module.	If not, see <http://www.gnu.org/licenses/>."""
 __version__	 = "1.0.2"
 
 import jsocket.jsocket_base as jsocket_base
@@ -42,8 +42,8 @@ def _process_message(self, obj):
 		
 			This method is called every time a JSON object is received from a client
 			
-			@param	obj	JSON "key: value" object received from client
-			@retval	None
+			@param	obj JSON "key: value" object received from client
+			@retval None or a response object
 		"""
 		pass
 
@@ -61,7 +61,10 @@ def run(self):
 			while self._isAlive:
 				try:
 					obj = self.read_obj()
-					self._process_message(obj)
+					resp_obj = self._process_message(obj)
+					if resp_obj is not None:
+						logger.debug("message has a response")
+						self.send_obj(resp_obj)
 				except socket.timeout as e:
 					logger.debug("socket.timeout: %s" % e)
 					continue
@@ -100,20 +103,23 @@ def swap_socket(self, new_sock):
 		""" Swaps the existing socket with a new one. Useful for setting socket after a new connection.
 		
 			@param	new_sock	socket to replace the existing default jsocket.JsonSocket object	
-			@retval	None
+			@retval None
 		"""
 		del self.socket
 		self.socket = new_sock
 		self.conn = self.socket
 
 	def run(self):
 		""" Should exit when client closes socket conn.
-		    Can force an exit with force_stop.
+			Can force an exit with force_stop.
 		"""
 		while self._isAlive:
 			try:
 				obj = self.read_obj()
-				self._process_message(obj)
+				resp_obj = self._process_message(obj)
+				if resp_obj is not None:
+					logger.debug("message has a response")
+					self.send_obj(resp_obj)
 			except socket.timeout as e:
 				logger.debug("socket.timeout: %s" % e)
 				continue
@@ -136,7 +142,7 @@ def start(self):
 
 	def force_stop(self):
 		""" Force stops the factory thread.
-		    Should exit when client socket is closed under normal conditions.
+			Should exit when client socket is closed under normal conditions.
 			The life of the dead is in the memory of the living.
 
 			@retval None

setup.py

@@ -3,7 +3,7 @@
 from setuptools import setup, Extension
 
 setup(name='jsocket',
-      version='1.9.0',
+      version='1.9.1',
       description='Python JSON Server & Client',
       author='Christopher Piekarski',
       author_email='[email protected]',