From 03cbd5474d7bf1f36a6861eb2899a6342b9101e4 Mon Sep 17 00:00:00 2001
From: Fred Z <freezed@users.noreply.github.com>
Date: Thu, 8 Mar 2018 12:06:22 +0100
Subject: [PATCH] Add network/connection Class

Create a socket object for opening the server connection with some mehods:
-__init__()
- close()
- list_sockets()
- count_clients()
---
 roboc/ConnectSocket.py | 105 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 105 insertions(+)
 create mode 100644 roboc/ConnectSocket.py

diff --git a/roboc/ConnectSocket.py b/roboc/ConnectSocket.py
new file mode 100644
index 0000000..c0e493f
--- /dev/null
+++ b/roboc/ConnectSocket.py
@@ -0,0 +1,105 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+Author: freezed <freezed@users.noreply.github.com> 2018-03-06
+Version: 0.1
+Licence: `GNU GPL v3` GNU GPL v3: http://www.gnu.org/licenses/
+
+This file is part or roboc project. View `readme.md`
+"""
+import socket
+
+
+class ConnectSocket:
+    """
+    ConnectSocket
+    =======
+
+    Provide network connection and management methods
+
+    :Example:
+    >>> c0 = ConnectSocket(False)
+    Server is running, listening on port 5555
+
+    >>> c0.list_sockets(False)
+
+    >>> c0.list_sockets()
+    0: (localhost-5555)
+
+    >>> c0.count_clients()
+    0
+
+    >>> c0.close()
+    Server stop
+
+    >>> c0.list_sockets()
+
+    """
+
+    _HOST = 'localhost'
+    _PORT = 5555
+    _BUFFER = 1024
+    _SERVER_LOG = "{}:{}|{name}|{msg}"
+    _MSG_DISCONNECTED = "<gone away to infinity, and beyond>"
+    _MSG_SERVER_STOP = "Server stop"
+    _MSG_START_SERVER = "Server is running, listening on port {}"
+    _MSG_USER_IN = "<entered the chatroom>"
+    _MSG_WELCOME = "Welcome"
+    _MSG_SALUTE = "Hi, {}, everyone is listening to you:"
+
+    def __init__(self, named=False, host=_HOST, port=_PORT):
+        """ Set up the connection """
+        self._inputs = []
+
+        # Creation de la connection
+        self._CONNECTION = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        self._CONNECTION.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+        self._CONNECTION.bind((host, port))
+        self._CONNECTION.listen(5)
+        self._inputs.append(self._CONNECTION)
+        print(self._MSG_START_SERVER.format(port))
+
+        if named:
+            self._user_name = []
+            self._user_name.append("CONNECTION")
+
+    def close(self):
+        """ Cleanly closes each socket (clients) of the network """
+        self._CONNECTION = self._inputs.pop(0)
+        i = 1
+        for sckt in self._inputs:
+            print(self._SERVER_LOG.format(
+                *sckt.getpeername(),
+                name=self._user_name[i],
+                msg="closed client sckt")
+                 )
+            sckt.close()
+            i += 1
+        self._inputs.clear()
+        self._CONNECTION.close()
+        print(self._MSG_SERVER_STOP)
+
+    def list_sockets(self, print_it=True):
+        """ List connected sckts """
+        if print_it:
+            for idx, sckt in enumerate(self._inputs):
+                if idx == 0:
+                    print("{}: ({}-{})".format(
+                        idx, self._HOST, self._PORT)
+                         )
+                else:
+                    print("{}: {}".format(idx, sckt))
+        else:
+            return self._inputs
+
+    def count_clients(self):
+        """ Count connected clients"""
+        return len(self._inputs) - 1
+
+
+if __name__ == "__main__":
+    """ Starting doctests """
+
+    import doctest
+    doctest.testmod()