.TH "globus_scheduler_event_generator_api" 3 "Wed Feb 27 2019" "Version 6.1" "globus_scheduler_event_generator" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_scheduler_event_generator_api \- Scheduler Implementation API\&.  

.SH SYNOPSIS
.br
.PP
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBglobus_scheduler_event_generator_error_t\fP { \fBGLOBUS_SEG_ERROR_TYPE_NULL\fP = 1024, \fBGLOBUS_SEG_ERROR_TYPE_ALREADY_SET\fP, \fBGLOBUS_SEG_ERROR_TYPE_INVALID_MODULE\fP, \fBGLOBUS_SEG_ERROR_TYPE_INVALID_FORMAT\fP, \fBGLOBUS_SEG_ERROR_TYPE_OUT_OF_MEMORY\fP, \fBGLOBUS_SEG_ERROR_TYPE_LOADING_MODULE\fP }"
.br
.in -1c
.SH "Detailed Description"
.PP 
Scheduler Implementation API\&. 

Scheduler-specific SEG module implementations use this API to issue events to the Job State Monitor\&. Events occur whenever a job is placed in the scheduler's queue (PENDING), begins execution (ACTIVE), terminates successfully (DONE), or ends abnormally (FAILED)\&.
.PP
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\&. 
.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBglobus_scheduler_event_generator_error_t\fP"
Error types used by the SEG\&. 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIGLOBUS_SEG_ERROR_TYPE_NULL \fP\fP
NULL Parameter 
.TP
\fB\fIGLOBUS_SEG_ERROR_TYPE_ALREADY_SET \fP\fP
Already called a one-time function 
.TP
\fB\fIGLOBUS_SEG_ERROR_TYPE_INVALID_MODULE \fP\fP
Shared module missing descriptor 
.TP
\fB\fIGLOBUS_SEG_ERROR_TYPE_INVALID_FORMAT \fP\fP
Invalid printf format for SEG protocol message 
.TP
\fB\fIGLOBUS_SEG_ERROR_TYPE_OUT_OF_MEMORY \fP\fP
Out of memory 
.TP
\fB\fIGLOBUS_SEG_ERROR_TYPE_LOADING_MODULE \fP\fP
Unable to load scheduler module 
.SH "Author"
.PP 
Generated automatically by Doxygen for globus_scheduler_event_generator from the source code\&.