1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/* Copyright (C) 2002-2005 RealVNC Ltd. All Rights Reserved.
* Copyright 2009-2019 Pierre Ossman for Cendio AB
*
* 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.
*/
//
// SMsgHandler - class to handle incoming messages on the server side.
//
#ifndef __RFB_SMSGHANDLER_H__
#define __RFB_SMSGHANDLER_H__
#include <stdint.h>
#include <rfb/PixelFormat.h>
#include <rfb/ClientParams.h>
#include <rfb/ScreenSet.h>
namespace rdr { class InStream; }
namespace rfb {
class SMsgHandler {
public:
SMsgHandler();
virtual ~SMsgHandler();
// The following methods are called as corresponding messages are read. A
// derived class should override these methods as desired. Note that for
// the setPixelFormat(), setEncodings() and clipboardCaps() methods, a
// derived class must call on to SMsgHandler's methods.
virtual void clientInit(bool shared);
virtual void setPixelFormat(const PixelFormat& pf);
virtual void setEncodings(int nEncodings, const int32_t* encodings);
virtual void framebufferUpdateRequest(const Rect& r, bool incremental) = 0;
virtual void setDesktopSize(int fb_width, int fb_height,
const ScreenSet& layout) = 0;
virtual void fence(uint32_t flags, unsigned len, const uint8_t data[]) = 0;
virtual void enableContinuousUpdates(bool enable,
int x, int y, int w, int h) = 0;
virtual void keyEvent(uint32_t keysym, uint32_t keycode,
bool down);
virtual void pointerEvent(const Point& pos,
int buttonMask);
virtual void clientCutText(const char* str);
virtual void handleClipboardCaps(uint32_t flags,
const uint32_t* lengths);
virtual void handleClipboardRequest(uint32_t flags);
virtual void handleClipboardPeek();
virtual void handleClipboardNotify(uint32_t flags);
virtual void handleClipboardProvide(uint32_t flags,
const size_t* lengths,
const uint8_t* const* data);
// supportsLocalCursor() is called whenever the status of
// cp.supportsLocalCursor has changed. At the moment this happens on a
// setEncodings message, but in the future this may be due to a message
// specially for this purpose.
virtual void supportsLocalCursor();
// supportsFence() is called the first time we detect support for fences
// in the client. A fence message should be sent at this point to notify
// the client of server support.
virtual void supportsFence();
// supportsContinuousUpdates() is called the first time we detect that
// the client wants the continuous updates extension. A
// EndOfContinuousUpdates message should be sent back to the client at
// this point if it is supported.
virtual void supportsContinuousUpdates();
// supportsLEDState() is called the first time we detect that the
// client supports the LED state extension. A LEDState message
// should be sent back to the client to inform it of the current
// server state.
virtual void supportsLEDState();
// supportsQEMUKeyEvent() is called the first time we detect that the
// client wants the QEMU Extended Key Event extension. The default
// handler will send a pseudo-rect back, signalling server support.
virtual void supportsQEMUKeyEvent();
ClientParams client;
};
}
#endif
|
