def getUserId(self):
"""
@return: {integer} mcs user id
@see: mcs.IGCCConfig
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "getUserId", "IGCCConfig"))
def getGCCServerSettings(self):
"""
@return: {gcc.Settings} mcs layer gcc server settings
@see: mcs.IGCCConfig
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "getGCCServerSettings", "IGCCConfig"))
def onCutText(self, text):
"""
@summary: Receive cut text from server
@param text: text inner cut text event
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "onCutText", "RFBClientListener"))
def GSS_UnWrapEx(self, data):
"""
@summary: decrypt data with key exchange in Authentication protocol
@param data: {str}
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "GSS_UnWrapEx", "IGenericSecurityService"))
def update(self, render, force=False):
"""
Update view
@param render: IRender
@param force: force update
"""
raise CallPureVirtualFuntion("%s:%s defined by interface %s" %
(self.__class__, "update", "IView"))
def getChannelId(self):
"""
@return: {integer} return channel id of proxy
@see: mcs.IGCCConfig
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "getChannelId", "IGCCConfig"))
def translate(self, dx, dy):
"""
Translate next render
@param dx: delta x
@param dy: delta y
"""
raise CallPureVirtualFuntion("%s:%s defined by interface %s" %
(self.__class__, "translate", "IRender"))
def buildRawLayer(self, addr):
"""
@summary: Override this function to build raw layer
@param addr: destination address
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "recv", "IStreamListener"))
def recv(self, s):
"""
@summary: Signal that data is available
@param s: Stream
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "recv", "IStreamListener"))
def onCutText(self, text):
"""
@summary: event when server send cut text event
@param text: text received
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "onCutText", "RFBClientObserver"))
def buildRawLayer(self, addr):
"""
@summary: Override this function to build raw layer
@param addr: destination address
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "buildRawLayer", "RawLayerClientFactory"))
def sendWheelEvent(self, e):
"""
@summary: Interface to send wheel event to protocol stack
@param e: QWheelEvent
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "sendWheelEvent", "QAdaptor"))
def getEncodedCredentials(self):
"""
@summary: return encoded credentials accorded with authentication protocol nego
@return: (domain, username, password)
"""
raise CallPureVirtualFuntion("%s:%s defined by interface %s" %
(self.__class__, "getEncodedCredentials",
"IAuthenticationProtocol"))
def onReady(self):
"""
@summary: Stack is ready and connected
May be called after an setColorDepth too
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "onReady", "RDPServerObserver"))
def closeEvent(self, e):
"""
@summary: Call when you want to close connection
@param: QCloseEvent
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "closeEvent", "QAdaptor"))
def onSlowPathInput(self, slowPathInputEvents):
"""
@summary: Event call when slow path input are available
@param slowPathInputEvents: [data.SlowPathInputEvent]
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "onSlowPathInput", "PDUServerListener"))
def onUpdate(self, rectangles):
"""
@summary: call when a bitmap data is received from update PDU
@param rectangles: [pdu.BitmapData] struct
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "onUpdate", "PDUClientListener"))
def getNegotiateMessage(self):
"""
@summary: Client first handshake message for authentication protocol
@return: {object} first handshake message
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "getNegotiateMessage", "IAuthenticationProtocol"))
def sendFastPath(self, secFlag, fastPathS):
"""
@summary: Send fastPathS Type as fast path packet
@param secFlag: {integer} Security flag for fastpath packet
@param fastPathS: {Type | Tuple} type transform to stream and send as fastpath
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "sendFastPath", "IFastPathSender"))
def recvFastPath(self, secFlag, fastPathS):
"""
@summary: Call when fast path packet is received
@param secFlag: {SecFlags}
@param fastPathS: {Stream}
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "recvFastPath", "IFastPathListener"))
def onPointerEvent(self, x, y, button, isPressed):
"""
@summary: Event call on mouse event
@param x: x position
@param y: y position
@param button: 1, 2 or 3 button
@param isPressed: True if mouse button is pressed
"""
raise CallPureVirtualFuntion("%s:%s defined by interface %s"%(self.__class__, "onPointerEvent", "RDPServerObserver"))
def pointerEvent(self, x, y, button):
"""
Pointer event notification
@param x: x position
@param y: y position
@param button: button pressed
"""
raise CallPureVirtualFuntion("%s:%s defined by interface %s" %
(self.__class__, "pointerEvent", "IView"))
def buildObserver(self, controller, addr):
"""
@summary: Build observer use for connection
@param controller: RDP stack controller
@param addr: destination address
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "buildObserver", "ServerFactory"))
def buildObserver(self, controller, addr):
"""
@summary: Build an RFB observer object
@param controller: controller use for rfb session
@param addr: destination
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "buildObserver", "ClientFactory"))
def sendKeyEvent(self, e, isPressed):
"""
@summary: Interface to send key event to protocol stack
@param e: QEvent
@param isPressed: event come from press or release action
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "sendKeyEvent", "QAdaptor"))
def getAuthenticateMessage(self, s):
"""
@summary: Client last handshake message
@param s: {Stream} challenge message stream
@return: {(object, IGenericSecurityService)} Last handshake message and interface for application
"""
raise CallPureVirtualFuntion("%s:%s defined by interface %s" %
(self.__class__, "getAuthenticateMessage",
"IAuthenticationProtocol"))
def connectionLost(self, rawlayer, reason):
"""
@summary: Override this method to handle connection lost
@param rawlayer: rawLayer that cause connectionLost event
@param reason: twisted reason
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "recv", "IStreamListener"))
def onKeyEventUnicode(self, code, isPressed):
"""
@summary: Event call when a keyboard event is catch in unicode format
@param code: unicode of key
@param isPressed: True if key is down
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "onKeyEventUnicode", "RDPServerObserver"))
def recvRectangle(self, rectangle, pixelFormat, data):
"""
@summary: Receive rectangle order
Main update order type
@param rectangle: Rectangle type header of packet
@param pixelFormat: pixelFormat struct of current session
@param data: image data
"""
raise CallPureVirtualFuntion("%s:%s defined by interface %s"%(self.__class__, "recvRectangle", "RFBClientListener"))
def onKeyEventScancode(self, code, isPressed, isExtended):
"""
@summary: Event call when a keyboard event is catch in scan code format
@param code: {integer} scan code of key
@param isPressed: {boolean} True if key is down
@param isExtended: {boolean} True if a special key
"""
raise CallPureVirtualFuntion(
"%s:%s defined by interface %s" %
(self.__class__, "onKeyEventScanCode", "RDPServerObserver"))
