pidgin/pidgin
Clone
Summary
Browse
Changes
Graph
Convert xfer I/O operations from UI ops to signals.
2019-12-21, Elliott Sales de Andrade
7f38c3cc5c91
Convert xfer I/O operations from UI ops to signals.
<?xml version='1.0' encoding="ISO-8859-1"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<chapter
id=
"chapter-signals-connection"
>
<title>
Connection
signals
</title>
<refsect1
id=
"connections.signals"
role=
"signal_proto"
>
<title
role=
"signal_proto.title"
>
List
of
signals
</title>
<synopsis>
"
<link
linkend=
"connections-signing-on"
>
signing-on
</link>
"
"
<link
linkend=
"connections-signed-on"
>
signed-on
</link>
"
"
<link
linkend=
"connections-autojoin"
>
autojoin
</link>
"
"
<link
linkend=
"connections-signing-off"
>
signing-off
</link>
"
"
<link
linkend=
"connections-signed-off"
>
signed-off
</link>
"
"
<link
linkend=
"connections-connection-error"
>
connection-error
</link>
"
</synopsis>
</refsect1>
<refsect1
id=
"connections.signal-details"
role=
"signals"
>
<title
role=
"signals.title"
>
Signal
details
</title>
<refsect2
id=
"connections-signing-on"
role=
"signal"
>
<title>
The
<literal>
"
signing-on
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleConnection
*gc,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
connection
is
about
to
sign
on.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
gc
</parameter>
 
:
</term>
<listitem><simpara>
The
connection
that
is
about
to
sign
on.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"connections-signed-on"
role=
"signal"
>
<title>
The
<literal>
"
signed-on
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleConnection
*gc,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
connection
has
signed
on.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
gc
</parameter>
 
:
</term>
<listitem><simpara>
The
connection
that
has
signed
on.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"connections-autojoin"
role=
"signal"
>
<title>
The
<literal>
"
autojoin
"
</literal>
signal
</title>
<programlisting>
gboolean
user_function
(PurpleConnection
*gc,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
connection
has
signed
on,
after
the
signed-on
signal,
to
signal
UIs
to
autojoin
chats
if
they
wish.
UIs
should
connect
to
this
with
<literal>
PURPLE_SIGNAL_PRIORITY_HIGHEST
</literal>
to
allow
plugins
to
block
this
signal
before
the
UI
sees
it
and
then
re-emit
it
later.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
gc
</parameter>
 
:
</term>
<listitem><simpara>
The
connection
that
has
signed
on.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>
Returns
</emphasis>
 
:
</term>
<listitem><simpara><literal>
TRUE
</literal>
if
the
signal
was
handled
or
<literal>
FALSE
</literal>
otherwise.
In
practice,
the
return
value
is
irrelevant,
as
it
really
only
exists
so
plugins
can
block
the
UI's
autojoin.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"connections-signing-off"
role=
"signal"
>
<title>
The
<literal>
"
signing-off
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleConnection
*gc,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
connection
is
about
to
sign
off.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
gc
</parameter>
 
:
</term>
<listitem><simpara>
The
connection
that
is
about
to
sign
off.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"connections-signed-off"
role=
"signal"
>
<title>
The
<literal>
"
signed-off
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleConnection
*gc,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
connection
has
signed
off.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
gc
</parameter>
 
:
</term>
<listitem><simpara>
The
connection
that
has
signed
off.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"connections-connection-error"
role=
"signal"
>
<title>
The
<literal>
"
connection-error
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleConnection
*gc,
PurpleConnectionError
err,
const
gchar
*desc,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
connection
error
occurs,
before
<literal>
"signed"
</literal>
-off.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
gc
</parameter>
 
:
</term>
<listitem><simpara>
The
connection
on
which
the
error
has
occurred.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
err
</parameter>
 
:
</term>
<listitem><simpara>
The
error
that
occurred.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
desc
</parameter>
 
:
</term>
<listitem><simpara>
A
description
of
the
error,
giving
more
information.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
</chapter>