class PBGroupReference(pb.RemoteReference): (source)
Implements interfaces: twisted.words.iwords.IGroup
Undocumented
| Method | unjellyFor |
Unjelly myself for the jellier. |
| Instance Variable | name |
A short string, unique among groups. |
| Method | leave |
Undocumented |
| Method | send |
Undocumented |
| Method | add |
Include the given user in this group. |
| Method | iterusers |
Return an iterator of all users in this group. |
| Method | receive |
Broadcast the given message from the given sender to other users in group. |
| Method | remove |
Remove the given user from this group. |
| Method | setMetadata |
Change the metadata associated with this group. |
| Method | size |
Return the number of participants in this group. |
Inherited from RemoteReference:
| Instance Variable | broker |
The broker I am obtained through. |
| Method | __init__ |
(internal) Initialize me with a broker and a locally-unique ID. |
| Instance Variable | luid |
Undocumented |
| Instance Variable | doRefCount |
Undocumented |
| Instance Variable | perspective |
Undocumented |
| Instance Variable | disconnectCallbacks |
Undocumented |
| Method | notifyOnDisconnect |
Register a callback to be called if our broker gets disconnected. |
| Method | dontNotifyOnDisconnect |
Remove a callback that was registered with notifyOnDisconnect. |
| Method | jellyFor |
If I am being sent back to where I came from, serialize as a local backreference. |
| Method | callRemote |
Asynchronously invoke a remote method. |
| Method | remoteMethod |
|
| Method | __cmp__ |
|
| Method | __hash__ |
Hash me. |
| Method | __del__ |
Do distributed reference counting on finalization. |
| Method | _disconnected |
Called if we are disconnected and have callbacks registered. |
Inherited from Serializable (via RemoteReference):
| Method | processUniqueID |
Return an ID which uniquely represents this object for this process. |
Inherited from Jellyable (via RemoteReference, Serializable):
| Method | getStateFor |
Undocumented |
Inherited from Ephemeral (via RemoteReference):
| Method | __reduce__ |
Serialize any subclass of Ephemeral in a way which replaces it with Ephemeral itself. |
| Method | __getstate__ |
Undocumented |
| Method | __setstate__ |
Undocumented |
| Instance Variable | __class__ |
Undocumented |
Unjelly myself for the jellier.
| Parameters | unjellier | Undocumented |
| unjellyList | Undocumented | |
| jellier | A stateful object which exists for the lifetime of a single call to unjelly. | |
| jellyList | The list which represents the jellied state of the object to be unjellied. | |
| Returns | The object which results from unjellying. | |
Broadcast the given message from the given sender to other users in group.
The message is not re-transmitted to the sender.
| Parameters | sender | IUser |
| recipient | This is probably a wart. Maybe it will be removed in the future. For now, it should be the group object the message is being delivered to. (type: IGroup) | |
| message | dict | |
| Returns | A Deferred which fires with None when delivery has been attempted for all users. (type: twisted.internet.defer.Deferred) | |
Remove the given user from this group.
| Parameters | user | Undocumented (type: IUser) |
| reason | Undocumented (type: unicode) |
Return the number of participants in this group.
| Returns | A Deferred which fires with an int representing the number of participants in this group. (type: twisted.internet.defer.Deferred) | |