libglobus-scheduler-event-generator-doc 4.7-4 / usr / share / doc / libglobus-scheduler-event-generator-dev / html / group__seg__api.html

This file is indexed.

/usr/share/doc/libglobus-scheduler-event-generator-dev/html/group__seg__api.html is in libglobus-scheduler-event-generator-doc 4.7-4.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
<!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.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__seg__api.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Scheduler Implementation API</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gaa29c1cfa33861c949e2dc997cd6dc810"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__seg__api.html#gaa29c1cfa33861c949e2dc997cd6dc810">globus_scheduler_event_generator_error_t</a> { <br/>
&#160;&#160;<a class="el" href="group__seg__api.html#ggaa29c1cfa33861c949e2dc997cd6dc810ad7fb6af0c7d525f25e9059bb17623fb3">GLOBUS_SEG_ERROR_TYPE_NULL</a> = 1024, 
<br/>
&#160;&#160;<a class="el" href="group__seg__api.html#ggaa29c1cfa33861c949e2dc997cd6dc810a6e15f7acfd057d6dd51645ccfd4f3ae2">GLOBUS_SEG_ERROR_TYPE_ALREADY_SET</a>, 
<br/>
&#160;&#160;<a class="el" href="group__seg__api.html#ggaa29c1cfa33861c949e2dc997cd6dc810a181db7ccb5306e14c34bf7eff0bc459f">GLOBUS_SEG_ERROR_TYPE_INVALID_MODULE</a>, 
<br/>
&#160;&#160;<a class="el" href="group__seg__api.html#ggaa29c1cfa33861c949e2dc997cd6dc810ab68b22a908c4aeff7e8436bfff39be0b">GLOBUS_SEG_ERROR_TYPE_INVALID_FORMAT</a>, 
<br/>
&#160;&#160;<a class="el" href="group__seg__api.html#ggaa29c1cfa33861c949e2dc997cd6dc810a6bdccb8e7b619b70acd62f76b8970320">GLOBUS_SEG_ERROR_TYPE_OUT_OF_MEMORY</a>, 
<br/>
&#160;&#160;<a class="el" href="group__seg__api.html#ggaa29c1cfa33861c949e2dc997cd6dc810a7c0e47d4b55ccc50cf17835cdd78cbbb">GLOBUS_SEG_ERROR_TYPE_LOADING_MODULE</a>
<br/>
 }</td></tr>
<tr class="separator:gaa29c1cfa33861c949e2dc997cd6dc810"><td class="memSeparator" colspan="2">&#160;</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:ga0cc2761894b44cdfd0ea237847248930"><td class="memItemLeft" align="right" valign="top">globus_result_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__seg__api.html#ga0cc2761894b44cdfd0ea237847248930">globus_scheduler_event</a> (const char *format,...)</td></tr>
<tr class="separator:ga0cc2761894b44cdfd0ea237847248930"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaec7e2bf248ef2e149d344dcd427e1f44"><td class="memItemLeft" align="right" valign="top">globus_result_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__seg__api.html#gaec7e2bf248ef2e149d344dcd427e1f44">globus_scheduler_event_pending</a> (time_t timestamp, const char *jobid)</td></tr>
<tr class="separator:gaec7e2bf248ef2e149d344dcd427e1f44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadbc82d3dc051291718bb67cf348cdc3d"><td class="memItemLeft" align="right" valign="top">globus_result_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__seg__api.html#gadbc82d3dc051291718bb67cf348cdc3d">globus_scheduler_event_active</a> (time_t timestamp, const char *jobid)</td></tr>
<tr class="separator:gadbc82d3dc051291718bb67cf348cdc3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4690bf8649c0e5e6a2bba5f557f01030"><td class="memItemLeft" align="right" valign="top">globus_result_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__seg__api.html#ga4690bf8649c0e5e6a2bba5f557f01030">globus_scheduler_event_failed</a> (time_t timestamp, const char *jobid, int failure_code)</td></tr>
<tr class="separator:ga4690bf8649c0e5e6a2bba5f557f01030"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad47c2e6c20ef7409f1a30da129c35be6"><td class="memItemLeft" align="right" valign="top">globus_result_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__seg__api.html#gad47c2e6c20ef7409f1a30da129c35be6">globus_scheduler_event_done</a> (time_t timestamp, const char *jobid, int exit_code)</td></tr>
<tr class="separator:gad47c2e6c20ef7409f1a30da129c35be6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga961078a3a990cc0f0fa23f814e170f82"><td class="memItemLeft" align="right" valign="top">globus_result_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__seg__api.html#ga961078a3a990cc0f0fa23f814e170f82">globus_scheduler_event_generator_get_timestamp</a> (time_t *timestamp)</td></tr>
<tr class="separator:ga961078a3a990cc0f0fa23f814e170f82"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">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>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gaa29c1cfa33861c949e2dc997cd6dc810"></a>
<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>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggaa29c1cfa33861c949e2dc997cd6dc810ad7fb6af0c7d525f25e9059bb17623fb3"></a>GLOBUS_SEG_ERROR_TYPE_NULL</em>&#160;</td><td class="fielddoc">
<p>NULL Parameter. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggaa29c1cfa33861c949e2dc997cd6dc810a6e15f7acfd057d6dd51645ccfd4f3ae2"></a>GLOBUS_SEG_ERROR_TYPE_ALREADY_SET</em>&#160;</td><td class="fielddoc">
<p>Already called a one-time function. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggaa29c1cfa33861c949e2dc997cd6dc810a181db7ccb5306e14c34bf7eff0bc459f"></a>GLOBUS_SEG_ERROR_TYPE_INVALID_MODULE</em>&#160;</td><td class="fielddoc">
<p>Shared module missing descriptor. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggaa29c1cfa33861c949e2dc997cd6dc810ab68b22a908c4aeff7e8436bfff39be0b"></a>GLOBUS_SEG_ERROR_TYPE_INVALID_FORMAT</em>&#160;</td><td class="fielddoc">
<p>Invalid printf format for SEG protocol message. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggaa29c1cfa33861c949e2dc997cd6dc810a6bdccb8e7b619b70acd62f76b8970320"></a>GLOBUS_SEG_ERROR_TYPE_OUT_OF_MEMORY</em>&#160;</td><td class="fielddoc">
<p>Out of memory. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggaa29c1cfa33861c949e2dc997cd6dc810a7c0e47d4b55ccc50cf17835cdd78cbbb"></a>GLOBUS_SEG_ERROR_TYPE_LOADING_MODULE</em>&#160;</td><td class="fielddoc">
<p>Unable to load scheduler module. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga0cc2761894b44cdfd0ea237847248930"></a>
<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 *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em>&#160;</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 class="params"><dt>Parameters</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 class="retval"><dt>Return values</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>
<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&#160;</td>
          <td class="paramname"><em>timestamp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>jobid</em>&#160;</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 class="params"><dt>Parameters</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 class="retval"><dt>Return values</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>
<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&#160;</td>
          <td class="paramname"><em>timestamp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>jobid</em>&#160;</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 class="params"><dt>Parameters</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 class="retval"><dt>Return values</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>
<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&#160;</td>
          <td class="paramname"><em>timestamp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>jobid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>failure_code</em>&#160;</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 class="params"><dt>Parameters</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 class="retval"><dt>Return values</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>
<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&#160;</td>
          <td class="paramname"><em>timestamp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>jobid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>exit_code</em>&#160;</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 class="params"><dt>Parameters</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 class="retval"><dt>Return values</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>
<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 *&#160;</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 class="params"><dt>Parameters</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 class="retval"><dt>Return values</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><!-- contents -->
</div><!-- doc-content -->
<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>

APT Browse - Built by Thomas Orozco.