t.m.t.Shell(telnet.Telnet) : class documentation

Part of twisted.manhole.telnet View Source View In Hierarchy

A Python command-line shell.
Method connectionMade I will write a welcomeMessage and loginPrompt to the client.
Method loggedIn Called after the user succesfully logged in.
Method checkUserAndPass Undocumented
Method write Write some data to the transport.
Method telnet_Command The default 'command processing' mode. You probably want to override me.
Method doCommand Undocumented

Inherited from Telnet:

Method welcomeMessage Override me to return a string which will be sent to the client before login.
Method loginPrompt Override me to return a 'login:'-type prompt.
Method iacSBchunk Undocumented
Method iac_DO Undocumented
Method iac_DONT Undocumented
Method iac_WILL Undocumented
Method iac_WONT Undocumented
Method iac_IP Undocumented
Method processLine I call a method that looks like 'telnet_*' where '*' is filled in by the current mode. telnet_* methods should return a string which will become the new mode. If None is returned, the mode will not change.
Method telnet_User No summary
Method telnet_Password I accept a password as an argument, and check it with the checkUserAndPass method. If the login is successful, I call loggedIn().
Method processChunk I take a chunk of data and delegate out to telnet_* methods by way of processLine. If the current mode is 'Done', I'll close the connection.
Method dataReceived Called whenever data is received.

Inherited from Protocol (via Telnet):

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 Telnet, Protocol):

Method makeConnection Make a connection to a transport and a server.
def connectionMade(self): (source)
I will write a welcomeMessage and loginPrompt to the client.
def loggedIn(self): (source)
Called after the user succesfully logged in.

Override in subclasses.

def checkUserAndPass(self, username, password): (source)
Undocumented
def write(self, data): (source)
Write some data to the transport.
def telnet_Command(self, cmd): (source)
The default 'command processing' mode. You probably want to override me.
def doCommand(self, cmd): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2013-04-03 11:20:05.