Trees       Indices       Help   
Package flumotion :: Package component :: Package common :: Package fgdp :: Module protocol :: Class FGDPClient_0_1
[hide private]

Class FGDPClient_0_1

source code

                                        object --+    
                                                 |    
                                          FGDP_0_1 --+
                                                     |
twisted.internet.protocol.BaseProtocol --+           |
                                         |           |
        twisted.internet.protocol.Protocol --+       |
                                             |       |
   twisted.protocols.basic._PauseableMixin --+       |
                                             |       |
          twisted.protocols.basic.LineReceiver --+   |
                                                 |   |
                       extern.log.log.Loggable --+   |
                                                 |   |
                                  FGDPBaseProtocol --+
                                                     |
                                                    FGDPClient_0_1

Implementation of the client-side FGDP protocol for version 0.1

Instance Methods [hide private]
 
__init__(self, gstElement)
x.__init__(...) initializes x; see help(type(x)) for signature		 source code
 
startProtocol(self)
Subclasses must implement this method to start the protocol after a new connection has been made		 source code
 
stopProtocol(self, reason)
Subclasses must implement this method to stop the protocol after the connection has been closed		 source code
 
lineReceived(self, line)
Subclasess must implement this method to process the messages of the line-based protocol		 source code
 
_checkState(self, response) source code
 
_login(self) source code
 
_authenticate(self, response) source code
 
_startStreaming(self) source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Inherited from FGDPBaseProtocol: connectionLost, connectionMade, loseConnection, makeConnection

Inherited from FGDPBaseProtocol (private): _delegateFD, _disconnectFD, _makeHash, _sendMessage

Inherited from twisted.protocols.basic.LineReceiver: clearLineBuffer, dataReceived, lineLengthExceeded, rawDataReceived, sendLine, setLineMode, setRawMode

Inherited from twisted.internet.protocol.Protocol: __provides__, logPrefix

Inherited from twisted.internet.protocol.BaseProtocol: __providedBy__

Inherited from twisted.protocols.basic._PauseableMixin: pauseProducing, resumeProducing, stopProducing

Inherited from extern.log.log.Loggable: debug, doLog, error, info, log, logFunction, logObjectName, warning, warningFailure, writeMarker

Class Variables [hide private]
  logCategory = 'fgdp-client'
Implementors can provide a category to log their messages under.
  CLIENT_STATE_DISCONNECTED = 'disconnected'
  CLIENT_STATE_LOGIN = 'login'
  CLIENT_STATE_AUTHENTICATING = 'authenticate'
hash(x)
  CLIENT_STATE_CONNECTED = 'connected'
  _version = (0, 1)
  _state = 'disconnected'

Inherited from FGDP_0_1: AUTH_COMMAND, CHALLENGE_RESPONSE, ERROR_RESPONSE, LOGIN_COMMAND, OK_RESPONSE

Inherited from FGDPBaseProtocol (private): _fd, _gstElement, _password, _transport, _user

Inherited from twisted.protocols.basic.LineReceiver: MAX_LENGTH, delimiter, line_mode

Inherited from twisted.protocols.basic.LineReceiver (private): _buffer, _busyReceiving

Inherited from twisted.internet.protocol.Protocol: __implemented__

Inherited from twisted.internet.protocol.BaseProtocol: connected, transport

Inherited from twisted.protocols.basic._PauseableMixin: paused

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, gstElement)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: FGDPBaseProtocol.__init__

startProtocol(self)

source code 

Subclasses must implement this method to start the protocol after a new connection has been made

Overrides: FGDPBaseProtocol.startProtocol
(inherited documentation)

stopProtocol(self, reason)

source code 

Subclasses must implement this method to stop the protocol after the connection has been closed

Overrides: FGDPBaseProtocol.stopProtocol
(inherited documentation)

lineReceived(self, line)

source code 

Subclasess must implement this method to process the messages of the line-based protocol

Parameters:
  • line - The line which was received with the delimiter removed.
Overrides: twisted.protocols.basic.LineReceiver.lineReceived
(inherited documentation)

   Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Mon May 11 00:19:24 2015 http://epydoc.sourceforge.net