.TH "globus_callback" 3 "Version 18.14" "globus_common" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_callback \- Globus Callback
.PP
 \- Globus Callback Function Interface\&.  

.SH SYNOPSIS
.br
.PP
.SS "Modules"

.in +1c
.ti -1c
.RI "\fBGlobus Callback API\fP"
.br
.RI "Globus Callback API\&. "
.ti -1c
.RI "\fBGlobus Callback Spaces\fP"
.br
.RI "Globus Callback Spaces\&. "
.ti -1c
.RI "\fBGlobus Callback Signal Handling\fP"
.br
.RI "Globus Callback Signal Handling\&. "
.in -1c
.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBGLOBUS_CALLBACK_MODULE\fP"
.br
.RI "Module descriptor\&. "
.ti -1c
.RI "#define \fBGLOBUS_POLL_MODULE\fP"
.br
.RI "Module descriptor\&. "
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef int \fBglobus_callback_handle_t\fP"
.br
.RI "Periodic callback handle\&. "
.ti -1c
.RI "typedef int \fBglobus_callback_space_t\fP"
.br
.RI "Callback space handle\&. "
.ti -1c
.RI "typedef struct globus_l_callback_space_attr_s * \fBglobus_callback_space_attr_t\fP"
.br
.RI "Callback space attribute\&. "
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBglobus_callback_error_type_t\fP { \fBGLOBUS_CALLBACK_ERROR_INVALID_CALLBACK_HANDLE\fP = 1024, \fBGLOBUS_CALLBACK_ERROR_INVALID_SPACE\fP, \fBGLOBUS_CALLBACK_ERROR_MEMORY_ALLOC\fP, \fBGLOBUS_CALLBACK_ERROR_INVALID_ARGUMENT\fP, \fBGLOBUS_CALLBACK_ERROR_ALREADY_CANCELED\fP, \fBGLOBUS_CALLBACK_ERROR_NO_ACTIVE_CALLBACK\fP }"
.br
.RI "Error types\&. "
.in -1c
.SH "Detailed Description"
.PP 
Globus Callback Function Interface\&. 


.SH "Macro Definition Documentation"
.PP 
.SS "#define GLOBUS_CALLBACK_MODULE"

.PP
Module descriptor\&. Module descriptor for for globus_callback module\&. Must be activated before any of the following api is called\&.
.PP
Note: You would not normally activate this module directly\&. Activating the GLOBUS_COMMON_MODULE will in turn activate this also\&. 
.SS "#define GLOBUS_POLL_MODULE"

.PP
Module descriptor\&. 
.PP
\fBDeprecated\fP
.RS 4

.RE
.PP
.PP
Backward compatible name 
.SH "Typedef Documentation"
.PP 
.SS "typedef int \fBglobus_callback_handle_t\fP"

.PP
Periodic callback handle\&. This handle can be copied or compared, and represented as NULL with GLOBUS_NULL_HANDLE 
.SS "typedef struct globus_l_callback_space_attr_s* \fBglobus_callback_space_attr_t\fP"

.PP
Callback space attribute\&. This handle can be copied and represented as NULL with GLOBUS_NULL 
.SS "typedef int \fBglobus_callback_space_t\fP"

.PP
Callback space handle\&. This handle can be copied or compared and represented as NULL with GLOBUS_NULL_HANDLE 
.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBglobus_callback_error_type_t\fP"

.PP
Error types\&. Possible error types returned by the api in this module\&. You can use the error API to check results against these types\&.
.PP
\fBSee also\fP
.RS 4
\fBError Handling Helpers\fP 
.RE
.PP

.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIGLOBUS_CALLBACK_ERROR_INVALID_CALLBACK_HANDLE \fP\fP
The callback handle is not valid or it has already been destroyed 
.TP
\fB\fIGLOBUS_CALLBACK_ERROR_INVALID_SPACE \fP\fP
The space handle is not valid or it has already been destroyed 
.TP
\fB\fIGLOBUS_CALLBACK_ERROR_MEMORY_ALLOC \fP\fP
Could not allocate memory for an internal structure 
.TP
\fB\fIGLOBUS_CALLBACK_ERROR_INVALID_ARGUMENT \fP\fP
One of the arguments is NULL or out of range 
.TP
\fB\fIGLOBUS_CALLBACK_ERROR_ALREADY_CANCELED \fP\fP
Attempt to unregister callback again 
.TP
\fB\fIGLOBUS_CALLBACK_ERROR_NO_ACTIVE_CALLBACK \fP\fP
Attempt to retrieve info about a callback not in callers's stack 
.SH "Author"
.PP 
Generated automatically by Doxygen for globus_common from the source code\&.