Connection Management(3)
NAME
Connection Management
- Functions to open and close connections to an RLS server.
- Defines
- #define GLOBUS_RLS_URL_SCHEME 'rls' #define GLOBUS_RLS_URL_SCHEME_NOAUTH 'rlsn' #define GLOBUS_RLS_SERVER_DEFPORT 39281 #define MAXERRMSG 1024
- Functions
- void globus_rls_client_certificate (char *certfile, char *keyfile)
void globus_rls_client_proxy_certificate (char *proxy)
globus_result_t globus_rls_client_connect (char *url,
globus_rls_handle_t **h)
- globus_result_t globus_rls_client_close (globus_rls_handle_t *h) int globus_rls_client_get_timeout () void globus_rls_client_set_timeout (int seconds)
Detailed Description
Functions to open and close connections to an RLS server.
Define Documentation
- #define GLOBUS_RLS_URL_SCHEME 'rls'
- URL scheme to use when connecting to RLS server.
- #define GLOBUS_RLS_URL_SCHEME_NOAUTH 'rlsn'
- URL scheme when connecting to RLS server without authentication.
- #define GLOBUS_RLS_SERVER_DEFPORT 39281
- Default port number that RLS server listens on.
- #define MAXERRMSG 1024
- Maximum length of error messages returned by server.
Function Documentation
- void globus_rls_client_certificate (char * certfile, char * keyfile)
- Set certificate used in authentication. Sets environment variables
X509_USER_CERT, X509_USER_KEY, and clears X509_USER_PROXY. - Parameters:
certfile Name of X509 certificate file.
keyfile Name of X509 key file. - void globus_rls_client_proxy_certificate (char * proxy)
- Set X509_USER_PROXY environment variable to specified file. Parameters:
proxy Name of X509 proxy certificate file. If NULL clears X509_USER_PROXY.
- globus_result_t globus_rls_client_connect (char * url, globus_rls_handle_t
- ** h)
Open connection to RLS server. Parameters:url URL of server to connect to. URL scheme should be RLS or RLSN, eg RLS://my.host. If the URL scheme is RLSN then no authentication is performed (the RLS server must be started with authentication
disabled as well, this option is primarily intended for testing).
h If the connection is successful *h will be set to the connection handle. This handle is required by all other functions in the API. - Return values:
GLOBUS_SUCCESS Handle h now connected to RLS server identified by url.
- globus_result_t globus_rls_client_close (globus_rls_handle_t * h)
- Close connection to RLS server. Parameters:
h Connection handle to be closed, previously allocated by
globus_rls_client_connect(). - Return values:
GLOBUS_SUCCESS Connection closed, h is no longer valid.
- int globus_rls_client_get_timeout ()
- Get timeout for IO calls to RLS server. If 0 IO calls do not timeout.
The default is 30 seconds. - Return values:
timeout Seconds to wait before timing out an IO operation.
- void globus_rls_client_set_timeout (int seconds)
- Set timeout for IO calls to RLS server. Parameters:
seconds Seconds to wait before timing out an IO operation. If 0 IO calls do not timeout. The default is 30 seconds.
Author
- Generated automatically by Doxygen for globus rls client from the
source code.