twisted.spread.pb.Broker(banana.Banana)
class documentationtwisted.spread.pb
View Source
(View In Hierarchy)
Known subclasses: twisted.mail.pb.MaildirBroker, twisted.mail.pb.MaildirClient
I am a broker for objects.
Method | __init__ | Undocumented |
Method | resumeProducing | Called when the consumer attached to me runs out of buffer. |
Method | pauseProducing | Undocumented |
Method | stopProducing | Undocumented |
Method | registerPageProducer | Undocumented |
Method | expressionReceived | Evaluate an expression as it's received. |
Method | proto_version | Protocol message: (version version-number) |
Method | sendCall | Utility method to send an expression to the other side of the connection. |
Method | proto_didNotUnderstand | Respond to stock 'didNotUnderstand ' message. |
Method | connectionReady | Initialize. Called after Banana negotiation is done. |
Method | connectionFailed | Undocumented |
Method | connectionLost | The connection was lost. |
Method | notifyOnDisconnect | |
Method | notifyOnFail | |
Method | notifyOnConnect | |
Method | dontNotifyOnDisconnect | |
Method | localObjectForID | Get a local object for a locally unique ID. |
Method | registerReference | Store a persistent reference to a local object and map its id() to a generated, session-unique ID. |
Method | setNameForLocal | Store a special (string) ID for this object. |
Method | remoteForName | Returns an object from the remote name mapping. |
Method | cachedRemotelyAs | No summary |
Method | remotelyCachedForLUID | |
Method | cacheRemotely | XXX |
Method | cacheLocally | (internal) |
Method | cachedLocallyAs | Undocumented |
Method | serialize | Jelly an object according to the remote security rules for this broker. |
Method | unserialize | Unjelly an sexp according to the local security rules for this broker. |
Method | newLocalID | |
Method | newRequestID | |
Method | proto_message | Undocumented |
Method | proto_cachemessage | Undocumented |
Method | proto_answer | (internal) Got an answer to a previously sent message. |
Method | proto_error | (internal) Deal with an error. |
Method | sendDecRef | (internal) Send a DECREF directive. |
Method | proto_decref | (internal) Decrement the reference count of an object. |
Method | decCacheRef | (internal) Send a DECACHE directive. |
Method | proto_decache | (internal) Decrement the reference count of a cached object. |
Method | proto_uncache | (internal) Tell the client it is now OK to uncache an object. |
Method | _sendMessage | Undocumented |
Method | _recvMessage | Received a message-send. |
Method | _sendAnswer | (internal) Send an answer to a previously sent message. |
Method | _sendFailureOrError | Call _sendError
or _sendFailure ,
depending on whether fail represents an Error subclass or
not. |
Method | _sendFailure | Log error and then send it. |
Method | _sendError | (internal) Send an error for a previously sent message. |
Inherited from Banana:
Instance Variable | knownDialects | These are the profiles supported by this Banana implementation. (type: list
of bytes ) |
Method | setPrefixLimit | Set the prefix limit for decoding done by this protocol instance. |
Method | callExpressionReceived | Undocumented |
Method | connectionMade | Called when a connection is made. |
Method | gotItem | Undocumented |
Method | dataReceived | Called whenever data is received. |
Method | sendEncoded | Send the encoded representation of the given object: |
Method | _selectDialect | Undocumented |
Method | _encode | Undocumented |
Inherited from Protocol (via Banana):
Method | logPrefix | Return a prefix matching the class name, to identify log messages related to this protocol instance. |
Inherited from BaseProtocol (via Banana, Protocol):
Method | makeConnection | Make a connection to a transport and a server. |
Inherited from Ephemeral (via Banana):
Method | __reduce__ | Serialize any subclass of Ephemeral
in a way which replaces it with Ephemeral
itself. |
Method | __getstate__ | Undocumented |
Method | __setstate__ | Undocumented |
Protocol message: (version version-number)
Check to make sure that both ends of the protocol are speaking the same version dialect.
Parameters | vnum | The version number. |
Utility method to send an expression to the other side of the connection.
Parameters | exp | The expression. |
Respond to stock 'didNotUnderstand
' message.
Log the command that was not understood and continue. (Note: this will probably be changed to close the connection or raise an exception in the future.)
Parameters | command | The command to log. |
The connection was lost.
Parameters | reason | message to put in failure.Failure |
Parameters | notifier | callback to call when the Broker disconnects. |
Parameters | notifier | callback to call if the Broker fails to connect. |
Parameters | notifier | callback to call when the Broker connects. |
Parameters | notifier | callback to remove from list of disconnect callbacks. |
Get a local object for a locally unique ID.
Returns | An object previously stored with registerReference
or None
if there is no object which corresponds to the given identifier. |
Store a persistent reference to a local object and map its id() to a generated, session-unique ID.
Parameters | object | a local object |
Returns | the generated ID |
Store a special (string) ID for this object.
This is how you specify a 'base' set of objects that the remote protocol can connect to.
Parameters | name | An ID. |
object | The object. |
Returns an object from the remote name mapping.
Note that this does not check the validity of the name, only creates a translucent reference for it.
Parameters | name | The name to look up. |
Returns | An object which maps to the name. |
Parameters | instance | The instance to look up. |
incref | Flag to specify whether to increment the reference. | |
Returns | An ID that says what this instance is cached as remotely, or None
if it's not. |
Parameters | luid | The LUID to look up. |
Returns | An instance which is cached remotely. |
(internal)
Store a non-filled-out cached instance locally.
Jelly an object according to the remote security rules for this broker.
Parameters | object | The object to jelly. |
perspective | The perspective. | |
method | The method. | |
args | Arguments. | |
kw | Keyword arguments. |
Unjelly an sexp according to the local security rules for this broker.
Parameters | sexp | The object to unjelly. |
perspective | The perspective. |
Received a message-send.
Look up message based on object, unserialize the arguments, and invoke it with args, and send an 'answer' or 'error' response.
Parameters | findObjMethod | A callable which takes objectID as argument. |
requestID | The requiest ID. | |
objectID | The object ID. | |
message | The message. | |
answerRequired | ||
netArgs | Arguments. | |
netKw | Keyword arguments. |
(internal) Send an answer to a previously sent message.
Parameters | netResult | The answer. |
requestID | The request ID. |
(internal) Got an answer to a previously sent message.
Look up the appropriate callback and call it.
Parameters | requestID | The request ID. |
netResult | The answer. |
Call _sendError
or _sendFailure
,
depending on whether fail
represents an Error
subclass or
not.
Parameters | fail | The failure. |
requestID | The request ID. |
Log error and then send it.
Parameters | fail | The failure. |
requestID | The request ID. |
(internal) Send an error for a previously sent message.
Parameters | fail | The failure. |
requestID | The request ID. |
(internal) Deal with an error.
Parameters | requestID | The request ID. |
fail | The failure. |
(internal) Send a DECREF directive.
Parameters | objectID | The object ID. |
(internal) Decrement the reference count of an object.
If the reference count is zero, it will free the reference to this object.
Parameters | objectID | The object ID. |
(internal) Send a DECACHE directive.
Parameters | objectID | The object ID. |
(internal) Decrement the reference count of a cached object.
If the reference count is zero, free the reference, then send an 'uncached' directive.
Parameters | objectID | The object ID. |
(internal) Tell the client it is now OK to uncache an object.
Parameters | objectID | The object ID. |