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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
[
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="UniqueBackend">
<refmeta>
<refentrytitle role="top_of_page" id="UniqueBackend.top_of_page">UniqueBackend</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>UNIQUE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>UniqueBackend</refname>
<refpurpose>Backend abstraction</refpurpose>
</refnamediv>
<refsynopsisdiv id="UniqueBackend.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="UniqueBackend-struct">UniqueBackend</link>;
<link linkend="UniqueBackendClass">UniqueBackendClass</link>;
<link linkend="UniqueBackend">UniqueBackend</link> * <link linkend="unique-backend-create">unique_backend_create</link> (void);
const <link linkend="gchar">gchar</link> * <link linkend="unique-backend-get-name">unique_backend_get_name</link> (<link linkend="UniqueBackend">UniqueBackend</link> *backend);
<link linkend="void">void</link> <link linkend="unique-backend-set-name">unique_backend_set_name</link> (<link linkend="UniqueBackend">UniqueBackend</link> *backend,
const <link linkend="gchar">gchar</link> *name);
const <link linkend="gchar">gchar</link> * <link linkend="unique-backend-get-startup-id">unique_backend_get_startup_id</link> (<link linkend="UniqueBackend">UniqueBackend</link> *backend);
<link linkend="void">void</link> <link linkend="unique-backend-set-startup-id">unique_backend_set_startup_id</link> (<link linkend="UniqueBackend">UniqueBackend</link> *backend,
const <link linkend="gchar">gchar</link> *startup_id);
<link linkend="GdkScreen">GdkScreen</link> * <link linkend="unique-backend-get-screen">unique_backend_get_screen</link> (<link linkend="UniqueBackend">UniqueBackend</link> *backend);
<link linkend="void">void</link> <link linkend="unique-backend-set-screen">unique_backend_set_screen</link> (<link linkend="UniqueBackend">UniqueBackend</link> *backend,
<link linkend="GdkScreen">GdkScreen</link> *screen);
<link linkend="guint">guint</link> <link linkend="unique-backend-get-workspace">unique_backend_get_workspace</link> (<link linkend="UniqueBackend">UniqueBackend</link> *backend);
<link linkend="gboolean">gboolean</link> <link linkend="unique-backend-request-name">unique_backend_request_name</link> (<link linkend="UniqueBackend">UniqueBackend</link> *backend);
<link linkend="UniqueResponse">UniqueResponse</link> <link linkend="unique-backend-send-message">unique_backend_send_message</link> (<link linkend="UniqueBackend">UniqueBackend</link> *backend,
<link linkend="gint">gint</link> command_id,
<link linkend="UniqueMessageData">UniqueMessageData</link> *message_data,
<link linkend="guint">guint</link> time_);
</synopsis>
</refsynopsisdiv>
<refsect1 id="UniqueBackend.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----UniqueBackend
</synopsis>
</refsect1>
<refsect1 id="UniqueBackend.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="UniqueBackend"><type>UniqueBackend</type></link> is the base, abstract class implemented by the different
IPC mechanisms used by Unique. Each <link linkend="UniqueApp"><type>UniqueApp</type></link> instance creates a
<link linkend="UniqueBackend"><type>UniqueBackend</type></link> to request the name or to send messages.</para>
<para>
</para>
</refsect1>
<refsect1 id="UniqueBackend.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="UniqueBackend-struct" role="struct">
<title>UniqueBackend</title>
<indexterm zone="UniqueBackend-struct"><primary sortas="Backend">UniqueBackend</primary></indexterm><programlisting>typedef struct _UniqueBackend UniqueBackend;</programlisting>
<para>
The <link linkend="UniqueBackend"><type>UniqueBackend</type></link> structure contains only private data and should only
be accessed using the provided functions.</para>
<para>
</para></refsect2>
<refsect2 id="UniqueBackendClass" role="struct">
<title>UniqueBackendClass</title>
<indexterm zone="UniqueBackendClass"><primary sortas="BackendClass">UniqueBackendClass</primary></indexterm><programlisting>typedef struct {
/* vtable, not signals */
gboolean (* request_name) (UniqueBackend *backend);
UniqueResponse (* send_message) (UniqueBackend *backend,
gint command_id,
UniqueMessageData *message_data,
guint time_);
} UniqueBackendClass;
</programlisting>
<para>
The class that should be implemented by every backend for <link linkend="UniqueApp"><type>UniqueApp</type></link>.</para>
<para>
</para><variablelist role="struct">
<varlistentry>
<term><structfield>request_name</structfield> ()</term>
<listitem><simpara> This method should be used to request the name for the
instance set using <link linkend="unique-backend-set-name"><function>unique_backend_set_name()</function></link>
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>send_message</structfield> ()</term>
<listitem><simpara> This method should be used to send a message to a running
instance
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="unique-backend-create" role="function">
<title>unique_backend_create ()</title>
<indexterm zone="unique-backend-create"><primary sortas="backend_create">unique_backend_create</primary></indexterm><programlisting><link linkend="UniqueBackend">UniqueBackend</link> * unique_backend_create (void);</programlisting>
<para>
Creates a <link linkend="UniqueBackend"><type>UniqueBackend</type></link> using the default backend defined at
compile time. You can override the default backend by setting the
<literal>UNIQUE_BACKEND</literal> environment variable with the
name of the desired backend.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="UniqueBackend"><type>UniqueBackend</type></link> instance
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="unique-backend-get-name" role="function">
<title>unique_backend_get_name ()</title>
<indexterm zone="unique-backend-get-name"><primary sortas="backend_get_name">unique_backend_get_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> * unique_backend_get_name (<link linkend="UniqueBackend">UniqueBackend</link> *backend);</programlisting>
<para>
FIXME</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter> :</term>
<listitem><simpara> FIXME
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> FIXME
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="unique-backend-set-name" role="function">
<title>unique_backend_set_name ()</title>
<indexterm zone="unique-backend-set-name"><primary sortas="backend_set_name">unique_backend_set_name</primary></indexterm><programlisting><link linkend="void">void</link> unique_backend_set_name (<link linkend="UniqueBackend">UniqueBackend</link> *backend,
const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
FIXME</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter> :</term>
<listitem><simpara> FIXME
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> FIXME
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="unique-backend-get-startup-id" role="function">
<title>unique_backend_get_startup_id ()</title>
<indexterm zone="unique-backend-get-startup-id"><primary sortas="backend_get_startup_id">unique_backend_get_startup_id</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> * unique_backend_get_startup_id (<link linkend="UniqueBackend">UniqueBackend</link> *backend);</programlisting>
<para>
FIXME</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter> :</term>
<listitem><simpara> FIXME
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> FIXME
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="unique-backend-set-startup-id" role="function">
<title>unique_backend_set_startup_id ()</title>
<indexterm zone="unique-backend-set-startup-id"><primary sortas="backend_set_startup_id">unique_backend_set_startup_id</primary></indexterm><programlisting><link linkend="void">void</link> unique_backend_set_startup_id (<link linkend="UniqueBackend">UniqueBackend</link> *backend,
const <link linkend="gchar">gchar</link> *startup_id);</programlisting>
<para>
FIXME</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter> :</term>
<listitem><simpara> FIXME
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>startup_id</parameter> :</term>
<listitem><simpara> FIXME
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="unique-backend-get-screen" role="function">
<title>unique_backend_get_screen ()</title>
<indexterm zone="unique-backend-get-screen"><primary sortas="backend_get_screen">unique_backend_get_screen</primary></indexterm><programlisting><link linkend="GdkScreen">GdkScreen</link> * unique_backend_get_screen (<link linkend="UniqueBackend">UniqueBackend</link> *backend);</programlisting>
<para>
FIXME</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter> :</term>
<listitem><simpara> FIXME
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> FIXME
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="unique-backend-set-screen" role="function">
<title>unique_backend_set_screen ()</title>
<indexterm zone="unique-backend-set-screen"><primary sortas="backend_set_screen">unique_backend_set_screen</primary></indexterm><programlisting><link linkend="void">void</link> unique_backend_set_screen (<link linkend="UniqueBackend">UniqueBackend</link> *backend,
<link linkend="GdkScreen">GdkScreen</link> *screen);</programlisting>
<para>
FIXME</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter> :</term>
<listitem><simpara> FIXME
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>screen</parameter> :</term>
<listitem><simpara> FIXME
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="unique-backend-get-workspace" role="function">
<title>unique_backend_get_workspace ()</title>
<indexterm zone="unique-backend-get-workspace"><primary sortas="backend_get_workspace">unique_backend_get_workspace</primary></indexterm><programlisting><link linkend="guint">guint</link> unique_backend_get_workspace (<link linkend="UniqueBackend">UniqueBackend</link> *backend);</programlisting>
<para>
Retrieves the current workspace.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter> :</term>
<listitem><simpara> a <link linkend="UniqueBackend"><type>UniqueBackend</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a workspace number
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="unique-backend-request-name" role="function">
<title>unique_backend_request_name ()</title>
<indexterm zone="unique-backend-request-name"><primary sortas="backend_request_name">unique_backend_request_name</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> unique_backend_request_name (<link linkend="UniqueBackend">UniqueBackend</link> *backend);</programlisting>
<para>
Requests the name set using <link linkend="unique-backend-set-name"><function>unique_backend_set_name()</function></link> using <parameter>backend</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter> :</term>
<listitem><simpara> a <link linkend="UniqueBackend"><type>UniqueBackend</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the name was assigned to us, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if there
already is a registered name
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="unique-backend-send-message" role="function">
<title>unique_backend_send_message ()</title>
<indexterm zone="unique-backend-send-message"><primary sortas="backend_send_message">unique_backend_send_message</primary></indexterm><programlisting><link linkend="UniqueResponse">UniqueResponse</link> unique_backend_send_message (<link linkend="UniqueBackend">UniqueBackend</link> *backend,
<link linkend="gint">gint</link> command_id,
<link linkend="UniqueMessageData">UniqueMessageData</link> *message_data,
<link linkend="guint">guint</link> time_);</programlisting>
<para>
Sends <parameter>command_id</parameter>, and optionally <parameter>message_data</parameter>, to a running instance
using <parameter>backend</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter> :</term>
<listitem><simpara> a <link linkend="UniqueBackend"><type>UniqueBackend</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>command_id</parameter> :</term>
<listitem><simpara> command to send
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>message_data</parameter> :</term>
<listitem><simpara> message to send, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>time_</parameter> :</term>
<listitem><simpara> time of the command emission, or 0 for the current time
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="UniqueResponse"><type>UniqueResponse</type></link> value sent by the running instance
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
