net.SocketCommunicator

Module net :: Class SocketCommunicator

[show private | hide private]

Class SocketCommunicator

The SocketCommunicator handles all incoming and outgoing data from and to the mud, telnet control codes, and some data transformations.

Method Summary
	`__init__(self)`
	`__repr__(self)`
	`connect(self, host, port, sessionname)` Takes in a host and a port and connects the socket.
	`handleData(self, data)` Handles incoming data from the mud.
string	`handleNego(self, data)` Removes telnet negotiation stuff from the stream and handles it.
	`logControl(self, str)`
	`run(self)` Polls a socket and returns any data sitting there.
	`setSession(self, ses)` Sets the local session.
	`setSessionName(self, name)` Sets the session name.
	`shutdown(self)` Shuts down the thread polling the socket connection and the socket as well.
	`write(self, data, convert)` Writes data to the mud.

Method Details

connect(self, host, port, sessionname)

Takes in a host and a port and connects the socket.

Parameters:: host - the host to connect to
(type=string); port - the port to connect at
(type=int); sessionname - the name of the new session
(type=string)

handleData(self, data)

Handles incoming data from the mud. We wrap it in a MudEvent and toss it on the queue.

Parameters:: data - the incoming data from the mud
(type=string)

handleNego(self, data)

Removes telnet negotiation stuff from the stream and handles it.

Parameters:: data - the incoming data from the mud that we need to parse for telnet control code stuff
(type=string)

Returns:: the data without the telnet control codes
(type=string)

run(self)

Polls a socket and returns any data sitting there.

setSession(self, ses)

Sets the local session. Each SocketCommunicator is matched up with a Session object. This sets the Session object for this SocketCommunicator so we know who to pass information from the mud off to.

Parameters:: ses - the session to set
(type=Session)

setSessionName(self, name)

Sets the session name.

Parameters:: name - the new session name
(type=string)

shutdown(self)

Shuts down the thread polling the socket connection and the socket as well.

write(self, data, convert=1)

Writes data to the mud.

Parameters:: data - the data to write to the socket
(type=string); convert - whether (1) or not (0) we should convert eol stuff to CRLF and IAC to IAC IAC.
(type=boolean)

Raises:: Exception - if we have problems sending the data over the socket

Generated by Epydoc 1.1 on Mon Apr 28 21:11:25 2003

http://epydoc.sf.net