.TH "Connection Management" 3 "Wed Jan 25 2012" "Version 5.2" "globus rls client" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Connection Management \- 
.SS "Defines"

.in +1c
.ti -1c
.RI "#define \fBGLOBUS_RLS_URL_SCHEME\fP   'rls'"
.br
.ti -1c
.RI "#define \fBGLOBUS_RLS_URL_SCHEME_NOAUTH\fP   'rlsn'"
.br
.ti -1c
.RI "#define \fBGLOBUS_RLS_SERVER_DEFPORT\fP   39281"
.br
.ti -1c
.RI "#define \fBMAXERRMSG\fP   1024"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "void \fBglobus_rls_client_certificate\fP (char *certfile, char *keyfile)"
.br
.ti -1c
.RI "void \fBglobus_rls_client_proxy_certificate\fP (char *proxy)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_connect\fP (char *url, \fBglobus_rls_handle_t\fP **h)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_close\fP (\fBglobus_rls_handle_t\fP *h)"
.br
.ti -1c
.RI "int \fBglobus_rls_client_get_timeout\fP ()"
.br
.ti -1c
.RI "void \fBglobus_rls_client_set_timeout\fP (int seconds)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Functions to open and close connections to an RLS server\&. 
.SH "Define Documentation"
.PP 
.SS "#define \fBGLOBUS_RLS_URL_SCHEME\fP   'rls'"
.PP
URL scheme to use when connecting to RLS server\&. 
.SS "#define \fBGLOBUS_RLS_URL_SCHEME_NOAUTH\fP   'rlsn'"
.PP
URL scheme when connecting to RLS server without authentication\&. 
.SS "#define \fBGLOBUS_RLS_SERVER_DEFPORT\fP   39281"
.PP
Default port number that RLS server listens on\&. 
.SS "#define \fBMAXERRMSG\fP   1024"
.PP
Maximum length of error messages returned by server\&. 
.SH "Function Documentation"
.PP 
.SS "void \fBglobus_rls_client_certificate\fP (char *certfile, char *keyfile)"
.PP
Set certificate used in authentication\&. Sets environment variables X509_USER_CERT, X509_USER_KEY, and clears X509_USER_PROXY\&.
.PP
\fBParameters:\fP
.RS 4
\fIcertfile\fP Name of X509 certificate file\&.
.br
\fIkeyfile\fP Name of X509 key file\&. 
.RE
.PP

.SS "void \fBglobus_rls_client_proxy_certificate\fP (char *proxy)"
.PP
Set X509_USER_PROXY environment variable to specified file\&. \fBParameters:\fP
.RS 4
\fIproxy\fP Name of X509 proxy certificate file\&. If NULL clears X509_USER_PROXY\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_connect\fP (char *url, \fBglobus_rls_handle_t\fP **h)"
.PP
Open connection to RLS server\&. \fBParameters:\fP
.RS 4
\fIurl\fP URL of server to connect to\&. URL scheme should be \fBRLS\fP or \fBRLSN\fP, eg \fBRLS://my\&.host\fP\&. If the URL scheme is \fBRLSN\fP then no authentication is performed (the RLS server must be started with authentication disabled as well, this option is primarily intended for testing)\&.
.br
\fIh\fP If the connection is successful \fI*h\fP will be set to the connection handle\&. This handle is required by all other functions in the API\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Handle \fIh\fP now connected to RLS server identified by \fIurl\fP\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_close\fP (\fBglobus_rls_handle_t\fP *h)"
.PP
Close connection to RLS server\&. \fBParameters:\fP
.RS 4
\fIh\fP Connection handle to be closed, previously allocated by \fBglobus_rls_client_connect()\fP\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Connection closed, \fIh\fP is no longer valid\&. 
.RE
.PP

.SS "int \fBglobus_rls_client_get_timeout\fP ()"
.PP
Get timeout for IO calls to RLS server\&. If 0 IO calls do not timeout\&. The default is 30 seconds\&.
.PP
\fBReturn values:\fP
.RS 4
\fItimeout\fP Seconds to wait before timing out an IO operation\&. 
.RE
.PP

.SS "void \fBglobus_rls_client_set_timeout\fP (intseconds)"
.PP
Set timeout for IO calls to RLS server\&. \fBParameters:\fP
.RS 4
\fIseconds\fP Seconds to wait before timing out an IO operation\&. If 0 IO calls do not timeout\&. The default is 30 seconds\&. 
.RE
.PP

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