| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.9.1"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Proton DotNet: Apache.Qpid.Proton.Client.Concurrent.IScheduledTask Interface Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Proton DotNet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.1 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceApache.html">Apache</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid.html">Qpid</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html">Client</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent.html">Concurrent</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1IScheduledTask.html">IScheduledTask</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1IScheduledTask-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Client.Concurrent.IScheduledTask Interface Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Represents a scheduled item of work that will be run on the event loop either once or on a repeating basis. The task allows for easy cancelation and for asynchronous awaits via the return completion Task. |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1IScheduledTask.html#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a594c4ac602dff83db221f8d46271770d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1IScheduledTask.html#a594c4ac602dff83db221f8d46271770d">Cancel</a> ()</td></tr> |
| <tr class="memdesc:a594c4ac602dff83db221f8d46271770d"><td class="mdescLeft"> </td><td class="mdescRight">Request to cancel the scheduled task if possible, returns true if the task was canceled before it ran, false otherwise. If the Task is a periodic variant then all future executions are cancelled as well. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1IScheduledTask.html#a594c4ac602dff83db221f8d46271770d">More...</a><br /></td></tr> |
| <tr class="separator:a594c4ac602dff83db221f8d46271770d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:ae17e7aa5879fc5bb098d4e7bb0e0df2c"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1IScheduledTask.html#ae17e7aa5879fc5bb098d4e7bb0e0df2c">Delay</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ae17e7aa5879fc5bb098d4e7bb0e0df2c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the delay time in as high of precision as possible for the time the task executes and the next iteration if this task is periodic. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1IScheduledTask.html#ae17e7aa5879fc5bb098d4e7bb0e0df2c">More...</a><br /></td></tr> |
| <tr class="separator:ae17e7aa5879fc5bb098d4e7bb0e0df2c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa08d599b02d19737bf65b3269f98199f"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1IScheduledTask.html#aa08d599b02d19737bf65b3269f98199f">Deadline</a><code> [get]</code></td></tr> |
| <tr class="memdesc:aa08d599b02d19737bf65b3269f98199f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the next time to run in as high of precision value as possible in the current environment. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1IScheduledTask.html#aa08d599b02d19737bf65b3269f98199f">More...</a><br /></td></tr> |
| <tr class="separator:aa08d599b02d19737bf65b3269f98199f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a777da1c8f7dc501ce6d0fc55dc49f80e"><td class="memItemLeft" align="right" valign="top">Task </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1IScheduledTask.html#a777da1c8f7dc501ce6d0fc55dc49f80e">CompletionTask</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a777da1c8f7dc501ce6d0fc55dc49f80e"><td class="mdescLeft"> </td><td class="mdescRight">A Task that can be awaited for scheduled work that is not periodic in nature. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1IScheduledTask.html#a777da1c8f7dc501ce6d0fc55dc49f80e">More...</a><br /></td></tr> |
| <tr class="separator:a777da1c8f7dc501ce6d0fc55dc49f80e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Represents a scheduled item of work that will be run on the event loop either once or on a repeating basis. The task allows for easy cancelation and for asynchronous awaits via the return completion Task. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a594c4ac602dff83db221f8d46271770d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a594c4ac602dff83db221f8d46271770d">◆ </a></span>Cancel()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Apache.Qpid.Proton.Client.Concurrent.IScheduledTask.Cancel </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Request to cancel the scheduled task if possible, returns true if the task was canceled before it ran, false otherwise. If the Task is a periodic variant then all future executions are cancelled as well. </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if cancelled, false otherwise</dd></dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a777da1c8f7dc501ce6d0fc55dc49f80e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a777da1c8f7dc501ce6d0fc55dc49f80e">◆ </a></span>CompletionTask</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Task Apache.Qpid.Proton.Client.Concurrent.IScheduledTask.CompletionTask</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>A Task that can be awaited for scheduled work that is not periodic in nature. </p> |
| |
| </div> |
| </div> |
| <a id="aa08d599b02d19737bf65b3269f98199f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa08d599b02d19737bf65b3269f98199f">◆ </a></span>Deadline</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">long Apache.Qpid.Proton.Client.Concurrent.IScheduledTask.Deadline</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the next time to run in as high of precision value as possible in the current environment. </p> |
| |
| </div> |
| </div> |
| <a id="ae17e7aa5879fc5bb098d4e7bb0e0df2c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae17e7aa5879fc5bb098d4e7bb0e0df2c">◆ </a></span>Delay</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">long Apache.Qpid.Proton.Client.Concurrent.IScheduledTask.Delay</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the delay time in as high of precision as possible for the time the task executes and the next iteration if this task is periodic. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>src/Proton.Client/Client/Concurrent/IScheduledTask.cs</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 |
| </small></address> |
| </body> |
| </html> |