twisted.spread.pb._PortalWrapper(Referenceable, _JellyableAvatarMixin) class documentation

Part of twisted.spread.pb View Source (View In Hierarchy)

Root Referenceable object, used to login to portal.

Method __init__ Undocumented
Method remote_login Start of username/password login.
Method remote_loginAnonymous Attempt an anonymous login.

Inherited from Referenceable:

Method remoteMessageReceived A remote message has been received. Dispatch it appropriately.
Method jellyFor (internal)

Inherited from Serializable (via Referenceable):

Method processUniqueID Return an ID which uniquely represents this object for this process.

Inherited from Jellyable (via Referenceable, Serializable):

Method getStateFor Undocumented

Inherited from _JellyableAvatarMixin:

Method _cbLogin Ensure that the avatar to be returned to the client is jellyable and set up disconnection notification to call the realm's logout object.
def __init__(self, portal, broker): (source)
Undocumented
def remote_login(self, username): (source)

Start of username/password login.

ParametersusernameThe username.
def remote_loginAnonymous(self, mind): (source)

Attempt an anonymous login.

ParametersmindAn object to use as the mind parameter to the portal login call (possibly None).
ReturnsA Deferred which will be called back with an avatar when login succeeds or which will be errbacked if login fails somehow. (type: Deferred)
API Documentation for Twisted, generated by pydoctor at 2017-09-23 19:45:03.