<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Jack2: Creating and managing client threads</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Jack2 <span id="projectnumber">1.9.7</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>Creating and managing client threads</h1> </div>
</div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9f8adda8b9aad771b6b3bb663f798264"></a><!-- doxytag: member="ClientThreads::jack_thread_creator_t" ref="ga9f8adda8b9aad771b6b3bb663f798264" args=")(pthread_t *, const pthread_attr_t *, void *(*function)(void *), void *arg)" -->
typedef int(* </td><td class="memItemRight" valign="bottom"><b>jack_thread_creator_t</b> )(pthread_t *, const pthread_attr_t *, void *(*function)(void *), void *arg)</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientThreads.html#ga4ee2fcbb266618d66a2cf354d8c54359">jack_client_real_time_priority</a> (jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientThreads.html#gaa266166c958e1b745ce48ef7ca89890f">jack_client_max_real_time_priority</a> (jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientThreads.html#gaec301b7cb1dcd39d7fc88fa9f769dab8">jack_acquire_real_time_scheduling</a> (jack_native_thread_t thread, int priority) JACK_OPTIONAL_WEAK_EXPORT</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientThreads.html#ga522094adfc39ec4770d8e82bd601e365">jack_client_create_thread</a> (jack_client_t *client, jack_native_thread_t *thread, int priority, int realtime, void *(*start_routine)(void *), void *arg) JACK_OPTIONAL_WEAK_EXPORT</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientThreads.html#ga0d75ca78f4088f515f1befc108f3f2e7">jack_drop_real_time_scheduling</a> (jack_native_thread_t thread) JACK_OPTIONAL_WEAK_EXPORT</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientThreads.html#ga2a9f33ed2464d4b110a27c9c35792b24">jack_client_stop_thread</a> (jack_client_t *client, jack_native_thread_t thread) JACK_OPTIONAL_WEAK_EXPORT</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientThreads.html#gad170c52942d07538dc0b3d4886405526">jack_client_kill_thread</a> (jack_client_t *client, jack_native_thread_t thread) JACK_OPTIONAL_WEAK_EXPORT</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientThreads.html#ga157ab0ade60e266ffd26ddffdb5545af">jack_set_thread_creator</a> (jack_thread_creator_t creator) JACK_OPTIONAL_WEAK_EXPORT</td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga4ee2fcbb266618d66a2cf354d8c54359"></a><!-- doxytag: member="thread.h::jack_client_real_time_priority" ref="ga4ee2fcbb266618d66a2cf354d8c54359" args="(jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_client_real_time_priority </td>
<td>(</td>
<td class="paramtype">jack_client_t * </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>if JACK is running with realtime scheduling, this returns the priority that any JACK-created client threads will run at. Otherwise returns -1. </dd></dl>
<p>Definition at line <a class="el" href="JackAPI_8cpp_source.html#l01737">1737</a> of file <a class="el" href="JackAPI_8cpp_source.html">JackAPI.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="gaa266166c958e1b745ce48ef7ca89890f"></a><!-- doxytag: member="thread.h::jack_client_max_real_time_priority" ref="gaa266166c958e1b745ce48ef7ca89890f" args="(jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_client_max_real_time_priority </td>
<td>(</td>
<td class="paramtype">jack_client_t * </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>if JACK is running with realtime scheduling, this returns the maximum priority that a JACK client thread should use if the thread is subject to realtime scheduling. Otherwise returns -1. </dd></dl>
<p>Definition at line <a class="el" href="JackAPI_8cpp_source.html#l01752">1752</a> of file <a class="el" href="JackAPI_8cpp_source.html">JackAPI.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="gaec301b7cb1dcd39d7fc88fa9f769dab8"></a><!-- doxytag: member="thread.h::jack_acquire_real_time_scheduling" ref="gaec301b7cb1dcd39d7fc88fa9f769dab8" args="(jack_native_thread_t thread, int priority) JACK_OPTIONAL_WEAK_EXPORT" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_acquire_real_time_scheduling </td>
<td>(</td>
<td class="paramtype">jack_native_thread_t </td>
<td class="paramname"><em>thread</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>priority</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Attempt to enable realtime scheduling for a thread. On some systems that may require special privileges.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">thread</td><td>POSIX thread ID. </td></tr>
<tr><td class="paramname">priority</td><td>requested thread priority.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0, if successful; EPERM, if the calling process lacks required realtime privileges; otherwise some other error number. </dd></dl>
<p>Definition at line <a class="el" href="JackAPI_8cpp_source.html#l01767">1767</a> of file <a class="el" href="JackAPI_8cpp_source.html">JackAPI.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ga522094adfc39ec4770d8e82bd601e365"></a><!-- doxytag: member="thread.h::jack_client_create_thread" ref="ga522094adfc39ec4770d8e82bd601e365" args="(jack_client_t *client, jack_native_thread_t *thread, int priority, int realtime, void *(*start_routine)(void *), void *arg) JACK_OPTIONAL_WEAK_EXPORT" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_client_create_thread </td>
<td>(</td>
<td class="paramtype">jack_client_t * </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">jack_native_thread_t * </td>
<td class="paramname"><em>thread</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>priority</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>realtime</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *(*)(void *) </td>
<td class="paramname"><em>start_routine</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a thread for JACK or one of its clients. The thread is created executing <em>start_routine</em> with <em>arg</em> as its sole argument.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>the JACK client for whom the thread is being created. May be NULL if the client is being created within the JACK server. </td></tr>
<tr><td class="paramname">thread</td><td>place to return POSIX thread ID. </td></tr>
<tr><td class="paramname">priority</td><td>thread priority, if realtime. </td></tr>
<tr><td class="paramname">realtime</td><td>true for the thread to use realtime scheduling. On some systems that may require special privileges. </td></tr>
<tr><td class="paramname">start_routine</td><td>function the thread calls when it starts. </td></tr>
<tr><td class="paramname">arg</td><td>parameter passed to the <em>start_routine</em>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0, if successful; otherwise some error number. </dd></dl>
</div>
</div>
<a class="anchor" id="ga0d75ca78f4088f515f1befc108f3f2e7"></a><!-- doxytag: member="thread.h::jack_drop_real_time_scheduling" ref="ga0d75ca78f4088f515f1befc108f3f2e7" args="(jack_native_thread_t thread) JACK_OPTIONAL_WEAK_EXPORT" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_drop_real_time_scheduling </td>
<td>(</td>
<td class="paramtype">jack_native_thread_t </td>
<td class="paramname"><em>thread</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Drop realtime scheduling for a thread.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">thread</td><td>POSIX thread ID.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0, if successful; otherwise an error number. </dd></dl>
<p>Definition at line <a class="el" href="JackAPI_8cpp_source.html#l01786">1786</a> of file <a class="el" href="JackAPI_8cpp_source.html">JackAPI.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ga2a9f33ed2464d4b110a27c9c35792b24"></a><!-- doxytag: member="thread.h::jack_client_stop_thread" ref="ga2a9f33ed2464d4b110a27c9c35792b24" args="(jack_client_t *client, jack_native_thread_t thread) JACK_OPTIONAL_WEAK_EXPORT" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_client_stop_thread </td>
<td>(</td>
<td class="paramtype">jack_client_t * </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">jack_native_thread_t </td>
<td class="paramname"><em>thread</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stop the thread, waiting for the thread handler to terminate.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">thread</td><td>POSIX thread ID.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0, if successful; otherwise an error number. </dd></dl>
<p>Definition at line <a class="el" href="JackAPI_8cpp_source.html#l01791">1791</a> of file <a class="el" href="JackAPI_8cpp_source.html">JackAPI.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="gad170c52942d07538dc0b3d4886405526"></a><!-- doxytag: member="thread.h::jack_client_kill_thread" ref="gad170c52942d07538dc0b3d4886405526" args="(jack_client_t *client, jack_native_thread_t thread) JACK_OPTIONAL_WEAK_EXPORT" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_client_kill_thread </td>
<td>(</td>
<td class="paramtype">jack_client_t * </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">jack_native_thread_t </td>
<td class="paramname"><em>thread</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cancel the thread then waits for the thread handler to terminate.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">thread</td><td>POSIX thread ID.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0, if successful; otherwise an error number. </dd></dl>
<p>Definition at line <a class="el" href="JackAPI_8cpp_source.html#l01799">1799</a> of file <a class="el" href="JackAPI_8cpp_source.html">JackAPI.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ga157ab0ade60e266ffd26ddffdb5545af"></a><!-- doxytag: member="thread.h::jack_set_thread_creator" ref="ga157ab0ade60e266ffd26ddffdb5545af" args="(jack_thread_creator_t creator) JACK_OPTIONAL_WEAK_EXPORT" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jack_set_thread_creator </td>
<td>(</td>
<td class="paramtype">jack_thread_creator_t </td>
<td class="paramname"><em>creator</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function can be used in very very specialized cases where it is necessary that client threads created by JACK are created by something other than pthread_create(). After it is used, any threads that JACK needs for the client will will be created by calling the function passed to this function.</p>
<p>No normal application/client should consider calling this. The specific case for which it was created involves running win32/x86 plugins under Wine on Linux, where it is necessary that all threads that might call win32 functions are known to Wine.</p>
<p>Set it to NULL to restore thread creation function.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">creator</td><td>a function that creates a new thread </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="JackAPI_8cpp_source.html#l01808">1808</a> of file <a class="el" href="JackAPI_8cpp_source.html">JackAPI.cpp</a>.</p>
</div>
</div>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated for Jack2 by <a href="http://www.doxygen.org/
index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>
1.7.3</small></address>
</body>
</html>
