April 2024 - This site, and Kamaelia are being updated. There is significant work needed, and PRs are welcome.
For examples and more explanations, see the module level docs.
LoginHandler(screenname, password, [versionNumber]) -> new
LoginHandler component
Once started, LoginHandler logs in to AIM and sends the primed
connection out of its "signal" outbox.
Keyword arguments:
- versionNumber -- the version of OSCAR protocol we are using. Default
1.
Inboxes
- control : NOT USED
- _clock : Receives timout messages
- inbox : Receives messages from the server
Outboxes
- outbox : Send messages to the server
- signal : Also sends messages to the server
Methods defined here
Warning!
You should be using the inbox/outbox interface, not these methods
(except construction). This documentation is designed as a roadmap as to
their functionalilty for maintainers and new component developers.
__init__(self, screenname, password[,
versionNumber])
x.__init__(...) initializes x; see x.__class__.__doc__ for
signature
activateConnection(self)
Send some parameters up to the server, then signal that we're ready
to begin receiving data.
connectAuth(self)
Connects to the AIM authorization server, says hi, and waits for
acknowledgement.
extractBOSandCookie(self,
reply)
Extracts BOS server, port, and auth cookie from server reply.
getBOSandCookie(self)
Gets BOS and auth cookie.
getCookie(self)
Requests and waits for MD5 key.
getRateLimits(self)
Request rate limits, wait for reply, and send acknowledgement to the
server.
getRights(self)
. Get the server's reply on rights and limitations
main(self)
Gets BOS and auth cookie, negotiates protocol, and then passes the
connection + any non-login-related messages out.
negotiateProtocol(self)
Negotiates protocol.
parseRateInfo(self, data,
numClasses)
Does something useful with the information about rate classes that
the server sends us and returns the acknowledgement we are supposed to
send back to the server.
passTheReins(self)
Unlink the internal OSCARClient and send it to "signal". Also collect
any unused messages from OSCARClient and send them out through
"signal".
reconnect(self, server, port,
cookie)
Discards old connection to authorization server, connects to BOS,
says hi, and waits for acknowledgement.
requestRights(self)
Request that the server tell us our rights and limitations for the
services that were accepted.
setServiceVersions(self)
Waits for supported services list from server, requests service
versions, and waits for server acknowledgement of accepted service
versions.
Feedback
Got a problem with the documentation? Something unclear that could be
clearer? Want to help improve it? Constructive criticism is very welcome
- especially if you can suggest a better rewording!
Please leave you feedback here in reply to the documentation thread in the
Kamaelia blog.
-- Automatic documentation generator, 05 Jun 2009 at 03:01:38
UTC/GMT
