diff options
Diffstat (limited to 'static/freebsd/man3/sigevent.3 3.html')
| -rw-r--r-- | static/freebsd/man3/sigevent.3 3.html | 134 |
1 files changed, 0 insertions, 134 deletions
diff --git a/static/freebsd/man3/sigevent.3 3.html b/static/freebsd/man3/sigevent.3 3.html deleted file mode 100644 index 794ab90d..00000000 --- a/static/freebsd/man3/sigevent.3 3.html +++ /dev/null @@ -1,134 +0,0 @@ -<table class="head"> - <tr> - <td class="head-ltitle">SIGEVENT(3)</td> - <td class="head-vol">Library Functions Manual</td> - <td class="head-rtitle">SIGEVENT(3)</td> - </tr> -</table> -<div class="manual-text"> -<section class="Sh"> -<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> -<p class="Pp"><code class="Nm">sigevent</code> — - <span class="Nd">asynchronous event notification</span></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> -<p class="Pp"><code class="In">#include - <<a class="In">signal.h</a>></code></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> -<p class="Pp">Some operations permit threads to request asynchronous - notification of events via a <var class="Vt">struct sigevent</var> - structure. This structure contains several fields that describe the - requested notification:</p> -<table class="Bl-column"> - <tr id="Type"> - <td><a class="permalink" href="#Type"><b class="Sy">Type</b></a></td> - <td><a class="permalink" href="#Member"><b class="Sy" id="Member">Member</b></a></td> - <td><a class="permalink" href="#Description"><b class="Sy" id="Description">Description</b></a></td> - </tr> - <tr> - <td><var class="Vt">int</var></td> - <td>sigev_notify</td> - <td>notification method</td> - </tr> - <tr> - <td><var class="Vt">int</var></td> - <td>sigev_signo</td> - <td>signal number</td> - </tr> - <tr> - <td><var class="Vt">union sigval</var></td> - <td>sigev_value</td> - <td>signal value</td> - </tr> - <tr> - <td><var class="Vt">int</var></td> - <td>sigev_notify_kqueue</td> - <td><a class="Xr">kqueue(2)</a> file descriptor</td> - </tr> - <tr> - <td><var class="Vt">unsigned short</var></td> - <td>sigev_notify_kevent_flags</td> - <td>kevent flags</td> - </tr> - <tr> - <td><var class="Vt">lwpid_t</var></td> - <td>sigev_notify_thread_id</td> - <td>LWP ID</td> - </tr> - <tr> - <td><var class="Vt">void (*)(union sigval)</var></td> - <td>sigev_notify_function</td> - <td>callback function pointer</td> - </tr> - <tr> - <td><var class="Vt">pthread_attr_t *</var></td> - <td>sigev_notify_attributes</td> - <td>callback thread attributes</td> - </tr> -</table> -<p class="Pp">The <var class="Va">sigev_notify</var> field specifies the - notification method used when the event triggers:</p> -<dl class="Bl-tag"> - <dt id="SIGEV_NONE"><a class="permalink" href="#SIGEV_NONE"><code class="Dv">SIGEV_NONE</code></a></dt> - <dd>No notification is sent.</dd> - <dt id="SIGEV_SIGNAL"><a class="permalink" href="#SIGEV_SIGNAL"><code class="Dv">SIGEV_SIGNAL</code></a></dt> - <dd>The signal <var class="Va">sigev_signo</var> is queued as a real-time - signal to the calling process. The value stored in - <var class="Va">sigev_value</var> will be present in the - <var class="Va">si_value</var> of the <var class="Vt">siginfo_t</var> - structure of the queued signal.</dd> - <dt id="SIGEV_THREAD"><a class="permalink" href="#SIGEV_THREAD"><code class="Dv">SIGEV_THREAD</code></a></dt> - <dd>The notification function in <var class="Va">sigev_notify_function</var> - is called in a separate thread context. The thread is created with the - attributes specified in <var class="Va">*sigev_notify_attributes</var>. - The value stored in <var class="Va">sigev_value</var> is passed as the - sole argument to <var class="Va">sigev_notify_function</var>. If - <var class="Va">sigev_notify_attributes</var> is - <code class="Dv">NULL</code>, the thread is created with default - attributes.</dd> - <dt id="SIGEV_KEVENT"><a class="permalink" href="#SIGEV_KEVENT"><code class="Dv">SIGEV_KEVENT</code></a></dt> - <dd>A new kevent is posted to the kqueue - <var class="Va">sigev_notify_kqueue</var>. The <var class="Va">udata</var> - member of the kevent structure contains the value stored in - <var class="Va">sigev_value</var>. The meaning of other fields in the - kevent are specific to the type of triggered event.</dd> - <dt id="SIGEV_THREAD_ID"><a class="permalink" href="#SIGEV_THREAD_ID"><code class="Dv">SIGEV_THREAD_ID</code></a></dt> - <dd>The signal <var class="Va">sigev_signo</var> is queued to the thread whose - LWP ID is <var class="Va">sigev_notify_thread_id</var>. The value stored - in <var class="Va">sigev_value</var> will be present in the - <var class="Va">si_value</var> of the <var class="Vt">siginfo_t</var> - structure of the queued signal.</dd> -</dl> -</section> -<section class="Sh"> -<h1 class="Sh" id="NOTES"><a class="permalink" href="#NOTES">NOTES</a></h1> -<p class="Pp">Note that programs wishing to use - <code class="Dv">SIGEV_THREAD</code> notifications must link against the - <span class="Lb">POSIX Real-time Library (librt, -lrt)</span>.</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE - ALSO</a></h1> -<p class="Pp"><a class="Xr">aio_read(2)</a>, <a class="Xr">mq_notify(2)</a>, - <a class="Xr">timer_create(2)</a>, <a class="Xr">siginfo(3)</a></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="STANDARDS"><a class="permalink" href="#STANDARDS">STANDARDS</a></h1> -<p class="Pp">The <var class="Vt">struct sigevent</var> type conforms to - <span class="St">IEEE Std 1003.1-2004 (“POSIX.1”)</span>.</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> -<p class="Pp">The <var class="Va">sigevent</var> structure first appeared in - <span class="Ux">FreeBSD 3.3</span>.</p> -</section> -</div> -<table class="foot"> - <tr> - <td class="foot-date">February 25, 2020</td> - <td class="foot-os">FreeBSD 15.0</td> - </tr> -</table> |