blob: 7b054e37868a5c4f0c29d744caf95953f9510237 [file] [log] [blame]
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +00001/* Copyright (C) 2002-2005 RealVNC Ltd. All Rights Reserved.
2 *
3 * This is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This software is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this software; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
16 * USA.
17 */
18
19/////////////////////////////////////////////////////////////////////////////
20
21// SDesktop is an interface implemented by back-ends, on which callbacks are
22// made by the VNCServer as appropriate for pointer and keyboard events, etc.
23// SDesktop objects are always created before the VNCServer - the SDesktop
24// will be passed a pointer to the VNCServer in the start() call. If a more
25// implementation-specific pointer to the VNCServer is required then this
26// can be provided to the SDesktop via an implementation-specific method.
27//
28// An SDesktop usually has an associated PixelBuffer which it tells the
29// VNCServer via the VNCServer's setPixelBuffer() method. It can do this at
30// any time, but the PixelBuffer MUST be valid by the time the call to start()
31// returns. The PixelBuffer may be set to null again if desired when stop() is
32// called. Note that start() and stop() are guaranteed to be called
33// alternately; there should never be two calls to start() without an
34// intervening stop() and vice-versa.
35//
36
37#ifndef __RFB_SDESKTOP_H__
38#define __RFB_SDESKTOP_H__
39
40#include <rfb/PixelBuffer.h>
41#include <rfb/VNCServer.h>
42#include <rfb/InputHandler.h>
43#include <rfb/Exception.h>
44
45namespace rfb {
46
47 class VNCServer;
48
49 class SDesktop : public InputHandler {
50 public:
51 // start() is called by the server when the first client authenticates
52 // successfully, and can be used to begin any expensive tasks which are not
53 // needed when there are no clients. A valid PixelBuffer must have been
54 // set via the VNCServer's setPixelBuffer() method by the time this call
55 // returns.
56
57 virtual void start(VNCServer* vs) {}
58
59 // stop() is called by the server when there are no longer any
60 // authenticated clients, and therefore the desktop can cease any
61 // expensive tasks. No further calls to the VNCServer passed to start()
62 // can be made once stop has returned.
63
64 virtual void stop() {}
65
66 // framebufferUpdateRequest() is called to let the desktop know that at
67 // least one client has become ready for an update. Desktops can check
68 // whether there are clients ready at any time by calling the VNCServer's
69 // clientsReadyForUpdate() method.
70
71 virtual void framebufferUpdateRequest() {}
72
73 // getFbSize() returns the current dimensions of the framebuffer.
74 // This can be called even while the SDesktop is not start()ed.
75
76 virtual Point getFbSize() = 0;
77
78 // InputHandler interface
79 // pointerEvent(), keyEvent() and clientCutText() are called in response to
80 // the relevant RFB protocol messages from clients.
81 // See InputHandler for method signatures.
82 protected:
83 virtual ~SDesktop() {}
84 };
85
86 // -=- SStaticDesktop
87 // Trivial implementation of the SDesktop interface, which provides
88 // dummy input handlers and event processing routine, and exports
89 // a plain black desktop of the specified format.
90 class SStaticDesktop : public SDesktop {
91 public:
92 SStaticDesktop(const Point& size) : server(0), buffer(0) {
93 PixelFormat pf;
94 buffer = new ManagedPixelBuffer(pf, size.x, size.y);
95 if (buffer) memset(buffer->data, 0, (pf.bpp/8) * (size.x*size.y));
96 }
97 SStaticDesktop(const Point& size, const PixelFormat& pf) : buffer(0) {
98 buffer = new ManagedPixelBuffer(pf, size.x, size.y);
99 if (buffer) memset(buffer->data, 0, (pf.bpp/8) * (size.x*size.y));
100 }
101 virtual ~SStaticDesktop() {
102 if (buffer) delete buffer;
103 }
104
105 virtual void start(VNCServer* vs) {
106 server = vs;
107 server->setPixelBuffer(buffer);
108 }
109 virtual void stop() {
110 server->setPixelBuffer(0);
111 server = 0;
112 }
113
114 protected:
115 VNCServer* server;
116 ManagedPixelBuffer* buffer;
117 };
118
119};
120
121#endif // __RFB_SDESKTOP_H__