t.p.i.IdentServer(basic.LineOnlyReceiver) : class documentation

Part of twisted.protocols.ident View Source View In Hierarchy

The Identification Protocol (a.k.a., "ident", a.k.a., "the Ident Protocol") provides a means to determine the identity of a user of a particular TCP connection. Given a TCP port number pair, it returns a character string which identifies the owner of that connection on the server's system.

Server authors should subclass this class and override the lookup method. The default implementation returns an UNKNOWN-ERROR response for every query.
Method lineReceived Override this for when each line is received.
Method invalidQuery Undocumented
Method validQuery Undocumented
Method lookup Lookup user information about the specified address pair.
Method _cbLookup Undocumented
Method _ebLookup Undocumented

Inherited from LineOnlyReceiver:

Method dataReceived Translates bytes into lines, and calls lineReceived.
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.

Inherited from Protocol (via LineOnlyReceiver):

Method connectionLost Called when the connection is shut down.

Inherited from BaseProtocol (via LineOnlyReceiver, Protocol):

Method makeConnection Make a connection to a transport and a server.
Method connectionMade Called when a connection is made.
def lineReceived(self, line): (source)
Override this for when each line is received.
def invalidQuery(self): (source)
def validQuery(self, portOnServer, portOnClient): (source)
def _cbLookup(self, (sysName, userId), sport, cport): (source)
def _ebLookup(self, failure, sport, cport): (source)
def lookup(self, serverAddress, clientAddress): (source)

Lookup user information about the specified address pair.

Return value should be a two-tuple of system name and username. Acceptable values for the system name may be found online at:

This method may also raise any IdentError subclass (or IdentError itself) to indicate user information will not be provided for the given query.

A Deferred may also be returned.
ParametersserverAddressA two-tuple representing the server endpoint of the address being queried. The first element is a string holding a dotted-quad IP address. The second element is an integer representing the port.
clientAddressLike serverAddress, but represents the client endpoint of the address being queried.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.