Source code for coherence.upnp.devices.internet_gateway_device_client

# -*- coding: utf-8 -*-

# Licensed under the MIT license
# http://opensource.org/licenses/mit-license.php

# Copyright 2010 Frank Scholz <dev@coherence-project.org>

'''
:class:`InternetGatewayDeviceClient`
------------------------------------

A class representing an embedded WAN's Device.
'''

from eventdispatcher import (
    EventDispatcher, Property, StringProperty)

from coherence import log
from coherence.upnp.devices.wan_device_client import WANDeviceClient


[docs]class InternetGatewayDeviceClient(EventDispatcher, log.LogAble): ''' .. versionchanged:: 0.9.0 * Introduced inheritance from EventDispatcher * The emitted events changed: - Coherence.UPnP.DeviceClient.detection_completed => device_client_detection_completed * Changed `device_type` and `detection_completed` to use EventDispatcher's properties ''' logCategory = 'igd_client' device_type = StringProperty('') detection_completed = Property(False) def __init__(self, device): log.LogAble.__init__(self) EventDispatcher.__init__(self) self.register_event( # 'Coherence.UPnP.DeviceClient.detection_completed', 'device_client_detection_completed', ) self.device = device # 'Coherence.UPnP.DeviceClient.Service.notified' self.device.bind( embedded_device_client_detection_completed=self.embedded_device_notified) # noqa self.device_type = self.device.get_friendly_device_type() self.version = int(self.device.get_device_type_version()) self.icons = device.icons self.wan_device = None try: wan_device = self.device.get_embedded_device_by_type( 'WANDevice')[0] self.wan_device = WANDeviceClient(wan_device) except Exception as e: self.warning( "Embedded WANDevice device not available, " "device not implemented properly according " "to the UPnP specification [error: %r]" % e) raise self.info("InternetGatewayDevice %s", self.device.get_friendly_name())
[docs] def remove(self): self.info("removal of InternetGatewayDeviceClient started") if self.wan_device is not None: self.wan_device.remove()
[docs] def embedded_device_notified(self, device): self.info("EmbeddedDevice %r sent notification", device) if self.detection_completed: return self.detection_completed = True # 'Coherence.UPnP.DeviceClient.detection_completed' self.dispatch_event( 'device_client_detection_completed', client=self, udn=self.device.udn)