multi_interface_roam.async_helpers.EventStream Class Reference

Inheritance diagram for multi_interface_roam.async_helpers.EventStream:

List of all members.

Public Member Functions
def	__init__
def	get
def	listen
def	set_discard
def	stop_listen
Public Attributes
	discard
	put
Private Member Functions
def	_put
def	_trigger
Private Attributes
	_invoke_listener
	_queue

---

Detailed Description

Event stream class to be used with select and switch.

Definition at line 51 of file async_helpers.py.

---

Constructor & Destructor Documentation

def multi_interface_roam.async_helpers.EventStream.__init__	(		self,
			event = None
	)

Reimplemented in multi_interface_roam.async_helpers.Timeout, and multi_interface_roam.async_helpers.EventStreamFromDeferred.

Definition at line 53 of file async_helpers.py.

---

Member Function Documentation

def multi_interface_roam.async_helpers.EventStream._put	(		args,
			kwargs
	)		[private]

Puts an element into the queue, and notifies an eventual
listener. Use pop rather than _pop or you will create cycles and
prevent reference counts from going to zero.

Definition at line 61 of file async_helpers.py.

def multi_interface_roam.async_helpers.EventStream._trigger

(

self

)

[private]

Used internally to to trigger the callback.

Definition at line 76 of file async_helpers.py.

def multi_interface_roam.async_helpers.EventStream.get

(

self

)

Pops the next element off the queue.

Definition at line 72 of file async_helpers.py.

def multi_interface_roam.async_helpers.EventStream.listen

(

self

)

Returns a Deferred that will be called the next time an event
arrives, possibly immediately.

Definition at line 81 of file async_helpers.py.

def multi_interface_roam.async_helpers.EventStream.set_discard	(		self,
			discard
	)

Tells the event stream whether it should discard all queued and
incoming events.

Definition at line 96 of file async_helpers.py.

def multi_interface_roam.async_helpers.EventStream.stop_listen

(

self

)

Discards the Deferred set by listen.

Definition at line 91 of file async_helpers.py.

---

Member Data Documentation

multi_interface_roam::async_helpers.EventStream::_invoke_listener [private]

Definition at line 53 of file async_helpers.py.

multi_interface_roam::async_helpers.EventStream::_queue [private]

Definition at line 53 of file async_helpers.py.

multi_interface_roam::async_helpers.EventStream::discard

Definition at line 53 of file async_helpers.py.

multi_interface_roam::async_helpers.EventStream::put

Definition at line 53 of file async_helpers.py.

---

The documentation for this class was generated from the following file:

• async_helpers.py