Keyboard Messages

Keyboard input event messages. More...

Collaboration diagram for Keyboard Messages:

Variables
const char *const	kMsgDKeyDown
	Key press event.
const char *const	kMsgDKeyDown1_1
	Key press event (v1.1 to v1.7).
const char *const	kMsgDKeyDown1_0
	Key press event (legacy v1.0).
const char *const	kMsgDKeyRepeat
	Key auto-repeat event.
const char *const	kMsgDKeyRepeat1_1
	Key auto-repeat event (v1.1 to v1.7).
const char *const	kMsgDKeyRepeat1_0
	Key auto-repeat event (legacy v1.0).
const char *const	kMsgDKeyUp
	Key release event.
const char *const	kMsgDKeyUp1_0
	Key release event (legacy v1.0).

Detailed Description

Keyboard input event messages.

Variable Documentation

kMsgDKeyDown

const char* const kMsgDKeyDown

extern

Key press event.

Message Code: "DKDL" Direction: Primary → Secondary Format: "DKDL%2i%2i%2is" Parameters:

• $1: KeyID (2 bytes) - Virtual key identifier, often called a "keysym" on Linux/X11. This is platform-dependent and corresponds to values like XK_a on X11/Linux, 'a' on macOS, and 'A' on Windows.
• $2: KeyModifierMask (2 bytes) - Active modifier keys
• $3: KeyButton (2 bytes) - Physical key code, often called a "keycode" or "scancode". This is the raw, platform-dependent scan code of the key pressed.
• $4: Language code (string) - Keyboard language identifier

Example:

'a' key (KeyID 0x61), no modifiers, physical key (KeyButton 0x1E), English

"DKDL\x00\x61\x00\x00\x00\x1E\x00\x00\x00\x02en"

Key Mapping Strategy: The KeyButton parameter is crucial for proper key release handling. The secondary computer should:

1. Map the KeyID to its local virtual key
2. Remember the association between KeyButton and the local physical key
3. Use KeyButton (not KeyID) to identify which key to release

This is necessary because:

• Dead keys can change the KeyID between press and release
• Different keyboard layouts may produce different KeyIDs
• Modifier keys released before the main key can alter KeyID

The language code helps clients handle characters from a keyboard layout they do not have active. Only sent to clients that replied 1.8 in their hello.

See also

kMsgDKeyUp, kMsgDKeyDown1_1

Since

Protocol version 1.8

kMsgDKeyDown1_0

const char* const kMsgDKeyDown1_0

extern

Key press event (legacy v1.0).

Message Code: "DKDN" Direction: Primary → Secondary Format: "DKDN%2i%2i" Parameters:

• $1: KeyID (2 bytes) - Virtual key identifier
• $2: KeyModifierMask (2 bytes) - Active modifier keys

Legacy version without KeyButton parameter. Used only when communicating with protocol version 1.0 clients.

Deprecated

Use kMsgDKeyDown1_1 for protocol version 1.1+

See also

kMsgDKeyDown1_1

Since

Protocol version 1.0

kMsgDKeyDown1_1

const char* const kMsgDKeyDown1_1

extern

Key press event (v1.1 to v1.7).

Message Code: "DKDN" Direction: Primary → Secondary Format: "DKDN%2i%2i%2i" Parameters:

• $1: KeyID (2 bytes) - Virtual key identifier
• $2: KeyModifierMask (2 bytes) - Active modifier keys
• $3: KeyButton (2 bytes) - Physical key code

Example:

'a' key (KeyID 0x61), no modifiers, physical key (KeyButton 0x1E)

"DKDN\x00\x61\x00\x00\x00\x1E"

Version without the language code. Used when communicating with protocol version 1.1 through 1.7 clients (Synergy 1.4 to 1.14.1, Barrier, Input Leap). The key mapping strategy is the same as for kMsgDKeyDown.

See also

kMsgDKeyDown

Since

Protocol version 1.1

kMsgDKeyRepeat

const char* const kMsgDKeyRepeat

extern

Key auto-repeat event.

Message Code: "DKRP" Direction: Primary → Secondary Format: "DKRP%2i%2i%2i%2is" Parameters:

• $1: KeyID (2 bytes) - Virtual key identifier, often called a "keysym" on Linux/X11. This is platform-dependent and corresponds to values like XK_a on X11/Linux, 'a' on macOS, and 'A' on Windows.
• $2: KeyModifierMask (2 bytes) - Active modifier keys
• $3: Repeat count (2 bytes) - Number of repeats
• $4: KeyButton (2 bytes) - Physical key code, often called a "keycode" or "scancode". This is the raw, platform-dependent scan code of the key pressed.
• $5: Language code (string) - Keyboard language identifier

Example:

'a' key repeating 3 times, English layout

"DKRP\x00\x61\x00\x00\x00\x03\x00\x1E\x00\x00\x00\x02en"

Sent when a key is held down and auto-repeating. The repeat count indicates how many repeat events occurred since the last message.

Shares the DKRP message code with kMsgDKeyRepeat1_1, so the receiver can only tell the two apart by the negotiated protocol version. Only sent to clients that replied 1.8 in their hello.

See also

kMsgDKeyDown, kMsgDKeyRepeat1_1

Since

Protocol version 1.8

kMsgDKeyRepeat1_0

const char* const kMsgDKeyRepeat1_0

extern

Key auto-repeat event (legacy v1.0).

Message Code: "DKRP" Direction: Primary → Secondary Format: "DKRP%2i%2i%2i" Parameters:

• $1: KeyID (2 bytes) - Virtual key identifier
• $2: KeyModifierMask (2 bytes) - Active modifier keys
• $3: Repeat count (2 bytes) - Number of repeats

Legacy version without the KeyButton parameter.

Deprecated

Use kMsgDKeyRepeat1_1 for protocol version 1.1+

See also

kMsgDKeyRepeat1_1

Since

Protocol version 1.0

kMsgDKeyRepeat1_1

const char* const kMsgDKeyRepeat1_1

extern

Key auto-repeat event (v1.1 to v1.7).

Message Code: "DKRP" Direction: Primary → Secondary Format: "DKRP%2i%2i%2i%2i" Parameters:

• $1: KeyID (2 bytes) - Virtual key identifier
• $2: KeyModifierMask (2 bytes) - Active modifier keys
• $3: Repeat count (2 bytes) - Number of repeats
• $4: KeyButton (2 bytes) - Physical key code

Example:

'a' key repeating 3 times

"DKRP\x00\x61\x00\x00\x00\x03\x00\x1E"

Version without the language code. Used when communicating with protocol version 1.1 through 1.7 clients (Synergy 1.4 to 1.14.1, Barrier, Input Leap).

See also

kMsgDKeyRepeat

Since

Protocol version 1.1

kMsgDKeyUp

const char* const kMsgDKeyUp

extern

Key release event.

Message Code: "DKUP" Direction: Primary → Secondary Format: "DKUP%2i%2i%2i" Parameters:

• $1: KeyID (2 bytes) - Virtual key identifier, often called a "keysym" on Linux/X11. This is platform-dependent and corresponds to values like XK_a on X11/Linux, 'a' on macOS, and 'A' on Windows.
• $2: KeyModifierMask (2 bytes) - Active modifier keys
• $3: KeyButton (2 bytes) - Physical key code, often called a "keycode" or "scancode". This is the raw, platform-dependent scan code of the key pressed.

Example:

Release 'a' key, physical key 0x1E

"DKUP\x00\x61\x00\x00\x00\x1E"

Important: The secondary computer should use KeyButton (not KeyID) to determine which physical key to release. This ensures correct behavior with dead keys and layout differences.

See also

kMsgDKeyDown

Since

Protocol version 1.1

kMsgDKeyUp1_0

const char* const kMsgDKeyUp1_0

extern

Key release event (legacy v1.0).

Message Code: "DKUP" Direction: Primary → Secondary Format: "DKUP%2i%2i" Parameters:

• $1: KeyID (2 bytes) - Virtual key identifier
• $2: KeyModifierMask (2 bytes) - Active modifier keys

Legacy version without KeyButton parameter.

Deprecated

Use kMsgDKeyUp for protocol version 1.1+

See also

kMsgDKeyUp

Since

Protocol version 1.0