123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195 |
- /* 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.
- */
-
- //
- // VNCSConnectionST is our derived class of SConnection for VNCServerST - there
- // is one for each connected client. We think of VNCSConnectionST as part of
- // the VNCServerST implementation, so its methods are allowed full access to
- // members of VNCServerST.
- //
-
- #ifndef __RFB_VNCSCONNECTIONST_H__
- #define __RFB_VNCSCONNECTIONST_H__
-
- #include <map>
-
- #include <rfb/Congestion.h>
- #include <rfb/EncodeManager.h>
- #include <rfb/SConnection.h>
- #include <rfb/Timer.h>
-
- namespace rfb {
- class VNCServerST;
-
- class VNCSConnectionST : public SConnection,
- public Timer::Callback {
- public:
- VNCSConnectionST(VNCServerST* server_, network::Socket* s, bool reverse);
- virtual ~VNCSConnectionST();
-
- // SConnection methods
-
- virtual bool accessCheck(AccessRights ar) const;
- virtual void close(const char* reason);
-
- // Methods called from VNCServerST. None of these methods ever knowingly
- // throw an exception.
-
- // init() must be called to initialise the protocol. If it fails it
- // returns false, and close() will have been called.
- bool init();
-
- // processMessages() processes incoming messages from the client, invoking
- // various callbacks as a result. It continues to process messages until
- // reading might block. shutdown() will be called on the connection's
- // Socket if an error occurs, via the close() call.
- void processMessages();
-
- // flushSocket() pushes any unwritten data on to the network.
- void flushSocket();
-
- // Called when the underlying pixelbuffer is resized or replaced.
- void pixelBufferChange();
-
- // Wrappers to make these methods "safe" for VNCServerST.
- void writeFramebufferUpdateOrClose();
- void screenLayoutChangeOrClose(rdr::U16 reason);
- void setCursorOrClose();
- void bellOrClose();
- void setDesktopNameOrClose(const char *name);
- void setLEDStateOrClose(unsigned int state);
- void approveConnectionOrClose(bool accept, const char* reason);
- void requestClipboardOrClose();
- void announceClipboardOrClose(bool available);
- void sendClipboardDataOrClose(const char* data);
-
- // The following methods never throw exceptions
-
- // getComparerState() returns if this client would like the framebuffer
- // comparer to be enabled.
- bool getComparerState();
-
- // renderedCursorChange() is called whenever the server-side rendered
- // cursor changes shape or position. It ensures that the next update will
- // clean up the old rendered cursor and if necessary draw the new rendered
- // cursor.
- void renderedCursorChange();
-
- // needRenderedCursor() returns true if this client needs the server-side
- // rendered cursor. This may be because it does not support local cursor
- // or because the current cursor position has not been set by this client.
- bool needRenderedCursor();
-
- network::Socket* getSock() { return sock; }
-
- // Change tracking
-
- void add_changed(const Region& region) { updates.add_changed(region); }
- void add_copied(const Region& dest, const Point& delta) {
- updates.add_copied(dest, delta);
- }
-
- const char* getPeerEndpoint() const {return peerEndpoint.buf;}
-
- private:
- // SConnection callbacks
-
- // These methods are invoked as callbacks from processMsg()
-
- virtual void authSuccess();
- virtual void queryConnection(const char* userName);
- virtual void clientInit(bool shared);
- virtual void setPixelFormat(const PixelFormat& pf);
- virtual void pointerEvent(const Point& pos, int buttonMask);
- virtual void keyEvent(rdr::U32 keysym, rdr::U32 keycode, bool down);
- virtual void framebufferUpdateRequest(const Rect& r, bool incremental);
- virtual void setDesktopSize(int fb_width, int fb_height,
- const ScreenSet& layout);
- virtual void fence(rdr::U32 flags, unsigned len, const char data[]);
- virtual void enableContinuousUpdates(bool enable,
- int x, int y, int w, int h);
- virtual void handleClipboardRequest();
- virtual void handleClipboardAnnounce(bool available);
- virtual void handleClipboardData(const char* data);
- virtual void supportsLocalCursor();
- virtual void supportsFence();
- virtual void supportsContinuousUpdates();
- virtual void supportsLEDState();
-
- // Timer callbacks
- virtual bool handleTimeout(Timer* t);
-
- // Internal methods
-
- bool isShiftPressed();
-
- // Congestion control
- void writeRTTPing();
- bool isCongested();
-
- // writeFramebufferUpdate() attempts to write a framebuffer update to the
- // client.
-
- void writeFramebufferUpdate();
- void writeNoDataUpdate();
- void writeDataUpdate();
- void writeLosslessRefresh();
-
- void screenLayoutChange(rdr::U16 reason);
- void setCursor();
- void setDesktopName(const char *name);
- void setLEDState(unsigned int state);
-
- private:
- network::Socket* sock;
- CharArray peerEndpoint;
- bool reverseConnection;
-
- bool inProcessMessages;
-
- bool pendingSyncFence, syncFence;
- rdr::U32 fenceFlags;
- unsigned fenceDataLen;
- char *fenceData;
-
- Congestion congestion;
- Timer congestionTimer;
- Timer losslessTimer;
-
- VNCServerST* server;
- SimpleUpdateTracker updates;
- Region requested;
- bool updateRenderedCursor, removeRenderedCursor;
- Region damagedCursorRegion;
- bool continuousUpdates;
- Region cuRegion;
- EncodeManager encodeManager;
-
- std::map<rdr::U32, rdr::U32> pressedKeys;
-
- Timer idleTimer;
-
- time_t pointerEventTime;
- Point pointerEventPos;
- bool clientHasCursor;
-
- CharArray closeReason;
- };
- }
- #endif
|