twisted.protocols.amp._DescriptorExchanger : API documentation

_DescriptorExchanger is a mixin for BinaryBoxProtocol which adds support for receiving file descriptors, a feature offered by IUNIXTransport.

Method	__init__	Undocumented
Method	fileDescriptorReceived	Collect received file descriptors to be claimed later by `Descriptor`.
Instance Variable	_descriptors	Temporary storage for all file descriptors received. Values in this dictionary are the file descriptors (as integers). Keys in this dictionary are ordinals giving the order in which each descriptor was received. The ordering information is used to allow `Descriptor` to determine which is the correct descriptor for any particular usage of that argument type. (type: `dict`)
Instance Variable	_sendingDescriptorCounter	A no-argument callable which returns the ordinals, starting from 0. This is used to construct values for `_sendFileDescriptor`.
Instance Variable	_receivingDescriptorCounter	A no-argument callable which returns the ordinals, starting from 0. This is used to construct values for `fileDescriptorReceived`.
Method	_sendFileDescriptor	Assign and return the next ordinal to the given descriptor after sending the descriptor over this protocol's transport.

_descriptors =

Temporary storage for all file descriptors received. Values in this dictionary are the file descriptors (as integers). Keys in this dictionary are ordinals giving the order in which each descriptor was received. The ordering information is used to allow Descriptor to determine which is the correct descriptor for any particular usage of that argument type. (type: dict)

_sendingDescriptorCounter =

A no-argument callable which returns the ordinals, starting from 0. This is used to construct values for _sendFileDescriptor.

_receivingDescriptorCounter =

A no-argument callable which returns the ordinals, starting from 0. This is used to construct values for fileDescriptorReceived.

def __init__(self): (source)

overridden in twisted.protocols.amp.BinaryBoxProtocol

Undocumented

def _sendFileDescriptor(self, descriptor): (source)

Assign and return the next ordinal to the given descriptor after sending the descriptor over this protocol's transport.

def fileDescriptorReceived(self, descriptor): (source)

from twisted.internet.interfaces.IFileDescriptorReceiver

Collect received file descriptors to be claimed later by Descriptor.

Parameters descriptor The received file descriptor. (type: int)

twisted.protocols.amp._DescriptorExchanger(object) class documentation

`twisted.protocols.amp._DescriptorExchanger(object)` class documentation