Skip to content

Commit 33722a0

Browse files
Improve documentation of the BaseManager.get_participants() method
1 parent f298c9b commit 33722a0

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/socketio/base_manager.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,13 @@ def get_namespaces(self):
2929
return self.rooms.keys()
3030

3131
def get_participants(self, namespace, room):
32-
"""Return an iterable with the active participants in a room."""
32+
"""Return an iterable with the active participants in a room.
33+
34+
Note that in a multi-server scenario this method only returns the
35+
participants connect to the server in which the method is called. There
36+
is currently no functionality to assemble a complete list of users across
37+
multiple servers.
38+
"""
3339
ns = self.rooms.get(namespace, {})
3440
if hasattr(room, '__len__') and not isinstance(room, str):
3541
participants = ns[room[0]]._fwdm.copy() if room[0] in ns else {}

0 commit comments

Comments
 (0)