.TH "globus_callout_config" 3 "Sun Dec 13 2020" "Version 4.3" "globus_callout" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_callout_config \- Callout Configuration
.PP
 \- Register callouts\&.  

.SH SYNOPSIS
.br
.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_callout_read_config\fP (\fBglobus_callout_handle_t\fP handle, char *filename)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_callout_register\fP (\fBglobus_callout_handle_t\fP handle, char *type, char *library, char *symbol)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Register callouts\&. 

This section defines operations for registering callouts\&. Callouts may be registered either through a configuration file or through calls to globus_callout_register\&. 
.SH "Function Documentation"
.PP 
.SS "globus_result_t globus_callout_read_config (\fBglobus_callout_handle_t\fP handle, char * filename)"
Read callout configuration from file\&.
.PP
This function read a configuration file with the following format:
.IP "\(bu" 2
Anything after a \fI#\fP is assumed to be a comment
.IP "\(bu" 2
Blanks lines are ignored
.IP "\(bu" 2
Lines specifying callouts have the format 
.PP
.nf
       abstract type           library         symbol

.fi
.PP

.IP "\(bu" 2
where \fIabstract type\fP denotes the type of callout, e\&.g\&. globus_gram_jobmanager_authz, \fIlibrary\fP denotes the library the callout can be found in and \fIsymbol\fP denotes the function name of the callout\&. The library argument can be specified in two forms, libfoo or libfoo_\fIflavor\fP\&. When using the former version the current flavor will automatically be added to the library name if needed\&.
.PP
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP The handle that is to be configured 
.br
\fIfilename\fP The file to read configuration from 
.RE
.PP
\fBReturns\fP
.RS 4
This function returns GLOBUS_SUCCESS or a globus_result_t referring to an error object of one of the following types 
.RE
.PP
\fBReturn values\fP
.RS 4
\fIGLOBUS_CALLOUT_ERROR_OPENING_CONF_FILE\fP Error opening filename 
.br
\fIGLOBUS_CALLOUT_ERROR_PARSING_CONF_FILE\fP Error parsing file 
.br
\fIGLOBUS_CALLOUT_ERROR_OUT_OF_MEMORY\fP Out of memory 
.RE
.PP

.SS "globus_result_t globus_callout_register (\fBglobus_callout_handle_t\fP handle, char * type, char * library, char * symbol)"
Register callout configuration
.PP
This function registers a callout type in the given handle\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP The handle that is to be configured 
.br
\fItype\fP The abstract type of the callout 
.br
\fIlibrary\fP The location of the library containing the callout 
.br
\fIsymbol\fP The symbol (ie function name) for the callout 
.RE
.PP
\fBReturns\fP
.RS 4
This function returns GLOBUS_SUCCESS or a globus_result_t referring to an error object of one of the following types 
.RE
.PP
\fBReturn values\fP
.RS 4
\fIGLOBUS_CALLOUT_ERROR_OUT_OF_MEMORY\fP Out of memory 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for globus_callout from the source code\&.