Initial commit

common/rfb/VNCServer.h

@@ -0,0 +1,83 @@
+/* Copyright (C) 2002-2005 RealVNC Ltd.  All Rights Reserved.
+ * 
+ * This is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ * 
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this software; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,
+ * USA.
+ */
+//
+// VNCServer - abstract interface implemented by the RFB library.  The back-end
+// code calls the relevant methods as appropriate.
+
+#ifndef __RFB_VNCSERVER_H__
+#define __RFB_VNCSERVER_H__
+
+#include <rfb/UpdateTracker.h>
+#include <rfb/SSecurity.h>
+#include <rfb/ScreenSet.h>
+
+namespace rfb {
+
+  class VNCServer : public UpdateTracker {
+  public:
+    // blockUpdates()/unblockUpdates() tells the server that the pixel buffer
+    // is currently in flux and may not be accessed. The attributes of the
+    // pixel buffer may still be accessed, but not the frame buffer itself.
+    // Note that access must be unblocked the exact same number of times it
+    // was blocked.
+    virtual void blockUpdates() = 0;
+    virtual void unblockUpdates() = 0;
+
+    // setPixelBuffer() tells the server to use the given pixel buffer (and
+    // optionally a modified screen layout).  If this differs in size from
+    // the previous pixel buffer, this may result in protocol messages being
+    // sent, or clients being disconnected.
+    virtual void setPixelBuffer(PixelBuffer* pb, const ScreenSet& layout) = 0;
+    virtual void setPixelBuffer(PixelBuffer* pb) = 0;
+
+    // setScreenLayout() modifies the current screen layout without changing
+    // the pixelbuffer. Clients will be notified of the new layout.
+    virtual void setScreenLayout(const ScreenSet& layout) = 0;
+
+    // getPixelBuffer() returns a pointer to the PixelBuffer object.
+    virtual PixelBuffer* getPixelBuffer() const = 0;
+
+    // serverCutText() tells the server that the cut text has changed.  This
+    // will normally be sent to all clients.
+    virtual void serverCutText(const char* str, int len) = 0;
+
+    // bell() tells the server that it should make all clients make a bell sound.
+    virtual void bell() = 0;
+
+    // - Close all currently-connected clients, by calling
+    //   their close() method with the supplied reason.
+    virtual void closeClients(const char* reason) = 0;
+
+    // setCursor() tells the server that the cursor has changed.  The
+    // cursorData argument contains width*height rgba quadruplets with
+    // non-premultiplied alpha.
+    virtual void setCursor(int width, int height, const Point& hotspot,
+                           const rdr::U8* cursorData) = 0;
+
+    // setCursorPos() tells the server the current position of the cursor.
+    virtual void setCursorPos(const Point& p) = 0;
+
+    // setName() tells the server what desktop title to supply to clients
+    virtual void setName(const char* name) = 0;
+
+    // setLEDState() tells the server what the current lock keys LED
+    // state is
+    virtual void setLEDState(unsigned int state) = 0;
+  };
+}
+#endif