Class t.w.p.o.BOSConnection(SNACBased):

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

No class docstring

Split Table into Classes Show Methods in One Table

Line # Kind Name Docs
425 Method __init__ Undocumented
435 Method parseUser Undocumented
451 Method oscar_01_05 data for a new service connection
467 Method oscar_01_07 rate paramaters
479 Method oscar_01_10 we've been warned
491 Method oscar_01_13 MOTD
497 Method oscar_02_03 location rights response
504 Method oscar_03_03 buddy list rights response
512 Method oscar_03_0B buddy update
518 Method oscar_03_0C buddy offline
526 Method oscar_04_05 ICBM parms response
532 Method oscar_04_07 ICBM message (instant message)
623 Method oscar_09_03 BOS rights response
631 Method oscar_0B_02 stats reporting interval
637 Method oscar_13_03 SSI rights response
645 Method requestSelfInfo ask for the OSCARUser for ourselves
656 Method initSSI this sends the rate request for family 0x13 (Server Side Information)
666 Method requestSSI request the server side information
722 Method activateSSI active the data stored on the server (use buddy list, permit deny settings, etc.)
728 Method startModifySSI tell the OSCAR server to be on the lookout for SSI modifications
734 Method addItemSSI add an item to the SSI server. if buddyID == 0, then this should be a group.
748 Method modifyItemSSI Undocumented
758 Method delItemSSI Undocumented
768 Method endModifySSI Undocumented
771 Method setProfile set the profile.
785 Method setAway set the away message, or return (if away == None)
794 Method setIdleTime set our idle time. don't call more than once with a non-0 idle time.
800 Method sendMessage send a message to user (not an OSCARUseR).
847 Method connectService connect to another service
863 Method createChat create a chat room
873 Method joinChat join a chat room
886 Method warnUser Undocumented
893 Method getInfo Undocumented
902 Method getAway Undocumented
913 Method initDone called when we get the rate information, which means we should do other init. stuff.
920 Method updateBuddy called when a buddy changes status, with the OSCARUser for that buddy.
927 Method offlineBuddy called when a buddy goes offline
934 Method receiveMessage called when someone sends us a message
940 Method receiveWarning called when someone warns us.
947 Method receiveChatInvite called when someone invites us to a chat room
953 Method chatReceiveMessage called when someone in a chatroom sends us a message in the chat
959 Method chatMemberJoined called when a member joins the chat
965 Method chatMemberLeft called when a member leaves the chat
971 Method receiveSendFileRequest called when someone tries to send a file to us
620 Method _cbGetChatInfoForInvite Undocumented
653 Method _cbRequestSelfInfo Undocumented
663 Method _cbInitSSI Undocumented
674 Method _cbRequestSSI Undocumented
844 Method _cbSendMessageAck Undocumented
860 Method _cbConnectService Undocumented
882 Method _cbJoinChat Undocumented
889 Method _cbWarnUser Undocumented
897 Method _cbGetInfo Undocumented
905 Method _cbGetAway Undocumented

Inherited from SNACBased:

Line # Kind Name Docs
323 Method sendSNAC send a snac and wait for the response by returning a Deferred.
343 Method sendSNACnr send a snac, but don't bother adding a deferred, we don't care.
349 Method oscar_ Undocumented
353 Method oscar_Data Undocumented
370 Method oscar_unknown Undocumented
375 Method oscar_01_03 Undocumented
384 Method oscar_01_0A change of rate information.
391 Method oscar_01_18 host versions, in the same format as we sent
397 Method clientReady called when the client is ready to be online
338 Method _ebDeferredError Undocumented

Inherited from OscarConnection (via SNACBased):

Line # Kind Name Docs
242 Method connectionMade Called when a connection is made.
249 Method connectionLost Called when the connection is shut down.
257 Method sendFLAP Undocumented
267 Method readFlap Undocumented
275 Method dataReceived Called whenever data is received.
289 Method setKeepAlive Undocumented
294 Method sendKeepAlive Undocumented
298 Method stopKeepAlive Undocumented
303 Method disconnect send the disconnect flap, and sever the connection

Inherited from BaseProtocol (via SNACBased, OscarConnection, Protocol):

Line # Kind Name Docs
341 Method makeConnection Make a connection to a transport and a server.
Line # Kind Name Docs
425 Method __init__ Undocumented
722 Method activateSSI active the data stored on the server (use buddy list, permit deny settings, etc.)
734 Method addItemSSI add an item to the SSI server. if buddyID == 0, then this should be a group.
959 Method chatMemberJoined called when a member joins the chat
965 Method chatMemberLeft called when a member leaves the chat
953 Method chatReceiveMessage called when someone in a chatroom sends us a message in the chat
397 Method clientReady called when the client is ready to be online
249 Method connectionLost Called when the connection is shut down.
242 Method connectionMade Called when a connection is made.
847 Method connectService connect to another service
863 Method createChat create a chat room
275 Method dataReceived Called whenever data is received.
758 Method delItemSSI Undocumented
303 Method disconnect send the disconnect flap, and sever the connection
768 Method endModifySSI Undocumented
902 Method getAway Undocumented
893 Method getInfo Undocumented
913 Method initDone called when we get the rate information, which means we should do other init. stuff.
656 Method initSSI this sends the rate request for family 0x13 (Server Side Information)
873 Method joinChat join a chat room
341 Method makeConnection Make a connection to a transport and a server.
748 Method modifyItemSSI Undocumented
927 Method offlineBuddy called when a buddy goes offline
349 Method oscar_ Undocumented
375 Method oscar_01_03 Undocumented
451 Method oscar_01_05 data for a new service connection
467 Method oscar_01_07 rate paramaters
384 Method oscar_01_0A change of rate information.
479 Method oscar_01_10 we've been warned
491 Method oscar_01_13 MOTD
391 Method oscar_01_18 host versions, in the same format as we sent
497 Method oscar_02_03 location rights response
504 Method oscar_03_03 buddy list rights response
512 Method oscar_03_0B buddy update
518 Method oscar_03_0C buddy offline
526 Method oscar_04_05 ICBM parms response
532 Method oscar_04_07 ICBM message (instant message)
623 Method oscar_09_03 BOS rights response
631 Method oscar_0B_02 stats reporting interval
637 Method oscar_13_03 SSI rights response
353 Method oscar_Data Undocumented
370 Method oscar_unknown Undocumented
435 Method parseUser Undocumented
267 Method readFlap Undocumented
947 Method receiveChatInvite called when someone invites us to a chat room
934 Method receiveMessage called when someone sends us a message
971 Method receiveSendFileRequest called when someone tries to send a file to us
940 Method receiveWarning called when someone warns us.
645 Method requestSelfInfo ask for the OSCARUser for ourselves
666 Method requestSSI request the server side information
257 Method sendFLAP Undocumented
294 Method sendKeepAlive Undocumented
800 Method sendMessage send a message to user (not an OSCARUseR).
323 Method sendSNAC send a snac and wait for the response by returning a Deferred.
343 Method sendSNACnr send a snac, but don't bother adding a deferred, we don't care.
785 Method setAway set the away message, or return (if away == None)
794 Method setIdleTime set our idle time. don't call more than once with a non-0 idle time.
289 Method setKeepAlive Undocumented
771 Method setProfile set the profile.
728 Method startModifySSI tell the OSCAR server to be on the lookout for SSI modifications
298 Method stopKeepAlive Undocumented
920 Method updateBuddy called when a buddy changes status, with the OSCARUser for that buddy.
886 Method warnUser Undocumented
860 Method _cbConnectService Undocumented
905 Method _cbGetAway Undocumented
620 Method _cbGetChatInfoForInvite Undocumented
897 Method _cbGetInfo Undocumented
663 Method _cbInitSSI Undocumented
882 Method _cbJoinChat Undocumented
653 Method _cbRequestSelfInfo Undocumented
674 Method _cbRequestSSI Undocumented
844 Method _cbSendMessageAck Undocumented
889 Method _cbWarnUser Undocumented
338 Method _ebDeferredError Undocumented
def __init__(self, username, cookie): (source)
overrides twisted.words.protocols.oscar.SNACBased.__init__
Undocumented
def parseUser(self, data, count=None): (source)
Undocumented
def oscar_01_05(self, snac, d=None): (source)
data for a new service connection d might be a deferred to be called back when the service is ready
def oscar_01_07(self, snac): (source)
rate paramaters
def oscar_01_10(self, snac): (source)
we've been warned
def oscar_01_13(self, snac): (source)
MOTD
def oscar_02_03(self, snac): (source)
location rights response
def oscar_03_03(self, snac): (source)
buddy list rights response
def oscar_03_0B(self, snac): (source)
buddy update
def oscar_03_0C(self, snac): (source)
buddy offline
def oscar_04_05(self, snac): (source)
ICBM parms response
def oscar_04_07(self, snac): (source)
ICBM message (instant message)
def _cbGetChatInfoForInvite(self, info, user, message): (source)
Undocumented
def oscar_09_03(self, snac): (source)
BOS rights response
def oscar_0B_02(self, snac): (source)
stats reporting interval
def oscar_13_03(self, snac): (source)
SSI rights response
def requestSelfInfo(self): (source)
ask for the OSCARUser for ourselves
def _cbRequestSelfInfo(self, snac, d): (source)
Undocumented
def initSSI(self): (source)
this sends the rate request for family 0x13 (Server Side Information) so we can then use it
def _cbInitSSI(self, snac, d): (source)
Undocumented
def requestSSI(self, timestamp=0, revision=0): (source)
request the server side information if the deferred gets None, it means the SSI is the same
def _cbRequestSSI(self, snac, args=()): (source)
Undocumented
def activateSSI(self): (source)
active the data stored on the server (use buddy list, permit deny settings, etc.)
def startModifySSI(self): (source)
tell the OSCAR server to be on the lookout for SSI modifications
def addItemSSI(self, item, groupID=None, buddyID=None): (source)
add an item to the SSI server. if buddyID == 0, then this should be a group. this gets a callback when it's finished, but you can probably ignore it.
def modifyItemSSI(self, item, groupID=None, buddyID=None): (source)
Undocumented
def delItemSSI(self, item, groupID=None, buddyID=None): (source)
Undocumented
def endModifySSI(self): (source)
Undocumented
def setProfile(self, profile): (source)
set the profile. send None to not set a profile (different from '' for a blank one)
def setAway(self, away=None): (source)
set the away message, or return (if away == None)
def setIdleTime(self, idleTime): (source)
set our idle time. don't call more than once with a non-0 idle time.
def sendMessage(self, user, message, wantAck=0, autoResponse=0, offline=0): (source)
send a message to user (not an OSCARUseR). message can be a string, or a multipart tuple. if wantAck, we return a Deferred that gets a callback when the message is sent. if autoResponse, this message is an autoResponse, as if from an away message. if offline, this is an offline message (ICQ only, I think)
def _cbSendMessageAck(self, snac, user, message): (source)
Undocumented
def connectService(self, service, wantCallback=0, extraData=''): (source)
connect to another service if wantCallback, we return a Deferred that gets called back when the service is online. if extraData, append that to our request.
def _cbConnectService(self, snac, d): (source)
Undocumented
def createChat(self, shortName): (source)
create a chat room
def joinChat(self, exchange, fullName, instance): (source)
join a chat room
def _cbJoinChat(self, chat): (source)
Undocumented
def warnUser(self, user, anon=0): (source)
Undocumented
def _cbWarnUser(self, snac): (source)
Undocumented
def getInfo(self, user): (source)
Undocumented
def _cbGetInfo(self, snac): (source)
Undocumented
def getAway(self, user): (source)
Undocumented
def _cbGetAway(self, snac): (source)
Undocumented
def initDone(self): (source)
called when we get the rate information, which means we should do other init. stuff.
def updateBuddy(self, user): (source)
called when a buddy changes status, with the OSCARUser for that buddy.
def offlineBuddy(self, user): (source)
called when a buddy goes offline
def receiveMessage(self, user, multiparts, flags): (source)
called when someone sends us a message
def receiveWarning(self, newLevel, user): (source)
called when someone warns us. user is either None (if it was anonymous) or an OSCARUser
def receiveChatInvite(self, user, message, exchange, fullName, instance, shortName, inviteTime): (source)
called when someone invites us to a chat room
def chatReceiveMessage(self, chat, user, message): (source)
called when someone in a chatroom sends us a message in the chat
def chatMemberJoined(self, chat, member): (source)
called when a member joins the chat
def chatMemberLeft(self, chat, member): (source)
called when a member leaves the chat
def receiveSendFileRequest(self, user, file, description, cookie): (source)
called when someone tries to send a file to us
API Documentation for Twisted, generated by pydoctor at 2008-10-26 16:12:37.