File: //lib/python3/dist-packages/twisted/words/__pycache__/iwords.cpython-310.pyc
o
�b�! � @ sl d dl mZmZ G dd� de�ZG dd� de�ZG dd� de�ZG dd � d e�ZG d
d � d e�Zg d �Zd
S )� )� Attribute� Interfacec @ s e Zd ZdZed�Zdd� ZdS )�IProtocolPluginz?Interface for plugins providing an interface to a Words servicezHA single word describing what kind of interface this is (eg, irc or web)c C � dS )ab Retrieve a C{twisted.internet.interfaces.IServerFactory} provider
@param realm: An object providing C{twisted.cred.portal.IRealm} and
L{IChatService}, with which service information should be looked up.
@param portal: An object providing C{twisted.cred.portal.IPortal},
through which logins should be performed.
N� )�realm�portalr r �6/usr/lib/python3/dist-packages/twisted/words/iwords.py�
getFactory � zIProtocolPlugin.getFactoryN)�__name__�
__module__� __qualname__�__doc__r �namer
r r r r r s � r c @ sF e Zd Zed�Zdd� Zddd�Zdd� Zd d
� Zd d � Z d
d� Z
dS )�IGroupz$A short string, unique among groups.c C r )zLInclude the given user in this group.
@type user: L{IUser}
Nr )�userr r r �add r z
IGroup.addNc C r )znRemove the given user from this group.
@type user: L{IUser}
@type reason: C{unicode}
Nr )r �reasonr r r �remove# r z
IGroup.removec C r )z�Return the number of participants in this group.
@rtype: L{twisted.internet.defer.Deferred}
@return: A Deferred which fires with an C{int} representing the
number of participants in this group.
Nr r r r r �size* r z IGroup.sizec C r )aY
Broadcast the given message from the given sender to other
users in group.
The message is not re-transmitted to the sender.
@param sender: L{IUser}
@type recipient: L{IGroup}
@param 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.
@param message: C{dict}
@rtype: L{twisted.internet.defer.Deferred}
@return: A Deferred which fires with None when delivery has been
attempted for all users.
Nr ��sender� recipient�messager r r �receive2 r zIGroup.receivec C r )zUChange the metadata associated with this group.
@type meta: C{dict}
Nr )�metar r r � setMetadataG r zIGroup.setMetadatac C r )z.Return an iterator of all users in this group.Nr r r r r � iterusersM r zIGroup.iterusers�N) r r
r r r r r r r r r r r r r r s
r c @ s: e Zd ZdZed�Zdd� Zdd� Zdd� Zd d
d �Z d S )
� IChatClientz<Interface through which IChatService interacts with clients.z[A short string, unique among users. This will be set by the L{IChatService} at login time.c C r )a^
Callback notifying this user of the given message sent by the
given user.
This will be invoked whenever another user sends a message to a
group this user is participating in, or whenever another user sends
a message directly to this user. In the former case, C{recipient}
will be the group to which the message was sent; in the latter, it
will be the same object as the user who is receiving the message.
@type sender: L{IUser}
@type recipient: L{IUser} or L{IGroup}
@type message: C{dict}
@rtype: L{twisted.internet.defer.Deferred}
@return: A Deferred which fires when the message has been delivered,
or which fails in some way. If the Deferred fails and the message
was directed at a group, this user will be removed from that group.
Nr r r r r r X r zIChatClient.receivec C r )z�
Callback notifying this user that the metadata for the given
group has changed.
@type group: L{IGroup}
@type meta: C{dict}
@rtype: L{twisted.internet.defer.Deferred}
Nr )�groupr r r r �groupMetaUpdatem r zIChatClient.groupMetaUpdatec C r )z�
Callback notifying this user that the given user has joined
the given group.
@type group: L{IGroup}
@type user: L{IUser}
@rtype: L{twisted.internet.defer.Deferred}
Nr )r! r r r r �
userJoinedx r zIChatClient.userJoinedNc C r )a
Callback notifying this user that the given user has left the
given group for the given reason.
@type group: L{IGroup}
@type user: L{IUser}
@type reason: C{unicode}
@rtype: L{twisted.internet.defer.Deferred}
Nr )r! r r r r r �userLeft� r zIChatClient.userLeftr )
r r
r r r r r r" r# r$ r r r r r Q s � r c @ s` e Zd ZdZed�Zed�Zed�Zed�Zed�Z dd� Z
d d
� Z d d � Z d
d� Z
dd� ZdS )�IUserz;Interface through which clients interact with IChatService.z_A reference to the Realm to which this user belongs. Set if and only if the user is logged in.z`A reference to the mind which logged in to this user. Set if and only if the user is logged in.z#A short string, unique among users.zRA POSIX timestamp indicating the time of the last message received from this user.zBA POSIX timestamp indicating this user's most recent sign on time.c C r )z�Invoked by the associated L{IChatService} when login occurs.
@param realm: The L{IChatService} through which login is occurring.
@param mind: The mind object used for cred login.
Nr )r �mindr r r �loggedIn� r zIUser.loggedInc C r )z�Send the given message to the given user or group.
@type recipient: Either L{IUser} or L{IGroup}
@type message: C{dict}
Nr )r r r r r �send� r z
IUser.sendc C r )z|Attempt to join the given group.
@type group: L{IGroup}
@rtype: L{twisted.internet.defer.Deferred}
Nr �r! r r r �join� r z
IUser.joinc C r )z�Discontinue participation in the given group.
@type group: L{IGroup}
@rtype: L{twisted.internet.defer.Deferred}
Nr r) r r r �leave� r z IUser.leavec C r )zZ
Return an iterator of all groups of which this user is a
member.
Nr r r r r �
itergroups� r zIUser.itergroupsN)r r
r r r r r& r � lastMessage�signOnr' r( r* r+ r, r r r r r% � s( ���� r% c @ sT e Zd Zed�Zed�Zed�Zdd� Zdd� Zdd � Z d
d � Z
d d
� Z dd� Z dS )� IChatServicez=A short string identifying this chat service (eg, a hostname)zxA boolean indicating whether L{getGroup} should implicitly create groups which are requested but which do not yet exist.zvA boolean indicating whether L{getUser} should implicitly create users which are requested but which do not yet exist.c C r )z�Return all groups available on this service.
@rtype: C{twisted.internet.defer.Deferred}
@return: A Deferred which fires with a list of C{IGroup} providers.
Nr r r r r r, � r zIChatService.itergroupsc C r )a� Retrieve the group by the given name.
@type name: C{str}
@rtype: L{twisted.internet.defer.Deferred}
@return: A Deferred which fires with the group with the given
name if one exists (or if one is created due to the setting of
L{IChatService.createGroupOnRequest}, or which fails with
L{twisted.words.ewords.NoSuchGroup} if no such group exists.
Nr �r r r r �getGroup� r zIChatService.getGroupc C r )a2 Create a new group with the given name.
@type name: C{str}
@rtype: L{twisted.internet.defer.Deferred}
@return: A Deferred which fires with the created group, or
with fails with L{twisted.words.ewords.DuplicateGroup} if a
group by that name exists already.
Nr r0 r r r � createGroup� r zIChatService.createGroupc C r )aE Retrieve a group by name.
Unlike C{getGroup}, this will never implicitly create a group.
@type name: C{str}
@rtype: L{twisted.internet.defer.Deferred}
@return: A Deferred which fires with the group by the given
name, or which fails with L{twisted.words.ewords.NoSuchGroup}.
Nr r0 r r r � lookupGroup� r zIChatService.lookupGroupc C r )a� Retrieve the user by the given name.
@type name: C{str}
@rtype: L{twisted.internet.defer.Deferred}
@return: A Deferred which fires with the user with the given
name if one exists (or if one is created due to the setting of
L{IChatService.createUserOnRequest}, or which fails with
L{twisted.words.ewords.NoSuchUser} if no such user exists.
Nr r0 r r r �getUser� r zIChatService.getUserc C r )a. Create a new user with the given name.
@type name: C{str}
@rtype: L{twisted.internet.defer.Deferred}
@return: A Deferred which fires with the created user, or
with fails with L{twisted.words.ewords.DuplicateUser} if a
user by that name exists already.
Nr r0 r r r �
createUser r zIChatService.createUserN)
r r
r r r �createGroupOnRequest�createUserOnRequestr, r1 r2 r3 r4 r5 r r r r r/ � s �� r/ )r r r% r/ N) �zope.interfacer r r r r r% r/ �__all__r r r r �<module> s 7?5 O