707 lines
36 KiB
XML
707 lines
36 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
|
|
|
<refentry id="libgimpbase-gimpwire">
|
|
<refmeta>
|
|
<refentrytitle>gimpwire</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>gimpwire</refname><refpurpose>The lowlevel I/O protocol used for communication between GIMP and
|
|
it's plug-ins.</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv><title>Synopsis</title>
|
|
|
|
<synopsis>
|
|
|
|
|
|
|
|
<link linkend="WireMessage">WireMessage</link>;
|
|
<link linkend="void">void</link> (<link linkend="WireReadFunc">*WireReadFunc</link>) (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="WireMessage">WireMessage</link> *msg,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="void">void</link> (<link linkend="WireWriteFunc">*WireWriteFunc</link>) (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="WireMessage">WireMessage</link> *msg,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="void">void</link> (<link linkend="WireDestroyFunc">*WireDestroyFunc</link>) (<link linkend="WireMessage">WireMessage</link> *msg);
|
|
<link linkend="gboolean">gboolean</link> (<link linkend="WireIOFunc">*WireIOFunc</link>) (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint8">guint8</link> *buf,
|
|
<link linkend="gulong">gulong</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="gboolean">gboolean</link> (<link linkend="WireFlushFunc">*WireFlushFunc</link>) (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="void">void</link> <link linkend="wire-register">wire_register</link> (<link linkend="guint32">guint32</link> type,
|
|
<link linkend="WireReadFunc">WireReadFunc</link> read_func,
|
|
<link linkend="WireWriteFunc">WireWriteFunc</link> write_func,
|
|
<link linkend="WireDestroyFunc">WireDestroyFunc</link> destroy_func);
|
|
<link linkend="void">void</link> <link linkend="wire-set-reader">wire_set_reader</link> (<link linkend="WireIOFunc">WireIOFunc</link> read_func);
|
|
<link linkend="void">void</link> <link linkend="wire-set-writer">wire_set_writer</link> (<link linkend="WireIOFunc">WireIOFunc</link> write_func);
|
|
<link linkend="void">void</link> <link linkend="wire-set-flusher">wire_set_flusher</link> (<link linkend="WireFlushFunc">WireFlushFunc</link> flush_func);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="wire-read">wire_read</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint8">guint8</link> *buf,
|
|
<link linkend="gsize">gsize</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="wire-write">wire_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint8">guint8</link> *buf,
|
|
<link linkend="gsize">gsize</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="wire-flush">wire_flush</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="wire-error">wire_error</link> (void);
|
|
<link linkend="void">void</link> <link linkend="wire-clear-error">wire_clear_error</link> (void);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-msg">wire_read_msg</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="WireMessage">WireMessage</link> *msg,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-msg">wire_write_msg</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="WireMessage">WireMessage</link> *msg,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="void">void</link> <link linkend="wire-destroy">wire_destroy</link> (<link linkend="WireMessage">WireMessage</link> *msg);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-int32">wire_read_int32</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint32">guint32</link> *data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-int16">wire_read_int16</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint16">guint16</link> *data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-int8">wire_read_int8</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint8">guint8</link> *data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-double">wire_read_double</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="gdouble">gdouble</link> *data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-string">wire_read_string</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="gchar">gchar</link> **data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-int32">wire_write_int32</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint32">guint32</link> *data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-int16">wire_write_int16</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint16">guint16</link> *data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-int8">wire_write_int8</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint8">guint8</link> *data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-double">wire_write_double</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="gdouble">gdouble</link> *data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-string">wire_write_string</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="gchar">gchar</link> **data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>
|
|
The lowlevel I/O protocol used for communication between GIMP and
|
|
it's plug-ins.
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Details</title>
|
|
<refsect2>
|
|
<title><anchor id="WireMessage"/>WireMessage</title>
|
|
<indexterm><primary>WireMessage</primary></indexterm><programlisting>typedef struct {
|
|
guint32 type;
|
|
gpointer data;
|
|
} WireMessage;
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="WireReadFunc"/>WireReadFunc ()</title>
|
|
<indexterm><primary>WireReadFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*WireReadFunc) (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="WireMessage">WireMessage</link> *msg,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>msg</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="WireWriteFunc"/>WireWriteFunc ()</title>
|
|
<indexterm><primary>WireWriteFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*WireWriteFunc) (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="WireMessage">WireMessage</link> *msg,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>msg</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="WireDestroyFunc"/>WireDestroyFunc ()</title>
|
|
<indexterm><primary>WireDestroyFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*WireDestroyFunc) (<link linkend="WireMessage">WireMessage</link> *msg);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>msg</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="WireIOFunc"/>WireIOFunc ()</title>
|
|
<indexterm><primary>WireIOFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*WireIOFunc) (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint8">guint8</link> *buf,
|
|
<link linkend="gulong">gulong</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>buf</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>count</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="WireFlushFunc"/>WireFlushFunc ()</title>
|
|
<indexterm><primary>WireFlushFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*WireFlushFunc) (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-register"/>wire_register ()</title>
|
|
<indexterm><primary>wire_register</primary></indexterm><programlisting><link linkend="void">void</link> wire_register (<link linkend="guint32">guint32</link> type,
|
|
<link linkend="WireReadFunc">WireReadFunc</link> read_func,
|
|
<link linkend="WireWriteFunc">WireWriteFunc</link> write_func,
|
|
<link linkend="WireDestroyFunc">WireDestroyFunc</link> destroy_func);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>type</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>read_func</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>write_func</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>destroy_func</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-set-reader"/>wire_set_reader ()</title>
|
|
<indexterm><primary>wire_set_reader</primary></indexterm><programlisting><link linkend="void">void</link> wire_set_reader (<link linkend="WireIOFunc">WireIOFunc</link> read_func);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>read_func</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-set-writer"/>wire_set_writer ()</title>
|
|
<indexterm><primary>wire_set_writer</primary></indexterm><programlisting><link linkend="void">void</link> wire_set_writer (<link linkend="WireIOFunc">WireIOFunc</link> write_func);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>write_func</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-set-flusher"/>wire_set_flusher ()</title>
|
|
<indexterm><primary>wire_set_flusher</primary></indexterm><programlisting><link linkend="void">void</link> wire_set_flusher (<link linkend="WireFlushFunc">WireFlushFunc</link> flush_func);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>flush_func</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-read"/>wire_read ()</title>
|
|
<indexterm><primary>wire_read</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint8">guint8</link> *buf,
|
|
<link linkend="gsize">gsize</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>buf</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>count</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-write"/>wire_write ()</title>
|
|
<indexterm><primary>wire_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint8">guint8</link> *buf,
|
|
<link linkend="gsize">gsize</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>buf</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>count</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-flush"/>wire_flush ()</title>
|
|
<indexterm><primary>wire_flush</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_flush (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-error"/>wire_error ()</title>
|
|
<indexterm><primary>wire_error</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_error (void);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-clear-error"/>wire_clear_error ()</title>
|
|
<indexterm><primary>wire_clear_error</primary></indexterm><programlisting><link linkend="void">void</link> wire_clear_error (void);</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-read-msg"/>wire_read_msg ()</title>
|
|
<indexterm><primary>wire_read_msg</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_msg (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="WireMessage">WireMessage</link> *msg,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>msg</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-write-msg"/>wire_write_msg ()</title>
|
|
<indexterm><primary>wire_write_msg</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_msg (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="WireMessage">WireMessage</link> *msg,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>msg</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-destroy"/>wire_destroy ()</title>
|
|
<indexterm><primary>wire_destroy</primary></indexterm><programlisting><link linkend="void">void</link> wire_destroy (<link linkend="WireMessage">WireMessage</link> *msg);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>msg</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-read-int32"/>wire_read_int32 ()</title>
|
|
<indexterm><primary>wire_read_int32</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_int32 (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint32">guint32</link> *data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>count</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-read-int16"/>wire_read_int16 ()</title>
|
|
<indexterm><primary>wire_read_int16</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_int16 (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint16">guint16</link> *data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>count</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-read-int8"/>wire_read_int8 ()</title>
|
|
<indexterm><primary>wire_read_int8</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_int8 (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint8">guint8</link> *data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>count</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-read-double"/>wire_read_double ()</title>
|
|
<indexterm><primary>wire_read_double</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_double (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="gdouble">gdouble</link> *data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>count</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-read-string"/>wire_read_string ()</title>
|
|
<indexterm><primary>wire_read_string</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_string (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="gchar">gchar</link> **data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>count</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-write-int32"/>wire_write_int32 ()</title>
|
|
<indexterm><primary>wire_write_int32</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_int32 (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint32">guint32</link> *data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>count</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-write-int16"/>wire_write_int16 ()</title>
|
|
<indexterm><primary>wire_write_int16</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_int16 (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint16">guint16</link> *data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>count</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-write-int8"/>wire_write_int8 ()</title>
|
|
<indexterm><primary>wire_write_int8</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_int8 (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="guint8">guint8</link> *data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>count</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-write-double"/>wire_write_double ()</title>
|
|
<indexterm><primary>wire_write_double</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_double (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="gdouble">gdouble</link> *data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>count</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="wire-write-string"/>wire_write_string ()</title>
|
|
<indexterm><primary>wire_write_string</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_string (<link linkend="GIOChannel">GIOChannel</link> *channel,
|
|
<link linkend="gchar">gchar</link> **data,
|
|
<link linkend="gint">gint</link> count,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>channel</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>count</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
<title>See Also</title>
|
|
<para>
|
|
<link linkend="libgimp-gimpprotocol"><type>libgimp-gimpprotocol</type></link>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|