Home | Trees | Index | Help |
---|
|
beepy
core
channel
: Channel related code
constants
: Constant definitions for BEEPy.
errors
: Customised exceptions used throughout BEEPy.
frame
: BEEPy Framing classes and related code.
saslsession
: Specialised classes for SASL operation of sessions.
session
: This module defines the Session layer API for BEEPy.
tlssession
: Specialised Session subclasses for TLS capabilities.
profiles
beepmgmtprofile
: This module implements the BEEP Management profile.
echoprofile
: EchoProfile implements an example profile that simply echoes back
whatever the content of a frame is.
message
: This module defines a BEEP Management message, used on Channel 0 of
all sessions.
mgmtcreator
: The BEEP Management Profile XML Creator
mgmtparser
: The BEEP Management Profile XML Parser.
profile
: This module defines the basic Profile class and related code.
reverbprofile
: ReverbProfile is an extended example of the EchoServer that echos back
multiple frames.
saslanonymousprofile
: This module implements the SASL ANONYMOUS mechanism as a BEEPy
profile.
saslotpprofile
: This module implements the SASL OTP (One Time Password) mechanism as a
BEEPy profile.
saslprofile
timeprofile
: TimeProfile implements an example profile that sends the current time
to the remote peer every second.
tlsprofile
transports
__builtin__.object
:
The most base type
__builtin__.type
:
type(object) -> the object's type type(name, bases, dict) -> a
new type
beepy.core.channel.Channel
:
A Channel object is an abstraction of a BEEP channel running over some
form of transport.
beepy.core.frame.Frame
:
A Frame is a basic abstraction defined by RFC3080.
beepy.core.frame.DataFrame
:
A DataFrame is the basic unit of data used by BEEP to transport
information around.
beepy.core.frame.SEQFrame
:
SEQFrames are objects that represent the SEQ frames used in RFC3081
for the TCP mapping of BEEP.
beepy.core.session.Session
:
A Session is the main entity relating to a BEEP peer connection.
beepy.core.session.Initiator
:
An Initiator is a Session that initiates a connection to a
ListenerManager and then communicates with the resulting Listener.
beepy.transports.tcp.BeepClientProtocol
:
This class is mostly identical to the base class, but clients only use
odd numbered channels
beepy.core.saslsession.SASLInitiator
:
A SASL capable Initiator
beepy.transports.tcp.SASLClientProtocol
:
SASL Client Protocol
beepy.core.tlssession.TLSInitiator
:
A TLSInitiator is an Initiator that uses TLS for transport
security.
beepy.transports.tls.TLSClientProtocol
:
A TLS Client Protocol
beepy.core.session.Listener
:
A Listener is a Session that is the result of a connection to a
ListenerManager.
beepy.transports.tcp.BeepServerProtocol
:
Basic server protocol
beepy.core.saslsession.SASLListener
:
A SASL capable Listener
beepy.transports.tcp.SASLServerProtocol
:
SASL Server Protocol
beepy.core.tlssession.TLSListener
:
A TLSListener is a Listener that uses TLS for transport security.
beepy.transports.tls.TLSServerProtocol
:
A TLS Server Protocol
beepy.core.saslsession.SASLSession
:
A base Session subclass used for SASL sessions.
beepy.core.saslsession.SASLInitiator
:
A SASL capable Initiator
beepy.transports.tcp.SASLClientProtocol
:
SASL Client Protocol
beepy.core.saslsession.SASLListener
:
A SASL capable Listener
beepy.transports.tcp.SASLServerProtocol
:
SASL Server Protocol
beepy.core.tlssession.TLSSession
:
A TLSSession is a specialised type of Session used for TLS over a
transport.
beepy.core.tlssession.TLSInitiator
:
A TLSInitiator is an Initiator that uses TLS for transport
security.
beepy.transports.tls.TLSClientProtocol
:
A TLS Client Protocol
beepy.core.tlssession.TLSListener
:
A TLSListener is a Listener that uses TLS for transport security.
beepy.transports.tls.TLSServerProtocol
:
A TLS Server Protocol
beepy.profiles.message.Message
:
The Message class defines a BEEP Management message object.
beepy.profiles.mgmtcreator.Creator
:
A Creator object is used to create management messages.
beepy.profiles.mgmtparser.Parser
:
A Parser object takes in string encodings of XML documents that
represent a BEEP Management message
beepy.profiles.profile.Profile
:
The profile class is the base class for all BEEP profile classes.
beepy.profiles.beepmgmtprofile.BEEPManagementProfile
:
The BEEPManagementProfile is used on Channel 0 for all Sessions to
control the management of the Session and all channels on it.
beepy.profiles.echoprofile.EchoProfile
:
A very basic example profile that just echos frames.
beepy.profiles.reverbprofile.ReverbProfile
beepy.profiles.saslprofile.SASLProfile
:
This is an abstract class to provide the core SASL Profile API
beepy.profiles.saslanonymousprofile.SASLAnonymousProfile
:
A SASLAnonymousProfile is a SASL Profile that implements the ANONYMOUS
mechanism for anonymous authentication.
beepy.profiles.saslotpprofile.SASLOTPProfile
:
A SASLOTPProfile is a SASL Profile that implements the OTP mechanism
for one time password authentication.
beepy.profiles.timeprofile.TimeProfile
:
A very basic example profile that just echos frames.
beepy.profiles.tlsprofile.TLSProfile
:
A TLSProfile is a profile that implements the TLS Transport Security
Profile.
beepy.profiles.profile.ProfileDict
:
a ProfileDict is a specialised dictionary for managing profiles known
by a Session.
beepy.profiles.saslotpprofile.OTPDictionary
:
The OTPDictionary contains a list of 'words' used to encode
bytestrings into a human readable form that's easy to memorise and
respond to.
beepy.profiles.saslotpprofile.OTPUserEntry
:
This class defines the values that are required for a user entry in an
OTP database.
beepy.profiles.saslotpprofile.OTPdbase
:
This is a Mixin class to provide standard OTP database access
methods.
beepy.profiles.saslotpprofile.OTPGenerator
:
An OTPGenerator provides the methods required to generate One Time
Passwords.
beepy.transports.base.Factory
:
A factory starts Protocols when initiated
beepy.transports.base.ClientFactory
:
A ClientFactory initiates protocol connections to a remote server.
beepy.transports.base.ServerFactory
:
A ServerFactory starts protocols when a connection is received from a
client.
beepy.transports.base.LineReceiver
:
A LineReceiver reads data one line at a time
beepy.transports.base.Reason
beepy.transports.base.ConnectionDone
:
Used when connection terminates normally.
beepy.transports.base.SelectReactor
:
A reactor manages the main looping part of a client or server
beepy.transports.base.TCPTransport
beepy.transports.tcp.BeepFactory
beepy.transports.tcp.BeepClientFactory
:
This class is the base class for all application clients.
beepy.transports.tcp.BeepServerFactory
beepy.transports.tcp.ReconnectingBeepClientFactory
:
An alternative BeepClientFactory that will attempt to reconnect to a
server automatically.
beepy.transports.tcp.SEQBuffer
:
A SEQ buffer is a data object that holds the current state of a
channel buffer.
exceptions.Exception
:
Common base class for all exceptions.
beepy.core.errors.BEEPException
beepy.core.channel.ChannelException
beepy.profiles.mgmtcreator.CreatorException
:
Exception raised if there's an error creating a message.
beepy.core.frame.FrameException
:
The base exception used for all framing exceptions
beepy.core.frame.DataFrameException
:
An Exception class used for DataFrame specific exceptions.
beepy.core.frame.SEQFrameException
:
A FrameException relating specifically to SEQ Frames.
beepy.profiles.message.MessageException
:
A base class for all Message exceptions.
beepy.profiles.message.MessageInvalid
:
Raised whenever a message fails validation.
beepy.profiles.mgmtparser.ParserException
:
Exception raised if there are any errors during parsing of XML
data.
beepy.profiles.profile.ProfileDictException
beepy.profiles.profile.ProfileException
beepy.transports.tcp.ProtocolError
beepy.core.session.SessionException
:
Base exception class for Sessions.
beepy.core.session.ChannelZeroOutOfSequence
:
Raised if channel 0 ever gets out of sequence.
beepy.core.session.SessionInboundQueueFull
:
Used when the session's inbound message queue is full.
beepy.core.session.SessionOutboundQueueFull
:
Used when the session's outbound message queue is full.
beepy.core.session.TerminateException
:
Raised when a session encounters an error that should result in the
session being terminated/dropped.
beepy.core.tlssession.TLSSessionException
beepy.core.session.TuningReset
:
Raised when a tuning reset should occur.
logging.Filterer
:
A base class for loggers and handlers which allows them to share
common code.
logging.Logger
:
Instances of the Logger class represent a single logging channel.
twisted.internet.protocol.Factory
:
This is a factory which produces protocols.
twisted.internet.protocol.ClientFactory
:
A Protocol factory for clients.
beepy.transports.tcp.BeepClientFactory
:
This class is the base class for all application clients.
twisted.internet.protocol.ReconnectingClientFactory
:
My clients auto-reconnect with an exponential back-off.
beepy.transports.tcp.ReconnectingBeepClientFactory
:
An alternative BeepClientFactory that will attempt to reconnect to a
server automatically.
twisted.internet.protocol.ServerFactory
:
Subclass this to indicate that your protocol.Factory is only usable
for servers.
twisted.internet.ssl.ContextFactory
:
A factory for SSL context objects, for server SSL connections.
beepy.transports.tls.ClientTLSContext
twisted.internet.ssl.DefaultOpenSSLContextFactory
beepy.transports.tls.ServerTLSContext
:
A default TLS context factory to use for TLS connections
Home | Trees | Index | Help |
---|
Generated by Epydoc 2.0 on Thu Sep 30 14:39:26 2004 | http://epydoc.sf.net |