Skip to main content

ssdp server and client of upnp

Project description

ssdp_upnp

Introduction

The acticle Exploring UPnP with Python gives a realy good insight of UPNP. SSDP is one of it's implementation.

The packege includes three individual Classes, ssdp server, ssdp client, nat upnp class. They first two class inherits from Class threading.Thread class, thus the two class instance runs on a single thread of own. They will not block main thread. After the ssdp client find a peer with same product name, it can communicate with main thread by queue. Nat upnp class is running on main thread, thus it will not block I/O, it will just search for LAN GDI (router with upnp nap forwarding function), and bind internal port with external port.

The logic of server is just listen a broadcast address with port 1900. If it received a "M-SEARCH" message, it will responce it's service infomation. The client just send a broadcast message with "M-SEARCH", and get server's service infomation.

The package can be used in blockchain solution where peers to find each other in LAN environment.

API

Server Class

run(): run the server in main thread with I/O blocking
start(): run the server in other thread with I/O nonblocking
stop(): stop the server

Client

run(): run the client in main thread with I/O blocking
start(): run the client in other thread with I/O nonblocking
stop(): stop the client

Nat

addPortForward(internal_port, external_port): run the function in main thread. It returns None if fail to bind, returns a tuple (external_ip, external_port) if succeed.
removePortForward(external_port): run the function in main thread. It returns True if succeed, and returns False if failed.

example

pip install ssdp-upnp
    import sys
    from ssdp_upnp.ssdp import Server, Client, Nat
    from ssdp_upnp.ssdp import gen_logger
    from queue import Queue

    logger = gen_logger('sample')

    if __name__ == '__main__':
        try:
            if sys.argv[1] == 'server':
                upnpServer  = Server(8048, 'blockchain', 'main')
                upnpServer.start()
            elif sys.argv[1] == 'client':
                queue = Queue()
                upnpClient = Client('blockchain', 'main', queue)
                upnpClient.start()
                logger.info(queue.get())
            elif sys.argv[1] == 'nat':
                nat = Nat()
                print(nat.addPortForward(8011, 8015))
            else:
                logger.warning('need params server or clinet')
        except Exception as e:
            logger.error(e)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ssdp_upnp-0.1.0.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

ssdp_upnp-0.1.0-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file ssdp_upnp-0.1.0.tar.gz.

File metadata

  • Download URL: ssdp_upnp-0.1.0.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.5

File hashes

Hashes for ssdp_upnp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3d680668a28922b5fbb4f69c5209df147d6dadbc2ecaea65fd8016c8f7db5b28
MD5 557a1c2a28e54a860c4b9c30978e5278
BLAKE2b-256 552a9af87f5eb75c0db21d6efbab681bf201ff19775995ffa5f67995b6f097a8

See more details on using hashes here.

File details

Details for the file ssdp_upnp-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ssdp_upnp-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.5

File hashes

Hashes for ssdp_upnp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 804b2fd4c8a5b3f9c1e3c114b67154da86096bc04e266bbdaf58eca662f67f2a
MD5 531e4516c034980eaae52fef01f4855d
BLAKE2b-256 9ce54ee71fdbda73d5161b0af5f39b55475b1ea19d38668a211b9de8198a0550

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page