Class t.w.p.t.TOCClient(protocol.Protocol):

Part of twisted.words.protocols.toc View Source View In Hierarchy

Known subclasses: twisted.words.im.tocsupport.TOCProto

No class docstring

Split Table into Classes Show Methods in One Table

Line # Kind Name Docs
783 Method __init__ Undocumented
805 Method sendFlap Undocumented
818 Method isFlap tests to see if a flap is actually on the buffer
830 Method readFlap Undocumented
843 Method connectionMade Called when a connection is made.
847 Method connectionLost Called when the connection is shut down.
851 Method dataReceived Called whenever data is received.
858 Method modeSendNick Undocumented
867 Method modeData Undocumented
894 Method tocUNKNOWN Undocumented
897 Method tocSIGN_ON Undocumented
904 Method tocNICK Handle a message that looks like:
912 Method tocCONFIG Handle a message that looks like:
950 Method tocIM_IN Handle a message that looks like:
961 Method tocUPDATE_BUDDY Handle a message that looks like:
976 Method tocERROR Handle a message that looks like:
985 Method tocEVILED Handle a message that looks like:
993 Method tocCHAT_JOIN Handle a message that looks like:
1003 Method tocCHAT_UPDATE_BUDDY Handle a message that looks like:
1018 Method tocCHAT_IN Handle a message that looks like:
1032 Method tocCHAT_INVITE Handle a message that looks like:
1040 Method tocCHAT_LEFT Handle a message that looks like:
1050 Method tocRVOUS_PROPOSE Handle a message that looks like:
1073 Method tocSEND_FILE Undocumented
1086 Method tocGET_FILE Undocumented
1092 Method onLine called when we are first online
1098 Method gotConfig called when we get a configuration from the server
1108 Method hearError called when an error is received
1116 Method hearWarning called when we get warned
1124 Method hearMessage called when you receive an IM
1133 Method updateBuddy called when a buddy changes state
1146 Method chatJoined we just joined a chat room
1155 Method chatUpdate a user has joined the room
1164 Method chatHearMessage a message was sent to the room
1173 Method chatHearWhisper someone whispered to us in a chatroom
1182 Method chatInvited we were invited to a chat room
1192 Method chatLeft we left the room
1199 Method rvousProposal we were asked for a rondevouz
1211 Method receiveBytes we received part of a file from a file transfer
1221 Method isaway return our away status
1227 Method set_config set the server configuration
1247 Method add_buddy Undocumented
1254 Method del_buddy Undocumented
1261 Method add_permit Undocumented
1277 Method del_permit Undocumented
1287 Method add_deny Undocumented
1303 Method del_deny Undocumented
1314 Method signon called to finish the setup, and signon to the network
1321 Method say send a message
1332 Method idle change idle state
1339 Method evil warn a user
1347 Method away change away state
1357 Method chat_join join a chat room
1366 Method chat_say send a message to a chatroom
1374 Method chat_whisper whisper to another user in a chatroom
1383 Method chat_leave leave a chat room.
1390 Method chat_invite invite a user[s] to the chat room
1406 Method chat_accept accept an invite to a chat room
1413 Method rvous_accept Undocumented
1420 Method rvous_cancel Undocumented
802 Method _debug Undocumented

Inherited from BaseProtocol (via Protocol):

Line # Kind Name Docs
341 Method makeConnection Make a connection to a transport and a server.
Line # Kind Name Docs
783 Method __init__ Undocumented
1247 Method add_buddy Undocumented
1287 Method add_deny Undocumented
1261 Method add_permit Undocumented
1347 Method away change away state
1406 Method chat_accept accept an invite to a chat room
1390 Method chat_invite invite a user[s] to the chat room
1357 Method chat_join join a chat room
1383 Method chat_leave leave a chat room.
1366 Method chat_say send a message to a chatroom
1374 Method chat_whisper whisper to another user in a chatroom
1164 Method chatHearMessage a message was sent to the room
1173 Method chatHearWhisper someone whispered to us in a chatroom
1182 Method chatInvited we were invited to a chat room
1146 Method chatJoined we just joined a chat room
1192 Method chatLeft we left the room
1155 Method chatUpdate a user has joined the room
847 Method connectionLost Called when the connection is shut down.
843 Method connectionMade Called when a connection is made.
851 Method dataReceived Called whenever data is received.
1254 Method del_buddy Undocumented
1303 Method del_deny Undocumented
1277 Method del_permit Undocumented
1339 Method evil warn a user
1098 Method gotConfig called when we get a configuration from the server
1108 Method hearError called when an error is received
1124 Method hearMessage called when you receive an IM
1116 Method hearWarning called when we get warned
1332 Method idle change idle state
1221 Method isaway return our away status
818 Method isFlap tests to see if a flap is actually on the buffer
341 Method makeConnection Make a connection to a transport and a server.
867 Method modeData Undocumented
858 Method modeSendNick Undocumented
1092 Method onLine called when we are first online
830 Method readFlap Undocumented
1211 Method receiveBytes we received part of a file from a file transfer
1413 Method rvous_accept Undocumented
1420 Method rvous_cancel Undocumented
1199 Method rvousProposal we were asked for a rondevouz
1321 Method say send a message
805 Method sendFlap Undocumented
1227 Method set_config set the server configuration
1314 Method signon called to finish the setup, and signon to the network
1018 Method tocCHAT_IN Handle a message that looks like:
1032 Method tocCHAT_INVITE Handle a message that looks like:
993 Method tocCHAT_JOIN Handle a message that looks like:
1040 Method tocCHAT_LEFT Handle a message that looks like:
1003 Method tocCHAT_UPDATE_BUDDY Handle a message that looks like:
912 Method tocCONFIG Handle a message that looks like:
976 Method tocERROR Handle a message that looks like:
985 Method tocEVILED Handle a message that looks like:
1086 Method tocGET_FILE Undocumented
950 Method tocIM_IN Handle a message that looks like:
904 Method tocNICK Handle a message that looks like:
1050 Method tocRVOUS_PROPOSE Handle a message that looks like:
1073 Method tocSEND_FILE Undocumented
897 Method tocSIGN_ON Undocumented
894 Method tocUNKNOWN Undocumented
961 Method tocUPDATE_BUDDY Handle a message that looks like:
1133 Method updateBuddy called when a buddy changes state
802 Method _debug Undocumented
def __init__(self, username, password, authhost='login.oscar.aol.com', authport=5190): (source)
overridden in twisted.words.im.tocsupport.TOCProto
Undocumented
def _debug(self, data): (source)
overridden in twisted.words.im.tocsupport.TOCProto
Undocumented
def sendFlap(self, type, data): (source)
Undocumented
def isFlap(self): (source)
tests to see if a flap is actually on the buffer
def readFlap(self): (source)
Undocumented
def connectionMade(self): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.BaseProtocol.connectionMade

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 connectionLost(self, reason): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.Protocol.connectionLost

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.
Parametersreason (type: twisted.python.failure.Failure )
def dataReceived(self, data): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.Protocol.dataReceived

Called whenever data is received.

Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.
Parametersdataa string of indeterminate length. Please keep in mind that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.
def modeSendNick(self, flap): (source)
Undocumented
def modeData(self, flap): (source)
Undocumented
def tocUNKNOWN(self, command, data): (source)
Undocumented
def tocSIGN_ON(self, data): (source)
Undocumented
def tocNICK(self, data): (source)
overridden in twisted.words.im.tocsupport.TOCProto
Handle a message that looks like: 
   NICK:<format of nickname>
def tocCONFIG(self, data): (source)
Handle a message that looks like: 
   CONFIG:<config>
Format of config data:
  • g: group. all users until next g or end of config are in this group
  • b: buddy
  • p: person on the permit list
  • d: person on the deny list
  • m: permit/deny mode (1: permit all, 2: deny all, 3: permit some, 4: deny some)
def tocIM_IN(self, data): (source)
Handle a message that looks like: 
   IM_IN:<user>:<autoreply T|F>:message
def tocUPDATE_BUDDY(self, data): (source)
Handle a message that looks like: 
   UPDATE_BUDDY:<username>:<online T|F>:<warning level>:<signon time>:<idle time (minutes)>:<user class>
def tocERROR(self, data): (source)
Handle a message that looks like: 
   ERROR:<error code>:<misc. data>
def tocEVILED(self, data): (source)
Handle a message that looks like: 
   EVILED:<current warning level>:<user who warned us>
def tocCHAT_JOIN(self, data): (source)
Handle a message that looks like: 
   CHAT_JOIN:<room id>:<room name>
def tocCHAT_UPDATE_BUDDY(self, data): (source)
Handle a message that looks like: 
   CHAT_UPDATE_BUDDY:<room id>:<in room? T/F>:<user 1>:<user 2>...
def tocCHAT_IN(self, data): (source)
Handle a message that looks like: 
   CHAT_IN:<room id>:<username>:<whisper T/F>:<message>
whisper isn't used
def tocCHAT_INVITE(self, data): (source)
Handle a message that looks like: 
   CHAT_INVITE:<room name>:<room id>:<username>:<message>
def tocCHAT_LEFT(self, data): (source)
Handle a message that looks like: 
   CHAT_LEFT:<room id>
def tocRVOUS_PROPOSE(self, data): (source)
Handle a message that looks like: 
   RVOUS_PROPOSE:<user>:<uuid>:<cookie>:<seq>:<rip>:<pip>:<vip>:<port>
         [:tlv tag1:tlv value1[:tlv tag2:tlv value2[:...]]]
def tocSEND_FILE(self, user, cookie, seq, pip, vip, port, tlvs): (source)
Undocumented
def tocGET_FILE(self, user, cookie, seq, pip, vip, port, tlvs): (source)
Undocumented
def onLine(self): (source)
overridden in twisted.words.im.tocsupport.TOCProto
called when we are first online
def gotConfig(self, mode, buddylist, permit, deny): (source)
overridden in twisted.words.im.tocsupport.TOCProto
called when we get a configuration from the server mode := permit/deny mode buddylist := current buddylist permit := permit list deny := deny list
def hearError(self, code, args): (source)
overridden in twisted.words.im.tocsupport.TOCProto
called when an error is received code := error code args := misc. arguments (username, etc.)
def hearWarning(self, newamount, username): (source)
overridden in twisted.words.im.tocsupport.TOCProto
called when we get warned newamount := the current warning level username := the user who warned us, or '' if it's anonymous
def hearMessage(self, username, message, autoreply): (source)
overridden in twisted.words.im.tocsupport.TOCProto
called when you receive an IM username := the user who the IM is from message := the message autoreply := true if the message is an autoreply from an away message
def updateBuddy(self, username, online, evilness, signontime, idletime, userclass, away): (source)
overridden in twisted.words.im.tocsupport.TOCProto
called when a buddy changes state username := the user whos state changed online := true if the user is online evilness := the users current warning level signontime := the time the user signed on (UNIX epoch) idletime := the time the user has been idle (minutes) away := true if the user is away userclass := the class of the user (generally " O")
def chatJoined(self, roomid, roomname, users): (source)
overridden in twisted.words.im.tocsupport.TOCProto
we just joined a chat room roomid := the AIM id for the room roomname := the name for the room users := a list of the users already in the room
def chatUpdate(self, roomid, username, inroom): (source)
overridden in twisted.words.im.tocsupport.TOCProto
a user has joined the room roomid := the AIM id for the room username := the username inroom := true if the user is in the room
def chatHearMessage(self, roomid, username, message): (source)
overridden in twisted.words.im.tocsupport.TOCProto
a message was sent to the room roomid := the AIM id for the room username := the user who sent the message message := the message
def chatHearWhisper(self, roomid, username, message): (source)
overridden in twisted.words.im.tocsupport.TOCProto
someone whispered to us in a chatroom roomid := the AIM for the room username := the user who whispered to us message := the message
def chatInvited(self, roomid, roomname, username, message): (source)
overridden in twisted.words.im.tocsupport.TOCProto
we were invited to a chat room roomid := the AIM id for the room roomname := the name of the room username := the user who invited us message := the invite message
def chatLeft(self, roomid): (source)
overridden in twisted.words.im.tocsupport.TOCProto
we left the room roomid := the AIM id for the room
def rvousProposal(self, type, cookie, user, vip, port, **kw): (source)
overridden in twisted.words.im.tocsupport.TOCProto
we were asked for a rondevouz type := the type of rondevous. currently, one of ["send"] cookie := the cookie. pass this to rvous_accept() user := the user who asked us vip := their verified_ip port := the port they want us to conenct to kw := misc. args
def receiveBytes(self, user, file, chunk, sofar, total): (source)
overridden in twisted.words.im.tocsupport.TOCProto
we received part of a file from a file transfer file := the name of the file chunk := the chunk of data sofar := how much data we've gotten so far total := the total amount of data
def isaway(self): (source)
return our away status
def set_config(self, mode, buddylist, permit, deny): (source)
set the server configuration mode := permit mode buddylist := buddy list permit := permit list deny := deny list
def add_buddy(self, buddies): (source)
Undocumented
def del_buddy(self, buddies): (source)
Undocumented
def add_permit(self, users): (source)
Undocumented
def del_permit(self, users): (source)
Undocumented
def add_deny(self, users): (source)
Undocumented
def del_deny(self, users): (source)
Undocumented
def signon(self): (source)
called to finish the setup, and signon to the network
def say(self, user, message, autoreply=0): (source)
send a message user := the user to send to message := the message autoreply := true if the message is an autoreply (good for away messages)
def idle(self, idletime=0): (source)
change idle state idletime := the seconds that the user has been away, or 0 if they're back
def evil(self, user, anon=0): (source)
warn a user user := the user to warn anon := if true, an anonymous warning
def away(self, message=''): (source)
change away state message := the message, or '' to come back from awayness
def chat_join(self, exchange, roomname): (source)
join a chat room exchange := should almost always be 4 roomname := room name
def chat_say(self, roomid, message): (source)
send a message to a chatroom roomid := the AIM id for the room message := the message to send
def chat_whisper(self, roomid, user, message): (source)
whisper to another user in a chatroom roomid := the AIM id for the room user := the user to whisper to message := the message to send
def chat_leave(self, roomid): (source)
leave a chat room. roomid := the AIM id for the room
def chat_invite(self, roomid, usernames, message): (source)
invite a user[s] to the chat room roomid := the AIM id for the room usernames := either a string (one username) or a list (more than one) message := the message to invite them with
def chat_accept(self, roomid): (source)
accept an invite to a chat room roomid := the AIM id for the room
def rvous_accept(self, cookie): (source)
Undocumented
def rvous_cancel(self, cookie): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2008-10-26 16:12:37.