Scim Bridge Developer Manual: The communication protocol

Up

Who does need this section?

Basically, you don't have to know about the communication protocol between the agent and the clients because the client library interprets it for you. So, this section is mainly written for...

Let's know about the fumdamental rules

Now, you can communicate with the agent by open the unix domain socket in O_RDWR mode.

The command list

The following list describes all the commands go through the socket.

From the agent to clients:

From the clients to agent:


Appendix: Supported attributes

TypeDescriptionSupported values
foregroundChange the text color of the preedit.Colors in the format of "#RRGGBB".
backgroundChange the background color of the preedit.Colors in the format of "#RRGGBB".
decoratationChange the background color of the preedit."reverse" to exchange the foreground color and background one.
"hilight" to hilight the preedit.
"underline" to add a line under the preedit.
noneInvalid attribute."none" is recommanded.


Appendix: Modes for the the preedit.

TypeDescription
embeddedThe clients show the one by itself. The agent must not show the one.
hangingThe agent show the one just under the caret if the caret position is available. Otherwise, this is the same as "floating".
floatingThe agent show the one in any position.
anyThe agent uses it following to its preference.