boswatch.network.broadcast.BroadcastServer Class Reference

BroadcastServer class. More...

Public Member Functions
def	__init__ (self, servePort=8080, listenPort=5000)
	Create an BroadcastServer instance.
def	__del__ (self)
def	start (self)
	Start the broadcast server in a new thread.
def	stop (self)
	Stop the broadcast server.
def	isRunning (self)
	Property of broadcast server running state.

Protected Member Functions
def	_listen (self)
	Broadcast server worker thread.

Protected Attributes
	_socket
	_serverThread
	_serverShutdown
	_servePort

Detailed Description

BroadcastServer class.

Constructor & Destructor Documentation

__init__()

def boswatch.network.broadcast.BroadcastServer.__init__	(		self,
			servePort = 8080,
			listenPort = 5000
	)

Create an BroadcastServer instance.

    @param servePort: port to serve as connection info (8080)
    @param listenPort: port to listen for broadcast packets (5000)

    def __init__(self, servePort=8080, listenPort=5000):
        r"""!Create an BroadcastServer instance
 
        @param servePort: port to serve as connection info (8080)
        @param listenPort: port to listen for broadcast packets (5000)"""
        self._socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
        self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
        self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
        self._socket.settimeout(2)
        self._socket.bind(('', listenPort))
        self._serverThread = None
        self._serverShutdown = False
        self._servePort = servePort
 

__del__()

def boswatch.network.broadcast.BroadcastServer.__del__

(

self

)

    def __del__(self):  # pragma: no cover
        if self.isRunning:
            self.stop()
            while self.isRunning:
                pass
 

Member Function Documentation

start()

def boswatch.network.broadcast.BroadcastServer.start

(

self

)

Start the broadcast server in a new thread.

    @return True or False

    def start(self):
        r"""!Start the broadcast server in a new thread
 
        @return True or False"""
        if not self.isRunning:
            logging.debug("start udp broadcast server")
            self._serverThread = threading.Thread(target=self._listen)
            self._serverThread.name = "BroadServ"
            self._serverThread.daemon = True
            self._serverShutdown = False
            self._serverThread.start()
            return True
        logging.warning("udp broadcast server always started")
        return True
 

stop()

def boswatch.network.broadcast.BroadcastServer.stop

(

self

)

Stop the broadcast server.

    Due to the timeout of the socket,
    stopping the thread can be delayed by two seconds.
    But function returns immediately.

    @return True or False

    def stop(self):
        r"""!Stop the broadcast server
 
        Due to the timeout of the socket,
        stopping the thread can be delayed by two seconds.
        But function returns immediately.
 
        @return True or False"""
 
        if self.isRunning:
            logging.debug("stop udp broadcast server")
            self._serverShutdown = True
            return True
        else:
            logging.warning("udp broadcast server always stopped")
            return True
 

_listen()

def boswatch.network.broadcast.BroadcastServer._listen (   self )

protected

Broadcast server worker thread.

    This function listen for magic packets on broadcast
    address and send the connection info to the clients.

    - listen for the magic packet <BW-Request>
    - send connection info in an <BW-Result> macig packet

    def _listen(self):
        r"""!Broadcast server worker thread
 
        This function listen for magic packets on broadcast
        address and send the connection info to the clients.
 
        - listen for the magic packet <BW-Request>
        - send connection info in an <BW-Result> macig packet"""
        logging.debug("start listening for magic")
        while not self._serverShutdown:
            try:
                payload, address = self._socket.recvfrom(1024)
                payload = str(payload, "UTF-8")
                if payload == "<BW3-Request>":
                    logging.debug("received magic <BW3-Request> from: %s", address[0])
                    logging.info("send connection info in magic <BW3-Result> to: %s", address[0])
                    self._socket.sendto("<BW3-Result>;".encode() + str(self._servePort).encode(), address)
            except socket.timeout:
                continue  # timeout is accepted (not block at recvfrom())
        self._serverThread = None
        logging.debug("udp broadcast server stopped")
 

isRunning()

def boswatch.network.broadcast.BroadcastServer.isRunning

(

self

)

Property of broadcast server running state.

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

Field Documentation

_socket

boswatch.network.broadcast.BroadcastServer._socket

protected

_serverThread

boswatch.network.broadcast.BroadcastServer._serverThread

protected

_serverShutdown

boswatch.network.broadcast.BroadcastServer._serverShutdown

protected

_servePort

boswatch.network.broadcast.BroadcastServer._servePort

protected