beepy.transports.tcp.BeepClientProtocol

Package beepy :: Package transports :: Module tcp :: Class BeepClientProtocol

[show private | hide private]

Class BeepClientProtocol

BaseProtocol --+            
               |            
        Protocol --+        
                   |        
        LineReceiver --+    
                       |    
            BeepProtocol --+
                           |
             Session --+   |
                       |   |
               Initiator --+
                           |
                          BeepClientProtocol

This class is mostly identical to the base class, but clients only use odd numbered channels

Method Summary
	`greetingReceived(self)` This is a callback from the management profile to trigger processing once the connection greeting is received from the remote end.
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 BaseProtocol
	`makeConnection(self, transport)` Make a connection to a transport and a server.
Inherited from Initiator
	`setStartingChannelNum(self)` Initiators only start odd numbered channels.
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.
	`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.
	`_channelClosedError(self, channelnum, code, desc)` Internal channel closure error handling
	`_channelClosedSuccess(self, channelnum)` Internal channel closure method.
	`_flushChannelOutbound(self)` This method gets all pending messages from all channels one at a time and places them on the Session Outbound Queue.
	`_getActiveChannel(self, channelnum)` This method provides a way of getting the channel object by number.
	`_getChannelZeroProfile(self)` Deprecated.
	`_handleGreeting(self)` A greeting may be received in two circumstances:
	`_isChannelError(self, channelnum)` Checks to see if the channel has encountered an error condition.
	`_reset(self)` reset() does a tuning reset which closes all channels and terminates the session.
	`_setID(self, sessId)`
	`_showInternalState(self)`

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).
`str`	`_LineReceiver__buffer` = `''`
Inherited from Protocol
`tuple`	`__implements__` = `(<class 'twisted.internet.interfaces.IP...`
Inherited from BaseProtocol
`int`	`connected` = 0
`NoneType`	`transport` = None

Method Details

greetingReceived(self)

This is a callback from the management profile to trigger processing once the connection greeting is received from the remote end. Servers don't really do anything with this, but it's important for clients.

Overrides:: beepy.core.session.Session.greetingReceived (inherited documentation)

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

http://epydoc.sf.net