<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<!-- THIS FILE IS AUTOMATICALLY GENERATED FROM THE GLOBUS SOURCE CODE
DO NOT MODIFY.
-->
<title>Globus Reference Manual</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<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>Data Structures</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('group__globus__callback__signal.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Globus Callback Signal Handling</div> </div>
</div>
<div class="contents">
<p>
<a href="main.html" target="_top">View documentation without frames</a><br>
<a href="index.html" target="_top">View documentation with frames</a><br>
<a href="#details">More...</a></p>
<h2><a name="define-members"></a>
Defines</h2>
<ul>
<li>#define <a class="el" href="group__globus__callback__signal.html#ga69254c1d4e46a0f034ad4fa0c2544e8e">GLOBUS_SIGNAL_INTERRUPT</a>
</ul>
<h2><a name="func-members"></a>
Functions</h2>
<ul>
<li>globus_result_t <a class="el" href="group__globus__callback__signal.html#ga73dd8a0afb4683a89b38c1c5e02db33e">globus_callback_space_register_signal_handler</a> (int signum, globus_bool_t persist, <a class="el" href="group__globus__callback__api.html#gaf9532eb7d40466d5af31fe6ba2b9a6a3">globus_callback_func_t</a> callback_func, void *callback_user_arg, <a class="el" href="group__globus__callback.html#ga82637fa200d6ff891c747397a8eb0f38">globus_callback_space_t</a> space)
<li>globus_result_t <a class="el" href="group__globus__callback__signal.html#ga188f696c9ecbac1b022012b61756c47b">globus_callback_unregister_signal_handler</a> (int signum, <a class="el" href="group__globus__callback__api.html#gaf9532eb7d40466d5af31fe6ba2b9a6a3">globus_callback_func_t</a> unregister_callback, void *unreg_arg)
<li>void <a class="el" href="group__globus__callback__signal.html#ga161a6324f166f939e450b9459cf6aafa">globus_callback_add_wakeup_handler</a> (void(*wakeup)(void *), void *user_arg)
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<a href="main.html" target="_top">View documentation without frames</a><br>
<a href="index.html" target="_top">View documentation with frames</a><br>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga69254c1d4e46a0f034ad4fa0c2544e8e"></a><!-- doxytag: member="globus_callback.h::GLOBUS_SIGNAL_INTERRUPT" ref="ga69254c1d4e46a0f034ad4fa0c2544e8e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GLOBUS_SIGNAL_INTERRUPT</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Use this to trap interrupts (SIGINT on unix). In the future, this will also map to handle ctrl-C on win32. </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga73dd8a0afb4683a89b38c1c5e02db33e"></a><!-- doxytag: member="globus_callback.h::globus_callback_space_register_signal_handler" ref="ga73dd8a0afb4683a89b38c1c5e02db33e" args="(int signum, globus_bool_t persist, globus_callback_func_t callback_func, void *callback_user_arg, globus_callback_space_t space)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_callback_space_register_signal_handler </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>signum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t </td>
<td class="paramname"><em>persist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__callback__api.html#gaf9532eb7d40466d5af31fe6ba2b9a6a3">globus_callback_func_t</a> </td>
<td class="paramname"><em>callback_func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>callback_user_arg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__callback.html#ga82637fa200d6ff891c747397a8eb0f38">globus_callback_space_t</a> </td>
<td class="paramname"><em>space</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fire a callback when the specified signal is received. </p>
<p>Note that there is a tiny delay between the time this call returns and the signal is actually handled by this library. It is likely that, if the signal was received the instant the call returned, it will be lost (this is normally not an issue, since you would call this in your startup code anyway)</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">signum</td><td>The signal to receive. The following signals are not allowed: SIGKILL, SIGSEGV, SIGABRT, SIGBUS, SIGFPE, SIGILL, SIGIOT, SIGPIPE, SIGEMT, SIGSYS, SIGTRAP, SIGSTOP, SIGCONT, and SIGWAITING</td></tr>
<tr><td class="paramname">persist</td><td>If GLOBUS_TRUE, keep this callback registered for multiple signals. If GLOBUS_FALSE, the signal handler will automatically be unregistered once the signal has been received.</td></tr>
<tr><td class="paramname">callback_func</td><td>the user func to call when a signal is received</td></tr>
<tr><td class="paramname">callback_user_arg</td><td>user arg that will be passed to callback</td></tr>
<tr><td class="paramname">space</td><td>the space to deliver callbacks to.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>GLOBUS_CALLBACK_ERROR_INVALID_SPACE</li>
<li>GLOBUS_CALLBACK_ERROR_INVALID_ARGUMENT</li>
<li>GLOBUS_SUCCESS otherwise </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="ga188f696c9ecbac1b022012b61756c47b"></a><!-- doxytag: member="globus_callback.h::globus_callback_unregister_signal_handler" ref="ga188f696c9ecbac1b022012b61756c47b" args="(int signum, globus_callback_func_t unregister_callback, void *unreg_arg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_callback_unregister_signal_handler </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>signum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__callback__api.html#gaf9532eb7d40466d5af31fe6ba2b9a6a3">globus_callback_func_t</a> </td>
<td class="paramname"><em>unregister_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>unreg_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unregister a signal handling callback. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">signum</td><td>The signal to unregister.</td></tr>
<tr><td class="paramname">unregister_callback</td><td>the function to call when the callback has been canceled and there are no running instances of it (may be NULL). This will be delivered to the same space used in the register call.</td></tr>
<tr><td class="paramname">unreg_arg</td><td>user arg that will be passed to callback</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>GLOBUS_CALLBACK_ERROR_INVALID_ARGUMENT if this signal was registered with persist == false, then there is a race between a signal actually being caught and therefor automatically unregistered and the attempt to manually unregister it. If that race occurs, you will receive this error just as you would for any signal not registered.</li>
<li>GLOBUS_SUCCESS otherwise </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="ga161a6324f166f939e450b9459cf6aafa"></a><!-- doxytag: member="globus_callback.h::globus_callback_add_wakeup_handler" ref="ga161a6324f166f939e450b9459cf6aafa" args="(void(*wakeup)(void *), void *user_arg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void globus_callback_add_wakeup_handler </td>
<td>(</td>
<td class="paramtype">void(*)(void *) </td>
<td class="paramname"><em>wakeup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>user_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Register a wakeup handler with callback library. </p>
<p>This is really only needed in non-threaded builds, but for cross builds should be used everywhere that a callback may sleep for an extended period of time.</p>
<p>An example use is for an io poller that sleeps indefinitely on select(). If the callback library receives a signal that it needs to deliver asap, it will call the wakeup handler(s), These wakeup handlers must run as though they were called from a signal handler (don't use any thread utilities). The io poll example will likely write a single byte to a pipe that select() is monitoring.</p>
<p>This handler will not be unregistered until the callback library is deactivated (via common).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">wakeup</td><td>function to call when callback library needs you to return asap from any blocked callbacks.</td></tr>
<tr><td class="paramname">user_arg</td><td>user data that will be passed along in the wakeup handler </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<hr>
<p align="center">
<a href="http://www.globus.org/toolkit/about.html" target="_top">about globus</a> |
<a href="http://www.globus.org/toolkit/" target="_top">globus toolkit</a> |
<a href="https://dev.globus.org/wiki/Welcome/" target="_top">dev.globus</a>
<br>
<br>
Comments? <a href="mailto:webmaster@globus.org">webmaster@globus.org</a>
</body>
</html>
