Package brisa :: Package core :: Module network_listeners :: Class NetworkListener
[hide private]
[frames] | no frames]

Class NetworkListener

source code

object --+
         |
        NetworkListener

Network listener abstract class. Forwards data to multiple subscribed observers and can have a single callback to get data forwarded to.

Methods that MUST be implemented by an inheriting class:

observers and the data callback run() method MUST call self.forward_data(data, addr). Note that addr is optional.

Instance Methods [hide private]
 
__init__(self, observers=[], data_callback=None)
Constructor for the NetworkListener class
source code
 
forward_data(self, data, addr='')
Forwards data to the subscribed observers and to the data callback.
source code
 
subscribe(self, observer)
Subscribes an observer for data forwarding.
source code
 
is_listening(self)
Returns whether this network listener is listening (already started with start()).
source code
 
is_running(self)
Same as is_listening().
source code
 
start(self) source code
 
stop(self) source code
 
_cleanup(self)
Removes references to other classes, in order to make GC easier
source code
 
destroy(self) source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, observers=[], data_callback=None)
(Constructor)

source code 

Constructor for the NetworkListener class

Parameters:
  • observers (list) - initial subscribers for data forwarding
  • data_callback (callable) - callback that gets data forwarded to
Overrides: object.__init__

forward_data(self, data, addr='')

source code 

Forwards data to the subscribed observers and to the data callback.

Parameters:
  • data (string) - raw data to be forwarded
  • addr (None or tuple) - can be a 2-tuple (host, port)

subscribe(self, observer)

source code 

Subscribes an observer for data forwarding.

Parameters:
  • observer (INetworkObserver) - observer instance