class documentation

class 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

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

Inherited from LineReceiver:

Method clearLineBuffer Clear buffered data.
Method dataReceived Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method lineLengthExceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Method rawDataReceived Override this for when raw data is received.
Method sendLine Sends a line to the other end of the connection.
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.
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
Instance Variable _buffer Undocumented
Instance Variable _busyReceiving Undocumented

Inherited from Protocol (via LineReceiver):

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

Inherited from BaseProtocol (via LineReceiver, Protocol):

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

Inherited from _PauseableMixin (via LineReceiver):

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

Inherited from TimeoutMixin:

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 timeOut The number of seconds after which to timeout the connection.
Method __timedOut Undocumented
Instance Variable __timeoutCall Undocumented
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 do_get(self, key): (source)


def do_put(self, keyAndValue): (source)


def lineReceived(self, line): (source)
Override this for when each line is received.
line:bytesThe line which was received with the delimiter removed.
def sendCode(self, code, message=b''): (source)
Send an SMTP-like code with a message.
timeout: int = (source)


def _cbGot(self, value): (source)


def _cbNot(self, fail): (source)