<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>torque: Remembering submitted job in session.</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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">torque
 <span id="projectnumber">4.1.6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Groups</a></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 class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Remembering submitted job in session.</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structdrmaa__job__s.html">drmaa_job_s</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Job data stored for each submitted job. <a href="structdrmaa__job__s.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structdrmaa__job__iter__s.html">drmaa_job_iter_s</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Iterates over submitted jobs set. <a href="structdrmaa__job__iter__s.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gad3c7cbaf09433ee3aabb22c5f0373c28"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__jobs.html#gad3c7cbaf09433ee3aabb22c5f0373c28">drmaa_get_job_list_iter</a> (<a class="el" href="structdrmaa__session__s.html">drmaa_session_t</a> *session, <a class="el" href="structdrmaa__job__iter__s.html">drmaa_job_iter_t</a> *iter)</td></tr>
<tr class="memdesc:gad3c7cbaf09433ee3aabb22c5f0373c28"><td class="mdescLeft"> </td><td class="mdescRight">Returns iterator to jobs held in DRMAA session. <a href="#gad3c7cbaf09433ee3aabb22c5f0373c28">More...</a><br/></td></tr>
<tr class="separator:gad3c7cbaf09433ee3aabb22c5f0373c28"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa4ef703be27ef81a310a419bbd35163f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structdrmaa__job__s.html">drmaa_job_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__jobs.html#gaa4ef703be27ef81a310a419bbd35163f">drmaa_get_next_job</a> (<a class="el" href="structdrmaa__job__iter__s.html">drmaa_job_iter_t</a> *iter)</td></tr>
<tr class="memdesc:gaa4ef703be27ef81a310a419bbd35163f"><td class="mdescLeft"> </td><td class="mdescRight">Returns next job identifier from set or <code>NULL</code> if set finished. <a href="#gaa4ef703be27ef81a310a419bbd35163f">More...</a><br/></td></tr>
<tr class="separator:gaa4ef703be27ef81a310a419bbd35163f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3a3bd5a8d4f1442deedd8f661e58773e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__jobs.html#ga3a3bd5a8d4f1442deedd8f661e58773e">drmaa_add_job</a> (<a class="el" href="structdrmaa__session__s.html">drmaa_session_t</a> *c, <a class="el" href="structdrmaa__job__s.html">drmaa_job_t</a> *job)</td></tr>
<tr class="memdesc:ga3a3bd5a8d4f1442deedd8f661e58773e"><td class="mdescLeft"> </td><td class="mdescRight">Adds job identifier to session. <a href="#ga3a3bd5a8d4f1442deedd8f661e58773e">More...</a><br/></td></tr>
<tr class="separator:ga3a3bd5a8d4f1442deedd8f661e58773e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga21f11f281d7c29f24b98fb091ca59e1a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__jobs.html#ga21f11f281d7c29f24b98fb091ca59e1a">drmaa_find_job</a> (<a class="el" href="structdrmaa__session__s.html">drmaa_session_t</a> *c, const char *jobid, <a class="el" href="structdrmaa__job__s.html">drmaa_job_t</a> *found, unsigned flags)</td></tr>
<tr class="memdesc:ga21f11f281d7c29f24b98fb091ca59e1a"><td class="mdescLeft"> </td><td class="mdescRight">Checks if job with given identifier exist in hash table and optionally removes it. <a href="#ga21f11f281d7c29f24b98fb091ca59e1a">More...</a><br/></td></tr>
<tr class="separator:ga21f11f281d7c29f24b98fb091ca59e1a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gad3c7cbaf09433ee3aabb22c5f0373c28"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void drmaa_get_job_list_iter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structdrmaa__session__s.html">drmaa_session_t</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structdrmaa__job__iter__s.html">drmaa_job_iter_t</a> * </td>
<td class="paramname"><em>iter</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns iterator to jobs held in DRMAA session. </p>
<p>Caller thread should have <a class="el" href="structdrmaa__session__s.html#aaec16c7388f36b0f8d82f3bc96529106" title=" Mutex for #jt_list, #job_list and next_time_label. ">drmaa_session_s::jobs_mutex</a> acquired iterator remains valid until job list is modified (or lock is released). </p>
</div>
</div>
<a class="anchor" id="gaa4ef703be27ef81a310a419bbd35163f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structdrmaa__job__s.html">drmaa_job_t</a>* drmaa_get_next_job </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structdrmaa__job__iter__s.html">drmaa_job_iter_t</a> * </td>
<td class="paramname"><em>iter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns next job identifier from set or <code>NULL</code> if set finished. </p>
</div>
</div>
<a class="anchor" id="ga3a3bd5a8d4f1442deedd8f661e58773e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void drmaa_add_job </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structdrmaa__session__s.html">drmaa_session_t</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structdrmaa__job__s.html">drmaa_job_t</a> * </td>
<td class="paramname"><em>job</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds job identifier to session. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>DRMAA session. </td></tr>
<tr><td class="paramname">job</td><td>Malloced drmaa_job_t structure with filled jobid field (also malloced). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga21f11f281d7c29f24b98fb091ca59e1a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool drmaa_find_job </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structdrmaa__session__s.html">drmaa_session_t</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>jobid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structdrmaa__job__s.html">drmaa_job_t</a> * </td>
<td class="paramname"><em>found</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if job with given identifier exist in hash table and optionally removes it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>Opened DRMAA session. </td></tr>
<tr><td class="paramname">jobid</td><td>Job identifier. </td></tr>
<tr><td class="paramname">found</td><td>If not <code>NULL</code> and job was found job session data will be stored here. </td></tr>
<tr><td class="paramname">flags</td><td>Information to store into session. If DRMAA_JOB_DISPOSE bit is set session data will be removed. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd>job_flag_t </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Nov 14 2013 18:07:37 for torque by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
