<!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>
</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__seg__api.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Scheduler Implementation API</div> </div>
</div>
<div class="contents">
<p>Scheduler-specific SEG module implementations use this API to issue events to the Job State Monitor.
<a href="#details">More...</a></p>
<h2><a name="enum-members"></a>
Enumerations</h2>
<ul>
<li>enum <a class="el" href="group__seg__api.html#gaa29c1cfa33861c949e2dc997cd6dc810">globus_scheduler_event_generator_error_t</a> { <br/>
  <a class="el" href="group__seg__api.html#ggaa29c1cfa33861c949e2dc997cd6dc810ad7fb6af0c7d525f25e9059bb17623fb3">GLOBUS_SEG_ERROR_TYPE_NULL</a> = 1024,
<br/>
  <a class="el" href="group__seg__api.html#ggaa29c1cfa33861c949e2dc997cd6dc810a6e15f7acfd057d6dd51645ccfd4f3ae2">GLOBUS_SEG_ERROR_TYPE_ALREADY_SET</a>,
<br/>
  <a class="el" href="group__seg__api.html#ggaa29c1cfa33861c949e2dc997cd6dc810a181db7ccb5306e14c34bf7eff0bc459f">GLOBUS_SEG_ERROR_TYPE_INVALID_MODULE</a>,
<br/>
  <a class="el" href="group__seg__api.html#ggaa29c1cfa33861c949e2dc997cd6dc810ab68b22a908c4aeff7e8436bfff39be0b">GLOBUS_SEG_ERROR_TYPE_INVALID_FORMAT</a>,
<br/>
  <a class="el" href="group__seg__api.html#ggaa29c1cfa33861c949e2dc997cd6dc810a6bdccb8e7b619b70acd62f76b8970320">GLOBUS_SEG_ERROR_TYPE_OUT_OF_MEMORY</a>,
<br/>
  <a class="el" href="group__seg__api.html#ggaa29c1cfa33861c949e2dc997cd6dc810a7c0e47d4b55ccc50cf17835cdd78cbbb">GLOBUS_SEG_ERROR_TYPE_LOADING_MODULE</a>
<br/>
}
</ul>
<h2><a name="func-members"></a>
Functions</h2>
<ul>
<li>globus_result_t <a class="el" href="group__seg__api.html#ga0cc2761894b44cdfd0ea237847248930">globus_scheduler_event</a> (const char *format,...)
<li>globus_result_t <a class="el" href="group__seg__api.html#gaec7e2bf248ef2e149d344dcd427e1f44">globus_scheduler_event_pending</a> (time_t timestamp, const char *jobid)
<li>globus_result_t <a class="el" href="group__seg__api.html#gadbc82d3dc051291718bb67cf348cdc3d">globus_scheduler_event_active</a> (time_t timestamp, const char *jobid)
<li>globus_result_t <a class="el" href="group__seg__api.html#ga4690bf8649c0e5e6a2bba5f557f01030">globus_scheduler_event_failed</a> (time_t timestamp, const char *jobid, int failure_code)
<li>globus_result_t <a class="el" href="group__seg__api.html#gad47c2e6c20ef7409f1a30da129c35be6">globus_scheduler_event_done</a> (time_t timestamp, const char *jobid, int exit_code)
<li>globus_result_t <a class="el" href="group__seg__api.html#ga961078a3a990cc0f0fa23f814e170f82">globus_scheduler_event_generator_get_timestamp</a> (time_t *timestamp)
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Scheduler-specific SEG module implementations use this API to issue events to the Job State Monitor. </p>
<p>Events occur whenever a job is placed in the scheduler's queue (PENDING), begins execution (ACTIVE), terminates successfully (DONE), or ends abnormally (FAILED).</p>
<p>A SEG module should register an event with the Globus event driver (most likely using either the Globus Callback or Globus XIO interfaces) in its activation function and then return. All events should be triggered from callbacks. When the SEG detects that it should terminate, it will deactivate the SEG module it started. The SEG module should wait for any outstanding callbacks to subside and before returning from its deactivation function to ensure that all events will be properly dispatched. After deactivation is complete, the SEG will unload the shared module and terminate. </p>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="gaa29c1cfa33861c949e2dc997cd6dc810"></a><!-- doxytag: member="globus_scheduler_event_generator.h::globus_scheduler_event_generator_error_t" ref="gaa29c1cfa33861c949e2dc997cd6dc810" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__seg__api.html#gaa29c1cfa33861c949e2dc997cd6dc810">globus_scheduler_event_generator_error_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Error types used by the SEG. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ggaa29c1cfa33861c949e2dc997cd6dc810ad7fb6af0c7d525f25e9059bb17623fb3"></a><!-- doxytag: member="GLOBUS_SEG_ERROR_TYPE_NULL" ref="ggaa29c1cfa33861c949e2dc997cd6dc810ad7fb6af0c7d525f25e9059bb17623fb3" args="" -->GLOBUS_SEG_ERROR_TYPE_NULL</em> </td><td>
<p>NULL Parameter. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa29c1cfa33861c949e2dc997cd6dc810a6e15f7acfd057d6dd51645ccfd4f3ae2"></a><!-- doxytag: member="GLOBUS_SEG_ERROR_TYPE_ALREADY_SET" ref="ggaa29c1cfa33861c949e2dc997cd6dc810a6e15f7acfd057d6dd51645ccfd4f3ae2" args="" -->GLOBUS_SEG_ERROR_TYPE_ALREADY_SET</em> </td><td>
<p>Already called a one-time function. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa29c1cfa33861c949e2dc997cd6dc810a181db7ccb5306e14c34bf7eff0bc459f"></a><!-- doxytag: member="GLOBUS_SEG_ERROR_TYPE_INVALID_MODULE" ref="ggaa29c1cfa33861c949e2dc997cd6dc810a181db7ccb5306e14c34bf7eff0bc459f" args="" -->GLOBUS_SEG_ERROR_TYPE_INVALID_MODULE</em> </td><td>
<p>Shared module missing descriptor. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa29c1cfa33861c949e2dc997cd6dc810ab68b22a908c4aeff7e8436bfff39be0b"></a><!-- doxytag: member="GLOBUS_SEG_ERROR_TYPE_INVALID_FORMAT" ref="ggaa29c1cfa33861c949e2dc997cd6dc810ab68b22a908c4aeff7e8436bfff39be0b" args="" -->GLOBUS_SEG_ERROR_TYPE_INVALID_FORMAT</em> </td><td>
<p>Invalid printf format for SEG protocol message. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa29c1cfa33861c949e2dc997cd6dc810a6bdccb8e7b619b70acd62f76b8970320"></a><!-- doxytag: member="GLOBUS_SEG_ERROR_TYPE_OUT_OF_MEMORY" ref="ggaa29c1cfa33861c949e2dc997cd6dc810a6bdccb8e7b619b70acd62f76b8970320" args="" -->GLOBUS_SEG_ERROR_TYPE_OUT_OF_MEMORY</em> </td><td>
<p>Out of memory. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa29c1cfa33861c949e2dc997cd6dc810a7c0e47d4b55ccc50cf17835cdd78cbbb"></a><!-- doxytag: member="GLOBUS_SEG_ERROR_TYPE_LOADING_MODULE" ref="ggaa29c1cfa33861c949e2dc997cd6dc810a7c0e47d4b55ccc50cf17835cdd78cbbb" args="" -->GLOBUS_SEG_ERROR_TYPE_LOADING_MODULE</em> </td><td>
<p>Unable to load scheduler module. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga0cc2761894b44cdfd0ea237847248930"></a><!-- doxytag: member="globus_scheduler_event_generator.c::globus_scheduler_event" ref="ga0cc2761894b44cdfd0ea237847248930" args="(const char *format,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_scheduler_event </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send an arbitrary SEG notification. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>Printf-style format of the SEG notification message </td></tr>
<tr><td class="paramname">...</td><td>Varargs which will be interpreted as per format.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>Scheduler message sent or queued. </td></tr>
<tr><td class="paramname">GLOBUS_SEG_ERROR_NULL</td><td>Null format. </td></tr>
<tr><td class="paramname">GLOBUS_SEG_ERROR_INVALID_FORMAT</td><td>Unable to determine length of formatted string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaec7e2bf248ef2e149d344dcd427e1f44"></a><!-- doxytag: member="globus_scheduler_event_generator.c::globus_scheduler_event_pending" ref="gaec7e2bf248ef2e149d344dcd427e1f44" args="(time_t timestamp, const char *jobid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_scheduler_event_pending </td>
<td>(</td>
<td class="paramtype">time_t </td>
<td class="paramname"><em>timestamp</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send a job pending event to the JobSchedulerMonitor implementation. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">timestamp</td><td>Timestamp to use for the event. If set to 0, the time which this function was called is used. </td></tr>
<tr><td class="paramname">jobid</td><td>String indicating the scheduler-specific name of the job.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>Scheduler message sent or queued. </td></tr>
<tr><td class="paramname">GLOBUS_SEG_ERROR_NULL</td><td>Null jobid. </td></tr>
<tr><td class="paramname">GLOBUS_SEG_ERROR_INVALID_FORMAT</td><td>Unable to determine length of formatted string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gadbc82d3dc051291718bb67cf348cdc3d"></a><!-- doxytag: member="globus_scheduler_event_generator.c::globus_scheduler_event_active" ref="gadbc82d3dc051291718bb67cf348cdc3d" args="(time_t timestamp, const char *jobid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_scheduler_event_active </td>
<td>(</td>
<td class="paramtype">time_t </td>
<td class="paramname"><em>timestamp</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send a job active event to the JobSchedulerMonitor implementation. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">timestamp</td><td>Timestamp to use for the event. If set to 0, the time which this function was called is used. </td></tr>
<tr><td class="paramname">jobid</td><td>String indicating the scheduler-specific name of the job.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>Scheduler message sent or queued. </td></tr>
<tr><td class="paramname">GLOBUS_SEG_ERROR_NULL</td><td>Null jobid. </td></tr>
<tr><td class="paramname">GLOBUS_SEG_ERROR_INVALID_FORMAT</td><td>Unable to determine length of formatted string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga4690bf8649c0e5e6a2bba5f557f01030"></a><!-- doxytag: member="globus_scheduler_event_generator.c::globus_scheduler_event_failed" ref="ga4690bf8649c0e5e6a2bba5f557f01030" args="(time_t timestamp, const char *jobid, int failure_code)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_scheduler_event_failed </td>
<td>(</td>
<td class="paramtype">time_t </td>
<td class="paramname"><em>timestamp</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">int </td>
<td class="paramname"><em>failure_code</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send a job failed event to the JobSchedulerMonitor implementation. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">timestamp</td><td>Timestamp to use for the event. If set to 0, the time which this function was called is used. </td></tr>
<tr><td class="paramname">jobid</td><td>String indicating the scheduler-specific name of the job. </td></tr>
<tr><td class="paramname">failure_code</td><td>Failure code of the process if known.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>Scheduler message sent or queued. </td></tr>
<tr><td class="paramname">GLOBUS_SEG_ERROR_NULL</td><td>Null jobid. </td></tr>
<tr><td class="paramname">GLOBUS_SEG_ERROR_INVALID_FORMAT</td><td>Unable to determine length of formatted string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gad47c2e6c20ef7409f1a30da129c35be6"></a><!-- doxytag: member="globus_scheduler_event_generator.c::globus_scheduler_event_done" ref="gad47c2e6c20ef7409f1a30da129c35be6" args="(time_t timestamp, const char *jobid, int exit_code)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_scheduler_event_done </td>
<td>(</td>
<td class="paramtype">time_t </td>
<td class="paramname"><em>timestamp</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">int </td>
<td class="paramname"><em>exit_code</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send a job done event to the JobSchedulerMonitor implementation. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">timestamp</td><td>Timestamp to use for the event. If set to 0, the time which this function was called is used. </td></tr>
<tr><td class="paramname">jobid</td><td>String indicating the scheduler-specific name of the job. </td></tr>
<tr><td class="paramname">exit_code</td><td>Exit code of the process if known.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>Scheduler message sent or queued. </td></tr>
<tr><td class="paramname">GLOBUS_SEG_ERROR_NULL</td><td>Null jobid. </td></tr>
<tr><td class="paramname">GLOBUS_SEG_ERROR_INVALID_FORMAT</td><td>Unable to determine length of formatted string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga961078a3a990cc0f0fa23f814e170f82"></a><!-- doxytag: member="globus_scheduler_event_generator.c::globus_scheduler_event_generator_get_timestamp" ref="ga961078a3a990cc0f0fa23f814e170f82" args="(time_t *timestamp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_scheduler_event_generator_get_timestamp </td>
<td>(</td>
<td class="paramtype">time_t * </td>
<td class="paramname"><em>timestamp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the timestamp for the earliest event an SEG module should send. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">timestamp</td><td>Pointer to a time_t which will be set to the timestamp passed to the SEG executable. The module should not send any events which occur prior to this timestamp. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SEG_ERROR_NULL</td><td>Null timestamp. </td></tr>
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>Timestamp value updated. If the timestamp was not set on the SEG command-line, then the value pointed to by <em>timestamp</em> will be set to 0. </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>
