boswatch.network.server.TCPServer Class Reference

TCP server class. More...

Public Member Functions
	__init__ (self, alarmQueue, timeout=3)
	Create a new instance.
	__del__ (self)
	start (self, port=8080)
	Start a threaded TCP socket server.
	stop (self)
	Stops the TCP socket server.
	countClientsConnected (self)
	Number of currently connected Clients.
	getClientsConnected (self)
	A list of all connected clients with their IP address and last seen timestamp _clients[ThreadName] = {"address", "timestamp"}.
	isRunning (self)
	Property of server running state.

Protected Attributes
	_server
	_server_thread
	_timeout
	_alarmQueue
	_clientsConnectedLock
	_clientsConnected

Detailed Description

TCP server class.

Constructor & Destructor Documentation

__init__()

boswatch.network.server.TCPServer.__init__	(		self,
			alarmQueue,
			timeout = 3
	)

Create a new instance.

Parameters

alarmQueue	python queue instance
timeout	server timeout in sec (3)

    def __init__(self, alarmQueue, timeout=3):
        r"""!Create a new instance
 
        @param alarmQueue: python queue instance
        @param timeout: server timeout in sec (3)
        """
        self._server = None
        self._server_thread = None
        self._timeout = timeout
        self._alarmQueue = alarmQueue
 
        self._clientsConnectedLock = threading.Lock()
        self._clientsConnected = {}
 

__del__()

boswatch.network.server.TCPServer.__del__

(

self

)

    def __del__(self):
        if self.isRunning:
            self.stop()
 

Member Function Documentation

start()

boswatch.network.server.TCPServer.start	(		self,
			port = 8080
	)

Start a threaded TCP socket server.

Start a TCP Socket Server in a new thread that will then start one more thread for each client request. The ip address for binding the server socket is always 'localhost'

Parameters

port	Server Port (8080)

Returns

True or False

    def start(self, port=8080):
        r"""!Start a threaded TCP socket server
 
        Start a TCP Socket Server in a new thread that will
        then start one more thread for each client request.
        The ip address for binding the server socket is always 'localhost'
 
        @param port: Server Port (8080)
 
        @return True or False"""
        if not self.isRunning:
            try:
                socketserver.TCPServer.allow_reuse_address = True  # because we can start two instances on same port elsewhere
                self._server = _ThreadedTCPServer(("", port), _ThreadedTCPRequestHandler)
                self._server.timeout = self._timeout
                self._server.alarmQueue = self._alarmQueue
                self._server.isActive = True
 
                self._server.clientsConnectedLock = self._clientsConnectedLock
                self._server.clientsConnected = self._clientsConnected
 
                self._server_thread = threading.Thread(target=self._server.serve_forever)
                self._server_thread.name = "Thread-BWServer"
                self._server_thread.daemon = True
                self._server_thread.start()
                logging.debug("TCPServer started in Thread: %s", self._server_thread.name)
                return True
            except socket.error as e:
                logging.error(e)
                return False
        else:
            logging.warning("server always started")
            return True
 

stop()

boswatch.network.server.TCPServer.stop

(

self

)

Stops the TCP socket server.

Returns

True or False

    def stop(self):
        r"""!Stops the TCP socket server
 
        @return True or False"""
        if self.isRunning:
            self._server.shutdown()
            self._server.isActive = False
            self._server.server_close()
            self._server_thread.join()
            self._server_thread = None
            self._server = None
            logging.debug("TCPServer stopped")
            return True
        logging.warning("server always stopped")
        return True
 

countClientsConnected()

boswatch.network.server.TCPServer.countClientsConnected

(

self

)

Number of currently connected Clients.

Returns

Connected clients

    def countClientsConnected(self):
        r"""!Number of currently connected Clients
 
        @return Connected clients"""
        with self._clientsConnectedLock:  # because our list is not threadsafe
            return len(self._clientsConnected)
 

getClientsConnected()

boswatch.network.server.TCPServer.getClientsConnected

(

self

)

A list of all connected clients with their IP address and last seen timestamp _clients[ThreadName] = {"address", "timestamp"}.

Returns

List of onnected clients

    def getClientsConnected(self):
        r"""!A list of all connected clients
        with their IP address and last seen timestamp
        _clients[ThreadName] = {"address", "timestamp"}
 
        @return List of onnected clients"""
        # todo return full list or write a print/debug method?
        with self._clientsConnectedLock:  # because our list is not threadsafe
            return self._clientsConnected
 

isRunning()

boswatch.network.server.TCPServer.isRunning

(

self

)

Property of server running state.

    def isRunning(self):
        r"""!Property of server running state"""
        if self._server:
            return True
        return False

Field Documentation

_server

boswatch.network.server.TCPServer._server

protected

_server_thread

boswatch.network.server.TCPServer._server_thread

protected

_timeout

boswatch.network.server.TCPServer._timeout

protected

_alarmQueue

boswatch.network.server.TCPServer._alarmQueue

protected

_clientsConnectedLock

boswatch.network.server.TCPServer._clientsConnectedLock

protected

_clientsConnected

boswatch.network.server.TCPServer._clientsConnected

protected