class documentation
class Router: (source)
XMPP Server's Router.
A router connects the different components of the XMPP service and routes messages between them based on the given routing table.
Connected components are trusted to have correct addressing in the stanzas they offer for routing.
A route destination of None
adds a default route. Traffic for which no specific route exists, will be routed to this default route.
Present Since | |
8.2 |
Method | __init__ |
Undocumented |
Method | add |
Add a new route. |
Method | remove |
Remove a route. |
Method | route |
Route a stanza. |
Instance Variable | routes |
Routes based on the host part of JIDs. Maps host names to the EventDispatcher s that should receive the traffic. A key of None means the default route. |
Add a new route.
The passed XML Stream xs will have an observer for all stanzas added to route its outgoing traffic. In turn, traffic for destination will be passed to this stream.
Parameters | |
destination:str or None . | Destination of the route to be added as a host name or None for the default route. |
xs:EventDispatcher . | XML Stream to register the route for. |
Remove a route.
Parameters | |
destination:str. | Destination of the route that should be removed. |
xs:EventDispatcher . | XML Stream to remove the route for. |
Routes based on the host part of JIDs. Maps host names to the EventDispatcher
s that should receive the traffic. A key of None
means the default route.