mudsock
index
(built-in)

Contains the Python wrapper for sockets, and utilities for listing
currently connected sockets.

 
Classes
       
__builtin__.object
Mudsock

 
class Mudsock(__builtin__.object)
    Python Socket object
 
  Methods defined here:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
aux(...)
Alias for mudsock.Mudsock.getAuxiliary
bust_prompt(...)
bust_prompt()
 
Busts the socket's prompt so it will be displayed next pulse.
close(...)
close()
 
Closes the socket's connection.
edit_text(...)
edit_text(dflt_value, on_complete, mode='text')
 
Enter the text editor, and set its default value. When the text editor
is edited, call on_complete. This function should take two arguments:
the socket doing the editing, and the output of the editor. Mode can
be 'text' or 'script'.
getAuxiliary(...)
getAuxiliary(name)
 
Returns socket's auxiliary data of the specified name.
pop_ih(...)
pop_ih()
 
Pops the socket's current input handler from its input handler stack.
push_ih(...)
push_ih(handler_func, prompt_func, state=None)
 
Pushes a new input handler and prompt pair onto the socket's input
handler stack. Optionally, a (String) state value can be supplied.
Input handlers take two arguments: the socket and a string command.
Prompts take one argument: the socket. They should send the relevant
text for the prompt to the socket.
replace_ih(...)
repalce_ih(handler_func, prompt_func, state=None)
 
Calls pop_ih, followed by push_ih.
send(...)
send(mssg, dict = None, newline = True)
 
Sends message to the socket. Messages can have scripts embedded in
them, using [ and ]. If so, a variable dictionary must be provided. By
default, 'me' references the socket being sent the message.
send_raw(...)
send_raw(mssg)
 
Sends text to the socket. No appended newline.
start_compress(...)
start_compress(type)
 
Start MCCP/MCCP2 compression.

Data descriptors defined here:
account
The account currently attached to the socket, or None. Immutable.
see mudsys.attach_account_socket for connecting sockets and accounts.
can_use
True or False if the socket is ready for use. Socket becomes available
after its dns addresss resolves. Immutable.
ch
Alias for mudsock.Mudsock.character.
char
Alias for mudsock.Mudsock.character
character
The character currently attached to the socket, on None. Immutable.
see mudsys.attach_char_socket for connecting characters to account.
has_input
True or False if the socket has any input pending. Immutable.
hostname
The dns address that the socket is connected from. Immutable.
idle_time
How long (in seconds) the socket's input handler has been idle for. Immutable.
inbound_text
The socket's inbound text.
outbound_text
The socket's outbound text.
state
The state that the socket is in. Immutable. For more on states see
mudsock.Mudsock.push_ih
uid
The socket's uid. Immutable.

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

 
Functions
       
socket_list(...)
socket_list()
 
Returns a list of all sockets currently connected.