Package beepy :: Package core :: Module session :: Class Listener
[show private | hide private]
[frames | no frames]

Class Listener

Session --+
          |
         Listener

Known Subclasses:
BeepServerProtocol, SASLListener, TLSListener

A Listener is a Session that is the result of a connection to a ListenerManager. It is the server side of a client/server connection. An Initiator would form the client side.
Method Summary
  setStartingChannelNum(self)
Listeners only start even numbered channels.
    Inherited from Session
  __init__(self)
Create a new 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.
  close(self)
  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.
  createTransportChannel(self, channelnum)
This method should be overridden at the transport layer if there is any special work that needs to be done at channel create time.
  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.
  _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)

Method Details

setStartingChannelNum(self)

Listeners only start even numbered channels.
Overrides:
beepy.core.session.Session.setStartingChannelNum

Generated by Epydoc 2.0 on Thu Sep 30 14:39:26 2004 http://epydoc.sf.net