ClientProxy Class Reference

Generic proxy for client. More...

#include <ClientProxy.h>

Inheritance diagram for ClientProxy:

Collaboration diagram for ClientProxy:

Public Member Functions
	ClientProxy (const std::string &name, deskflow::IStream *adoptedStream)
	ClientProxy (ClientProxy const &)=delete
	ClientProxy (ClientProxy &&)=delete
	~ClientProxy () override
ClientProxy &	operator= (ClientProxy const &)=delete
ClientProxy &	operator= (ClientProxy &&)=delete
manipulators
void	close (const char *msg) const
	Disconnect.
Public Member Functions inherited from BaseClientProxy
	BaseClientProxy (const std::string &name)
	~BaseClientProxy () override=default
void	setJumpCursorPos (int32_t x, int32_t y)
	Save cursor position.
void	getJumpCursorPos (int32_t &x, int32_t &y) const
	Get cursor position.
virtual bool	isPrimary () const
	Get cursor position.
virtual std::string	getSecureInputApp () const =0
std::string	getName () const override
	Get client name.
Public Member Functions inherited from IClient
Public Member Functions inherited from IScreen
Public Member Functions inherited from IInterface
virtual	~IInterface ()=default
	Interface destructor does nothing.

accessors
deskflow::IStream *	getStream () const override
	Get stream.
void *	getEventTarget () const override
	Get event target.
bool	getClipboard (ClipboardID id, IClipboard *) const override=0
	Get clipboard.
void	getShape (int32_t &x, int32_t &y, int32_t &width, int32_t &height) const override=0
	Get screen shape.
void	getCursorPos (int32_t &x, int32_t &y) const override=0
	Get cursor position.
void	enter (int32_t xAbs, int32_t yAbs, uint32_t seqNum, KeyModifierMask mask, bool forScreensaver) override=0
	Enter screen.
bool	leave () override=0
	Leave screen.
void	setClipboard (ClipboardID, const IClipboard *) override=0
	Set clipboard.
void	grabClipboard (ClipboardID) override=0
	Grab clipboard.
void	setClipboardDirty (ClipboardID, bool) override=0
	Mark clipboard dirty.
void	keyDown (KeyID, KeyModifierMask, KeyButton, const std::string &) override=0
	Notify of key press.
void	keyRepeat (KeyID, KeyModifierMask, int32_t count, KeyButton, const std::string &lang) override=0
	Notify of key repeat.
void	keyUp (KeyID, KeyModifierMask, KeyButton) override=0
	Notify of key release.
void	mouseDown (ButtonID) override=0
	Notify of mouse press.
void	mouseUp (ButtonID) override=0
	Notify of mouse release.
void	mouseMove (int32_t xAbs, int32_t yAbs) override=0
	Notify of mouse motion.
void	mouseRelativeMove (int32_t xRel, int32_t yRel) override=0
	Notify of mouse motion.
void	mouseWheel (int32_t xDelta, int32_t yDelta) override=0
	Notify of mouse wheel motion.
void	screensaver (bool activate) override=0
	Notify of screen saver change.
void	resetOptions () override=0
	Notify of options changes.
void	setOptions (const OptionsList &options) override=0
	Notify of options changes.
void	sendDragInfo (uint32_t fileCount, const char *info, size_t size) override=0
void	fileChunkSending (uint8_t mark, char *data, size_t dataSize) override=0
void	secureInputNotification (const std::string &app) const override=0

Detailed Description

Generic proxy for client.

Constructor & Destructor Documentation

ClientProxy() [1/3]

ClientProxy::ClientProxy	(	const std::string &	name,
		deskflow::IStream *	adoptedStream )

name is the name of the client.

ClientProxy() [2/3]

ClientProxy::ClientProxy ( ClientProxy const & )

delete

ClientProxy() [3/3]

ClientProxy::ClientProxy ( ClientProxy && )

delete

~ClientProxy()

ClientProxy::~ClientProxy ( )

override

Member Function Documentation

close()

void ClientProxy::close

(

const char *

msg

)

const

Disconnect.

Ask the client to disconnect, using msg as the reason.

enter()

void ClientProxy::enter ( int32_t xAbs, int32_t yAbs, uint32_t seqNum, KeyModifierMask mask, bool forScreensaver )

overridepure virtual

Enter screen.

Enter the screen. The cursor should be warped to xAbs,yAbs. mask is the expected toggle button state and the client should update its state to match. forScreensaver is true iff the screen is being entered because the screen saver is starting. Subsequent clipboard events should report seqNum.

Implements BaseClientProxy.

Implemented in ClientProxy1_0.

fileChunkSending()

void ClientProxy::fileChunkSending ( uint8_t mark, char * data, size_t dataSize )

overridepure virtual

Implements BaseClientProxy.

Implemented in ClientProxy1_0, and ClientProxy1_5.

getClipboard()

bool ClientProxy::getClipboard ( ClipboardID id, IClipboard *  ) const

overridepure virtual

Get clipboard.

Save the contents of the clipboard indicated by id and return true iff successful.

Implements BaseClientProxy.

Implemented in ClientProxy1_0.

getCursorPos()

void ClientProxy::getCursorPos ( int32_t & x, int32_t & y ) const

overridepure virtual

Get cursor position.

Return the current position of the cursor in x and y.

Implements BaseClientProxy.

Implemented in ClientProxy1_0.

getEventTarget()

void * ClientProxy::getEventTarget ( ) const

overridevirtual

Get event target.

Returns the target used for events created by this object.

Implements BaseClientProxy.

getShape()

void ClientProxy::getShape ( int32_t & x, int32_t & y, int32_t & width, int32_t & height ) const

overridepure virtual

Get screen shape.

Return the position of the upper-left corner of the screen in x and y and the size of the screen in width and height.

Implements BaseClientProxy.

Implemented in ClientProxy1_0.

getStream()

deskflow::IStream * ClientProxy::getStream ( ) const

overridevirtual

Get stream.

Returns the original stream passed to the c'tor.

Implements BaseClientProxy.

grabClipboard()

void ClientProxy::grabClipboard ( ClipboardID )

overridepure virtual

Grab clipboard.

Grab (i.e. take ownership of) the client's clipboard. Since this is called when another client takes ownership of the clipboard it implies that the client's clipboard is out of date.

Implements BaseClientProxy.

Implemented in ClientProxy1_0.

keyDown()

void ClientProxy::keyDown ( KeyID id, KeyModifierMask , KeyButton , const std::string &  )

overridepure virtual

Notify of key press.

Synthesize key events to generate a press of key id. If possible match the given modifier mask. The KeyButton identifies the physical key on the server that generated this key down. The client must ensure that a key up or key repeat that uses the same KeyButton will synthesize an up or repeat for the same client key synthesized by keyDown().

Implements BaseClientProxy.

Implemented in ClientProxy1_0, ClientProxy1_1, ClientProxy1_4, and ClientProxy1_8.

keyRepeat()

void ClientProxy::keyRepeat ( KeyID id, KeyModifierMask , int32_t count, KeyButton , const std::string & lang )

overridepure virtual

Notify of key repeat.

Synthesize key events to generate a press and release of key id count times. If possible match the given modifier mask.

Implements BaseClientProxy.

Implemented in ClientProxy1_0, ClientProxy1_1, and ClientProxy1_4.

keyUp()

void ClientProxy::keyUp ( KeyID id, KeyModifierMask , KeyButton  )

overridepure virtual

Notify of key release.

Synthesize key events to generate a release of key id. If possible match the given modifier mask.

Implements BaseClientProxy.

Implemented in ClientProxy1_0, ClientProxy1_1, and ClientProxy1_4.

leave()

bool ClientProxy::leave ( )

overridepure virtual

Leave screen.

Leave the screen. Return false iff the user may not leave the client's screen (because, for example, a button is down).

Implements BaseClientProxy.

Implemented in ClientProxy1_0.

mouseDown()

void ClientProxy::mouseDown ( ButtonID id )

overridepure virtual

Notify of mouse press.

Synthesize mouse events to generate a press of mouse button id.

Implements BaseClientProxy.

Implemented in ClientProxy1_0.

mouseMove()

void ClientProxy::mouseMove ( int32_t xAbs, int32_t yAbs )

overridepure virtual

Notify of mouse motion.

Synthesize mouse events to generate mouse motion to the absolute screen position xAbs,yAbs.

Implements BaseClientProxy.

Implemented in ClientProxy1_0.

mouseRelativeMove()

void ClientProxy::mouseRelativeMove ( int32_t xRel, int32_t yRel )

overridepure virtual

Notify of mouse motion.

Synthesize mouse events to generate mouse motion by the relative amount xRel,yRel.

Implements BaseClientProxy.

Implemented in ClientProxy1_0, and ClientProxy1_2.

mouseUp()

void ClientProxy::mouseUp ( ButtonID id )

overridepure virtual

Notify of mouse release.

Synthesize mouse events to generate a release of mouse button id.

Implements BaseClientProxy.

Implemented in ClientProxy1_0.

mouseWheel()

void ClientProxy::mouseWheel ( int32_t xDelta, int32_t yDelta )

overridepure virtual

Notify of mouse wheel motion.

Synthesize mouse events to generate mouse wheel motion of xDelta and yDelta. Deltas are positive for motion away from the user or to the right and negative for motion towards the user or to the left. Each wheel click should generate a delta of +/-120.

Implements BaseClientProxy.

Implemented in ClientProxy1_0, and ClientProxy1_3.

operator=() [1/2]

ClientProxy & ClientProxy::operator= ( ClientProxy && )

delete

operator=() [2/2]

ClientProxy & ClientProxy::operator= ( ClientProxy const & )

delete

resetOptions()

void ClientProxy::resetOptions ( )

overridepure virtual

Notify of options changes.

Reset all options to their default values.

Implements BaseClientProxy.

Implemented in ClientProxy1_0.

screensaver()

void ClientProxy::screensaver ( bool activate )

overridepure virtual

Notify of screen saver change.

Implements BaseClientProxy.

Implemented in ClientProxy1_0.

secureInputNotification()

void ClientProxy::secureInputNotification ( const std::string & app ) const

overridepure virtual

Implements BaseClientProxy.

Implemented in ClientProxy1_0, and ClientProxy1_7.

sendDragInfo()

void ClientProxy::sendDragInfo ( uint32_t fileCount, const char * info, size_t size )

overridepure virtual

Implements BaseClientProxy.

Implemented in ClientProxy1_0, and ClientProxy1_5.

setClipboard()

void ClientProxy::setClipboard ( ClipboardID , const IClipboard *  )

overridepure virtual

Set clipboard.

Update the client's clipboard. This implies that the client's clipboard is now up to date. If the client's clipboard was already known to be up to date then this may do nothing. data has marshalled clipboard data.

Implements BaseClientProxy.

Implemented in ClientProxy1_0, and ClientProxy1_6.

setClipboardDirty()

void ClientProxy::setClipboardDirty ( ClipboardID , bool dirty )

overridepure virtual

Mark clipboard dirty.

Mark the client's clipboard as dirty (out of date) or clean (up to date).

Implements BaseClientProxy.

Implemented in ClientProxy1_0.

setOptions()

void ClientProxy::setOptions ( const OptionsList & options )

overridepure virtual

Notify of options changes.

Set options to given values. Ignore unknown options and don't modify our options that aren't given in options.

Implements BaseClientProxy.

Implemented in ClientProxy1_0.

---

The documentation for this class was generated from the following files:

• src/lib/server/ClientProxy.h
• src/lib/server/ClientProxy.cpp