Welcome, guest | Sign In | My Account | Store | Cart
"""Module for simple UDP broadcast support.

The classes in this module are stepping stones for building discoverable
services on a network. Server replies are to be handled by the importer."""

################################################################################

__author__ = 'Stephen "Zero" Chappell <Noctis.Skytower@gmail.com>'
__date__ = '4 December 2011'
__version__ = '$Revision: 5 $'

################################################################################

import socket
import _thread
import time

################################################################################

class Beacon:

    __slots__ = '__sock', '__addr'

    def __init__(self, port):
        "Initialize the beacon for sending and receiving data."
        self.__sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
        self.__sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, True)
        self.__sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, True)
        self.__sock.bind(('0.0.0.0', port))
        self.__addr = '255.255.255.255', port

    def __del__(self):
        "Shutdown and close the underlying socket."
        self.__sock.shutdown(socket.SHUT_RDWR)
        self.__sock.close()

    def recv(self, size):
        "Receive a broadcast through the underlying socket."
        return self.__sock.recvfrom(size)

    def send(self, data):
        "Send a broadcast through the underlying socket."
        assert self.__sock.sendto(data, self.__addr) == len(data), \
               'Not all data was sent through the socket!'

    def __gettimeout(self):
        return self.__sock.gettimeout()

    def __settimeout(self, value):
        self.__sock.settimeout(value)

    def __deltimeout(self):
        self.__sock.setblocking(True)

    timeout = property(__gettimeout, __settimeout, __deltimeout,
                       'Timeout on blocking socket operations.')

################################################################################

def test():
    "Test the beacon broadcasting class."
    b = Beacon(50000)
    _thread.start_new_thread(test_send, (b,))
    test_recv(b)

def test_send(b):
    "Test the beacon's send method."
    while True:
        b.send(time.strftime('%Y-%m-%dT%H:%M:%SZ', time.gmtime()).encode())
        time.sleep(1)

def test_recv(b):
    "Test the beacon's recv method."
    while True:
        data, address = b.recv(1 << 12)
        print('From: {}\n{}\n'.format(address, data.decode()))

################################################################################

if __name__ == '__main__':
    test()

Diff to Previous Revision

--- revision 5 2011-12-03 03:52:15
+++ revision 6 2011-12-04 22:18:13
@@ -6,8 +6,8 @@
 ################################################################################
 
 __author__ = 'Stephen "Zero" Chappell <Noctis.Skytower@gmail.com>'
-__date__ = '2 December 2011'
-__version__ = '$Revision: 4 $'
+__date__ = '4 December 2011'
+__version__ = '$Revision: 5 $'
 
 ################################################################################
 
@@ -28,6 +28,11 @@
         self.__sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, True)
         self.__sock.bind(('0.0.0.0', port))
         self.__addr = '255.255.255.255', port
+
+    def __del__(self):
+        "Shutdown and close the underlying socket."
+        self.__sock.shutdown(socket.SHUT_RDWR)
+        self.__sock.close()
 
     def recv(self, size):
         "Receive a broadcast through the underlying socket."

History