class documentation

class twisted.protocols.postfix.PostfixTCPMapServer(basic.LineReceiver, policies.TimeoutMixin): (source)

View In Hierarchy

Postfix mail transport agent TCP map protocol implementation.

Receive requests for data matching given key via lineReceived, asks it's factory for the data with self.factory.get(key), and returns the data to the requester. None means no entry found.

You can use postfix's postmap to test the map service:


/usr/sbin/postmap -q KEY tcp:localhost:4242

Class Variable timeout Undocumented
Class Variable delimiter Undocumented
Method connectionMade Called when a connection is made.
Method sendCode Send an SMTP-like code with a message.
Method lineReceived Override this for when each line is received.
Method do_get Undocumented
Method do_put Undocumented
Method _cbNot Undocumented
Method _cbGot Undocumented

Inherited from LineReceiver:

Class Variable MAX_LENGTH The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384.
Instance Variable line_mode Undocumented
Method clearLineBuffer Clear buffered data.
Method dataReceived Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method setLineMode Sets the line-mode of this receiver.
Method setRawMode Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
Method rawDataReceived Override this for when raw data is received.
Method sendLine Sends a line to the other end of the connection.
Method lineLengthExceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Instance Variable _buffer Undocumented
Instance Variable _busyReceiving Undocumented

Inherited from Protocol (via LineReceiver):

Class Variable factory Undocumented
Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.
Method connectionLost Called when the connection is shut down.

Inherited from BaseProtocol (via LineReceiver, Protocol):

Instance Variable connected Undocumented
Instance Variable transport Undocumented
Method makeConnection Make a connection to a transport and a server.

Inherited from _PauseableMixin (via LineReceiver):

Instance Variable paused Undocumented
Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented

Inherited from TimeoutMixin:

Instance Variable timeOut The number of seconds after which to timeout the connection.
Method callLater Wrapper around reactor.callLater for test purpose.
Method resetTimeout Reset the timeout count down.
Method setTimeout Change the timeout period
Method timeoutConnection Called when the connection times out.
Instance Variable __timeoutCall Undocumented
Method __timedOut Undocumented
timeout = (source)

Undocumented

(type: int)
delimiter = (source)

Undocumented

(type: bytes)
def connectionMade(self): (source)

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.

def sendCode(self, code, message=b''): (source)

Send an SMTP-like code with a message.

def lineReceived(self, line): (source)

Override this for when each line is received.

ParameterslineThe line which was received with the delimiter removed. (type: bytes)
def do_get(self, key): (source)

Undocumented

def _cbNot(self, fail): (source)

Undocumented

def _cbGot(self, value): (source)

Undocumented

def do_put(self, keyAndValue): (source)

Undocumented

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.