---
name: "globus_rls_client_connection"
section: "3"
platform: "linux"
package: "libglobus-rls-client-doc"
version: "5.2-8"
release: "Debian 7 (Wheezy)"
platforms: ["linux"]
url: "https://new.carta.tech/globus_rls_client_connection"
---

# globus\_rls\_client\_connection(3)

## NAME

Connection Management -

### 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 (intseconds)

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.