beepy.transports.tcp.SASLClientProtocol

Package beepy :: Package transports :: Module tcp :: Class SASLClientProtocol

[show private | hide private]

Class SASLClientProtocol

BaseProtocol --+            
               |            
        Protocol --+        
                   |        
        LineReceiver --+    
                       |    
            BeepProtocol --+
                           |
         Session --+       |
                   |       |
           Initiator --+   |
                       |   |
         Session --+   |   |
                   |   |   |
         SASLSession --+   |
                       |   |
           SASLInitiator --+
                           |
                          SASLClientProtocol

SASL Client Protocol

Method Summary
Inherited from BeepProtocol
	`__init__(self)`
	`close(self)`
	`connectionLost(self, reason)`
	`connectionMade(self)` Called when a connection is made.
	`createTransportChannel(self, channelnum)` Performs transport specific channel creation
	`deleteTransportChannel(self, channelnum)` Performs transport specific channel deletion
	`doSEQFrame(self)`
	`findFrame(self)` Search for a frame in the databuffer.
	`flushDatabuf(self, channelnum)`
	`processQueuedData(self)` This method examines the local data queues to see if there is pending data that didn't fit within a window for a given channel.
	`processSEQFrame(self, theframe)` Perform window size management for inbound SEQ frames.
	`rawDataReceived(self, data)` Override this for when raw data is received.
	`sendFrame(self, theframe)` sendFrame is used to push frames over the transport.
	`sendMessage(self, msg, channelnum)` sendMessage is used to send a Message as one or more Frames over the transport.
	`sendMsgComplete(self, channelnum, msg)` Send the final frame in a sequence of fragments.
	`sendMsgFragment(self, channelnum, msg)` Send a message fragment by setting the continuation indicator for the frame.
	`sendSEQFrame(self, channelnum)` This is the simplest tuning.
Inherited from LineReceiver
	`clearLineBuffer(self)` Clear buffered data.
	`dataReceived(self, data)` Protocol.dataReceived.
	`lineLengthExceeded(self, line)` Called when the maximum line length has been reached.
	`lineReceived(self, line)` Override this for when each line is received.
	`sendLine(self, line)` Sends a line to the other end of the connection.
	`setLineMode(self, extra)` Sets the line-mode of this receiver.
	`setRawMode(self)` Sets the raw mode of this receiver.
Inherited from Protocol
	`connectionFailed(self)` (Deprecated)
Inherited from Initiator
	`setStartingChannelNum(self)` Initiators only start odd numbered channels.
Inherited from SASLSession
	`authenticationFailed(self, errorCode, errorReason)`
	`authenticationSucceeded(self)`
	`authentidRequested(self)` This is a callback that should be overloaded in servers or clients for when authentication information is required.
	`useridRequested(self)` This is a callback that should be overloaded in servers or client for when authentication information is required.
Inherited from Session
	`channelClosedError(self, channelnum, code, desc)` What to do if a channel close fails
	`channelClosedSuccess(self, channelnum)` Override this method to receive notification of channel closure
	`channelStarted(self, channelnum, uri)` Action to take when a positive RPY to a channel start message is received.
	`channelStartedError(self, channelnum)` Action to take when a negative RPY to a channel start message is received.
	`closeAllChannels(self)` Attempts to close all channels on this Session
	`closeChannel(self, channelnum)` requestCloseChannel() attempts to close a channel.
	`createChannel(self, channelnum, profile)` Creates a new channel with the given channel number and binds the given profile to it for processing.
	`createChannelFromURIList(self, channelnum, uriList, profileInit)` Attempts to create a channel given a list of possible profiles to bind to the channel.
	`createChannelZero(self)` Create the Channel 0 for the Session.
	`deleteAllChannels(self)` Attempt to delete all channels on the session
	`deleteChannel(self, channelnum)` Delete a single channel from the Session
	`getChannel(self, channelnum)` Get the channel object associated with a given channelnum
	`getChannelState(self, channelnum)` Get the state of a particular channel.
	`getProfileDict(self)` Returns this session's profile dictionary.
	`greetingReceived(self)` This is a callback from the management profile to trigger processing once the connection greeting is received from the remote end.
	`isChannelActive(self, channelnum)` This method provides a way of figuring out if a channel is running.
	`newChannel(self, profile, chardata, encoding)` Attempt to start a new Channel with a given profile.
	`processFrame(self, theframe)` Allocate a given frame to the channel it belongs to and call the channel's processing method.
	`receivedAnswer(self, frame)` Use this callback from your profiles to communicate with your apps when an ANS frame is received.
	`receivedMessage(self, frame)` Use this callback from your profiles to communicate with your apps when a MSG frame is received.
	`shutdown(self)` Attempts to close all the channels in a session before closing down the session itself.
	`shutdownComplete(self)` Called when the Session has completed its shutdown
	`startChannel(self, profileList)` startChannel() attempts to start a new channel for communication.
	`tuningBegin(self)` Called by a profile when a tuning reset process begins.
	`tuningReset(self)` A tuning reset causes all channels, including channel Zero to be closed and a new channel zero to be created, with a new greeting sent.

Class Variable Summary
Inherited from LineReceiver
`str`	`delimiter`: The line-ending delimiter to use.
`int`	`line_mode` = 1
`int`	`MAX_LENGTH`: The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped).
Inherited from Protocol
`tuple`	`__implements__` = `(<class 'twisted.internet.interfaces.IP...`
Inherited from SASLSession
`NoneType`	`authentid` = None
`NoneType`	`userid` = None

Generated by Epydoc 2.0 on Thu Sep 30 14:39:25 2004

http://epydoc.sf.net