---
name: "brlapi_connectionSettings_t"
section: "3"
platform: "linux"
package: "libbrlapi-dev"
version: "6.7-3.1+deb13u3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/brlapi_connectionSettings_t"
---

# brlapi\_connectionSettings\_t(3)

Settings structure for BrlAPI connection.

## NAME

brlapi\_connectionSettings\_t - Settings structure for *BrlAPI* connection.

## SYNOPSIS

`#include <brlapi.h>`

### Data Fields

const char \* **auth**\
 const char \* **host**\

## Detailed Description

This structure holds every parameter needed to connect to *BrlAPI:* which file the authorization key can be found in and which computer to connect to.

**Examples:**

```
brlapi_connectionSettings_t settings;
settings.auth="/etc/brlapi.key";
settings.host="foo";
```

*libbrlapi* will read authorization key from file `/etc/brlapi`.key and connect to the machine called 'foo', on the default TCP port.

```
settings.host="10.1.0.2";
```

lets directly enter an IP address instead of a machine name.

```
settings.host=":1";
```

lets *libbrlapi* connect to the local computer, on port BRLAPI\_SOCKETPORTNUM+1

**See also**

**brlapi\_openConnection()**

## Field Documentation

### const char\* brlapi\_connectionSettings\_t::auth

For security reasons, *libbrlapi* has to get authorized to connect to the *BrlAPI* server. This can be done via a secret key, for instance. This is the path to the file which holds it; it will hence have to be readable by the application.

Setting `NULL` defaults it to local installation setup or to the content of the BRLAPI\_AUTH environment variable, if it exists.

### const char\* brlapi\_connectionSettings\_t::host

This tells where the *BrlAPI* server resides: it might be listening on another computer, on any TCP port. It should look like 'foo:1', which means TCP port number BRLAPI\_SOCKETPORTNUM+1 on computer called 'foo'.

**Note**

Please check that resolving this name works before complaining

Settings `NULL` defaults it to localhost, using the local installation's default TCP port, or to the content of the BRLAPI\_HOST environment variable, if it exists.

## Author

Generated automatically by Doxygen for BrlAPI from the source code.