boswatch.network.broadcast.BroadcastClient Class Reference

BroadcastClient class. More...

Public Member Functions
def	__init__ (self, port=5000)
	Create an BroadcastClient instance.
def	getConnInfo (self, retry=0)
	Get the connection info from server over udp broadcast.
def	serverIP (self)
	Property to get the server IP after successful broadcast.
def	serverPort (self)
	Property to get the server Port after successful broadcast.

Protected Attributes
	_broadcastPort
	_serverIP
	_serverPort
	_socket

Detailed Description

BroadcastClient class.

Constructor & Destructor Documentation

__init__()

def boswatch.network.broadcast.BroadcastClient.__init__	(		self,
			port = 5000
	)

Create an BroadcastClient instance.

    @param port: port to send broadcast packets (5000)

    def __init__(self, port=5000):
        r"""!Create an BroadcastClient instance
 
        @param port: port to send broadcast packets (5000)"""
        self._broadcastPort = port
 
        self._serverIP = ""
        self._serverPort = 0
 
        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(3)
 

Member Function Documentation

getConnInfo()

def boswatch.network.broadcast.BroadcastClient.getConnInfo	(		self,
			retry = 0
	)

Get the connection info from server over udp broadcast.

    This function will send broadcast package(s)
    to get connection info from the server.

    - send the magic packet <BW-Request> on broadcast address.
    - wait for a <BW-Result> magic packet.
    - extract the connection data from the magic packet and return

    @param retry: Count of retry - 0 is infinite (0)

    @return True or False

    def getConnInfo(self, retry=0):
        r"""!Get the connection info from server over udp broadcast
 
        This function will send broadcast package(s)
        to get connection info from the server.
 
        - send the magic packet <BW-Request> on broadcast address.
        - wait for a <BW-Result> magic packet.
        - extract the connection data from the magic packet and return
 
        @param retry: Count of retry - 0 is infinite (0)
 
        @return True or False"""
        sendPackages = 0
        while sendPackages < retry or retry == 0:
            try:
                logging.debug("send magic <BW3-Request> as broadcast - Try: %d", sendPackages)
                self._socket.sendto("<BW3-Request>".encode(), ('255.255.255.255', self._broadcastPort))
                sendPackages += 1
                payload, address = self._socket.recvfrom(1024)
                payload = str(payload, "UTF-8")
 
                if payload.startswith("<BW3-Result>"):
                    logging.debug("received magic <BW3-Result> from: %s", address[0])
                    self._serverIP = address[0]
                    self._serverPort = int(payload.split(";")[1])
                    logging.info("got connection info from server: %s:%d", self._serverIP, self._serverPort)
                    return True
            except socket.timeout:  # nothing received - retry
                logging.debug("no magic packet received")
        logging.warning("cannot fetch connection info after %d tries", sendPackages)
        return False
 

serverIP()

def boswatch.network.broadcast.BroadcastClient.serverIP

(

self

)

Property to get the server IP after successful broadcast.

    def serverIP(self):
        r"""!Property to get the server IP after successful broadcast"""
        return self._serverIP
 

serverPort()

def boswatch.network.broadcast.BroadcastClient.serverPort

(

self

)

Property to get the server Port after successful broadcast.

    def serverPort(self):
        r"""!Property to get the server Port after successful broadcast"""
        return self._serverPort
 
 

Field Documentation

_broadcastPort

boswatch.network.broadcast.BroadcastClient._broadcastPort

protected

_serverIP

boswatch.network.broadcast.BroadcastClient._serverIP

protected

_serverPort

boswatch.network.broadcast.BroadcastClient._serverPort

protected

_socket

boswatch.network.broadcast.BroadcastClient._socket

protected