Add server class to handle server start and get connected clients

Author: mscosti

adafruit_esp32spi/adafruit_esp32spi_server.py

@@ -0,0 +1,94 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2019 ladyada for Adafruit Industries
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+"""
+`adafruit_esp32spi_server`
+================================================================================
+
+TODO: better description?
+Server management lib to make handling and responding to incoming requests much easier
+
+* Author(s): Matt Costi
+"""
+
+from micropython import const
+import adafruit_esp32spi_socket as socket
+
+_the_interface = None   # pylint: disable=invalid-name
+def set_interface(iface):
+    """Helper to set the global internet interface"""
+    global _the_interface   # pylint: disable=global-statement, invalid-name
+    _the_interface = iface
+    socket.set_interface(iface)
+
+NO_SOCK_AVAIL = const(255)
+
+
+# pylint: disable=unused-argument, redefined-builtin, invalid-name
+class server:
+    """ TODO: class docs """
+    def __init__(self, port=80, debug=False):
+        self.port = port
+        self._server_sock = socket.socket(socknum=NO_SOCK_AVAIL)
+        self._client_sock = socket.socket(socknum=NO_SOCK_AVAIL)
+        self._debug = debug
+
+
+    def start(self):
+        """ start the server """
+        self._server_sock = socket.socket()
+        _the_interface.start_server(self.port, self._server_sock.socknum)
+        if self._debug:
+            ip = _the_interface.pretty_ip(_the_interface.ip_address)
+            print("Server available at {0}:{1}".format(ip, self.port))
+            print("Sever status: ", _the_interface.get_server_state(self._server_sock.socknum))
+
+    def client_available(self):
+        """
+        returns a client socket connection if available.otherwise, returns a non available socket
+        :return the client
+        :rtype Socket
+        """
+        sock = None
+        if self._server_sock.socknum != NO_SOCK_AVAIL:
+            if self._client_sock.socknum != NO_SOCK_AVAIL:
+                # check previous received client socket
+                if self._debug:
+                    print("checking if last client sock still valid")
+                if self._client_sock.connected() and self._client_sock.available():
+                    sock = self._client_sock
+            if not sock:
+                # check for new client sock
+                if self._debug:
+                    print("checking for new client sock")
+                client_sock_num = _the_interface.socket_available(self._server_sock.socknum)
+                sock = socket.socket(socknum=client_sock_num)
+        else:
+            print("Server has not been started, cannot check for clients!")
+
+        if sock and sock.socknum != NO_SOCK_AVAIL:
+            if self._debug:
+                print("client sock num is: ", sock.socknum)
+            self._client_sock = sock
+            return self._client_sock
+
+        return socket.socket(socknum=NO_SOCK_AVAIL)

adafruit_esp32spi/adafruit_esp32spi_socket.py

@@ -32,6 +32,7 @@
 
 import time
 import gc
+import adafruit_esp32spi as esp
 from micropython import const
 
 _the_interface = None   # pylint: disable=invalid-name
@@ -42,6 +43,7 @@ def set_interface(iface):
 
 SOCK_STREAM = const(1)
 AF_INET = const(2)
+NO_SOCKET_AVAIL = const(255)
 
 MAX_PACKET = const(4000)
 
@@ -59,13 +61,13 @@ def getaddrinfo(host, port, family=0, socktype=0, proto=0, flags=0):
 class socket:
     """A simplified implementation of the Python 'socket' class, for connecting
     through an interface to a remote device"""
-    def __init__(self, family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None):
+    def __init__(self, family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None, socknum=None):
         if family != AF_INET:
             raise RuntimeError("Only AF_INET family supported")
         if type != SOCK_STREAM:
             raise RuntimeError("Only SOCK_STREAM type supported")
         self._buffer = b''
-        self._socknum = _the_interface.get_socket()
+        self._socknum = socknum if socknum else _the_interface.get_socket()
         self.settimeout(0)
 
     def connect(self, address, conntype=None):
@@ -148,11 +150,35 @@ def settimeout(self, value):
         """Set the read timeout for sockets, if value is 0 it will block"""
         self._timeout = value
 
-    def get_sock_num(self):
+    def available(self):
+        if self.socknum != NO_SOCKET_AVAIL:
+            return min(_the_interface.socket_available(self._socknum), MAX_PACKET)
+        return 0
+
+    def connected(self):
+        if self.socknum == NO_SOCKET_AVAIL:
+            return False
+        elif self.available():
+            return True
+        else:
+            status = _the_interface.socket_status(self.socknum)
+            result = status not in (esp.SOCKET_LISTEN,
+                                    esp.SOCKET_CLOSED,
+                                    esp.SOCKET_FIN_WAIT_1,
+                                    esp.SOCKET_FIN_WAIT_2,
+                                    esp.SOCKET_TIME_WAIT,
+                                    esp.SOCKET_SYN_SENT,
+                                    esp.SOCKET_SYN_RCVD,
+                                    esp.SOCKET_CLOSE_WAIT)
+            if not result:
+                self.close()
+                self._socknum = NO_SOCKET_AVAIL
+            return result
+
+    @property
+    def socknum(self):
         return self._socknum
 
-    def set_sock_num(self, sock_num):
-        self._socknum = sock_num
     def close(self):
         """Close the socket, after reading whatever remains"""
         _the_interface.socket_close(self._socknum)

examples/esp32spi_server.py

@@ -4,7 +4,7 @@
 
 from adafruit_esp32spi import adafruit_esp32spi
 import adafruit_esp32spi.adafruit_esp32spi_wifimanager as wifimanager
-import adafruit_esp32spi.adafruit_esp32spi_socket as socket
+import adafruit_esp32spi.adafruit_esp32spi_server as server
 
 # Get wifi details and more from a secrets.py file
 try:
@@ -28,54 +28,27 @@
 wifi = wifimanager.ESPSPI_WiFiManager(esp, secrets, debug=True)
 wifi.connect()
 
-socket.set_interface(esp)
-sock = socket.socket() # Request a socket for the server
-curr_sock = sock
-sockNum = sock.get_sock_num()
-print("server status: ", esp.get_server_state(sockNum))
+server.set_interface(esp)
+server = server.server(80, True)
+server.start()
 
-# Start the server on port 80 with the socket number we just requested for it.
-esp.start_server(80, sockNum)
-
-print("socket num: ", sockNum)
-print("server status: ", esp.get_server_state(sockNum))
 print("IP addr: ", esp.pretty_ip(esp.ip_address))
-print("info: ", esp.network_data)
-print("done!")
-
-
-status = 0
-last_sock = 255
-def server_avail(): # TODO: make a server helper class
-    global last_sock
-    sock = 255;
-
-    if (curr_sock != 255):
-        # if (last_sock != 255):
-        #       TODO: if last sock, check that last_sock is still connected and available
-        #     sock = last_sock
-        if (sock == 255):
-            sock = esp.socket_available(sockNum)
-    if (sock != 255):
-        last_sock = sock
-        return sock
+print("server started!")
 
-    return 255
 
 while True:
 
-    avail = server_avail()
-    if (avail != 255):
-        sock.set_sock_num(avail) # TODO: Server class should return a new client socket
-        data = sock.read()
+    client = server.client_available()
+    if (client.available()):
+        data = client.read()
         if len(data):
             print(data)
-            sock.write(b"HTTP/1.1 200 OK\r\n")
-            sock.write(b"Content-type:text/html\r\n")
-            sock.write(b"\r\n")
+            client.write(b"HTTP/1.1 200 OK\r\n")
+            client.write(b"Content-type:text/html\r\n")
+            client.write(b"\r\n")
 
-            sock.write(b"Click <a href=\"/H\">here</a> turn the LED on!!!<br>\r\n")
-            sock.write(b"Click <a href=\"/L\">here</a> turn the LED off!!!!<br>\r\n")
+            client.write(b"Click <a href=\"/H\">here</a> turn the LED on!!!<br>\r\n")
+            client.write(b"Click <a href=\"/L\">here</a> turn the LED off!!!!<br>\r\n")
 
-            sock.write(b"\r\n")
-            sock.close()
+            client.write(b"\r\n")
+            client.close()