<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<!-- lifted from troff+man by doclifter -->
<refentry id='xintconnman'>
<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium -->

<!--  Permission is hereby granted, free of charge, to any person obtaining -->
<!--  a copy of this software and associated documentation files (the -->
<!--  "Software"), to deal in the Software without restriction, including -->
<!--  without limitation the rights to use, copy, modify, merge, publish, -->
<!--  distribute, sublicense, and/or sell copies of the Software, and to -->
<!--  permit persons to whom the Software is furnished to do so, subject to -->
<!--  the following conditions: -->

<!--  The above copyright notice and this permission notice shall be included -->
<!--  in all copies or substantial portions of the Software. -->

<!--  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS -->
<!--  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -->
<!--  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -->
<!--  IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR -->
<!--  OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -->
<!--  ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -->
<!--  OTHER DEALINGS IN THE SOFTWARE. -->

<!--  Except as contained in this notice, the name of the X Consortium shall -->
<!--  not be used in advertising or otherwise to promote the sale, use or -->
<!--  other dealings in this Software without prior written authorization -->
<!--  from the X Consortium. -->

<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by -->
<!--  Digital Equipment Corporation -->

<!--  Portions Copyright \(co 1990, 1991 by -->
<!--  Tektronix, Inc. -->

<!--  Permission to use, copy, modify and distribute this documentation for -->
<!--  any purpose and without fee is hereby granted, provided that the above -->
<!--  copyright notice appears in all copies and that both that copyright notice -->
<!--  and this permission notice appear in all copies, and that the names of -->
<!--  Digital and Tektronix not be used in in advertising or publicity pertaining -->
<!--  to this documentation without specific, written prior permission. -->
<!--  Digital and Tektronix makes no representations about the suitability -->
<!--  of this documentation for any purpose. -->
<!--  It is provided ``as is'' without express or implied warranty. -->
<!--   -->
<!--  $XFree86: xc/doc/man/X11/XIntConn.man,v 1.4 2003/04/28 22:17:55 herrb Exp $ -->

<!-- .na -->
<!-- Ds listing suppressed (not used) -->
<!-- De listing suppressed (not used) -->
<!-- FD listing suppressed (not used) -->
<!-- FN listing suppressed (not used) -->
<!-- IN listing suppressed (not used) -->
<!-- C{ listing suppressed (not used) -->
<!-- C} listing suppressed (not used) -->
<!-- Pn listing suppressed (not used) -->
<!-- hN listing suppressed (not used) -->
<!-- NT listing suppressed (not used) -->
<!-- .		\" Note End \-\- doug kraft 3/85 -->
<!-- NE listing suppressed (not used) -->
<!-- .ny0 -->
<refmeta>
<refentrytitle>XAddConnectionWatch</refentrytitle>
<manvolnum>3X11</manvolnum>
<refmiscinfo class='date'>__xorgversion__</refmiscinfo>
<refmiscinfo class='source'>XLIB FUNCTIONS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>XAddConnectionWatch</refname>
<refname>XRemoveConnectionWatch</refname>
<refname>XProcessInternalConnection</refname>
<refname>XInternalConnectionNumbers</refname>
<refpurpose>handle Xlib internal connections</refpurpose>
</refnamediv>
<!-- body begins here -->

<refsect1 id='syntax'><title>SYNTAX</title>

<para>typedef void (*XConnectionWatchProc)&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, XPointer
<emphasis remap='I'>client_data</emphasis>&hairsp;, int <emphasis remap='I'>fd</emphasis>&hairsp;, Bool <emphasis remap='I'>opening</emphasis>&hairsp;, XPointer
*<emphasis remap='I'>watch_data</emphasis>&hairsp;);</para> 

<para>Status XAddConnectionWatch&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, XWatchProc
<emphasis remap='I'>procedure</emphasis>&hairsp;, XPointer <emphasis remap='I'>client_data</emphasis>&hairsp;);</para> 

<para>Status XRemoveConnectionWatch&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, XWatchProc
<emphasis remap='I'>procedure</emphasis>&hairsp;, XPointer <emphasis remap='I'>client_data</emphasis>&hairsp;);</para> 

<para>void XProcessInternalConnection&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, int <emphasis remap='I'>fd</emphasis>&hairsp;);</para>

<para>Status XInternalConnectionNumbers&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, int
**<emphasis remap='I'>fd_return</emphasis>&hairsp;, int *<emphasis remap='I'>count_return</emphasis>&hairsp;);</para> 
</refsect1>

<refsect1 id='arguments'><title>ARGUMENTS</title>
<variablelist remap='IP'>
  <varlistentry>
  <term><emphasis remap='I'>client_data</emphasis></term>
  <listitem>
<para>Specifies the additional client data.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>count_return</emphasis></term>
  <listitem>
<para>Returns the number of file descriptors.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>display</emphasis></term>
  <listitem>
<para>Specifies the connection to the X server.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>fd</emphasis></term>
  <listitem>
<para>Specifies the file descriptor.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>fd_return</emphasis></term>
  <listitem>
<para>Returns the file descriptors.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>procedure</emphasis></term>
  <listitem>
<para>Specifies the procedure to be called.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>The
<emphasis remap='I'>&hairsp;XAddConnectionWatch&hairsp;</emphasis>
function registers a procedure to be called each time Xlib opens or closes an
internal connection for the specified display.  The procedure is passed the
display, the specified client_data, the file descriptor for the connection,
a Boolean indicating whether the connection is being opened or closed, and a
pointer to a location for private watch data.  If opening is
<emphasis remap='I'>&hairsp;True&hairsp;</emphasis>,
the procedure can store a pointer to private data in the location pointed
to by watch_data;
when the procedure is later called for this same connection and opening is
<emphasis remap='I'>&hairsp;False&hairsp;</emphasis>,
the location pointed to by watch_data will hold this same private data pointer.</para>

<para>This function can be called at any time after a display is opened.
If internal connections already exist, the registered procedure will
immediately be called for each of them, before
<emphasis remap='I'>&hairsp;XAddConnectionWatch&hairsp;</emphasis>
returns.
<emphasis remap='I'>&hairsp;XAddConnectionWatch&hairsp;</emphasis>
returns a nonzero status if the procedure is successfully registered;
otherwise, it returns zero.</para>

<para>The registered procedure should not call any Xlib functions.
If the procedure directly or indirectly causes the state of internal
connections or watch procedures to change, the result is not defined.
If Xlib has been initialized for threads, the procedure is called with
the display locked and the result of a call by the procedure to any
Xlib function that locks the display is not defined unless the executing
thread has externally locked the display using
<emphasis remap='I'>&hairsp;XLockDisplay&hairsp;</emphasis>.</para>

<para>The
<emphasis remap='I'>&hairsp;XRemoveConnectionWatch&hairsp;</emphasis>
function removes a previously registered connection watch procedure.
The client_data must match the client_data used when the procedure
was initially registered.</para>


<para>The
<emphasis remap='I'>&hairsp;XProcessInternalConnection&hairsp;</emphasis>
function processes input available on an internal connection.
This function should be called for an internal connection only
after an operating system facility (for example,
<emphasis remap='I'>&hairsp;select&hairsp;</emphasis>
or
<emphasis remap='I'>&hairsp;poll&hairsp;</emphasis>)
has indicated that input is available; otherwise,
the effect is not defined.</para>

<para>The
<emphasis remap='I'>&hairsp;XInternalConnectionNumbers&hairsp;</emphasis>
function returns a list of the file descriptors for all internal
connections currently open for the specified display.
When the allocated list is no longer needed,
free it by using
<emphasis remap='I'>&hairsp;XFree&hairsp;</emphasis>.
This functions returns a nonzero status if the list is successfully allocated;
otherwise, it returns zero.</para>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para><userinput>Xlib - C Language X Interface</userinput></para>
</refsect1>
</refentry>

