BRLAPI_CONNECTIONSETTINGS_T(3)

💖 brlapi_connectionSettings_t — NAME 💖

okay so bestie, welcome to the Library Functions Manual (that's the manual name, we're not copy-pasting the whole header line, we're being cute about it). This page is all about brlapi_connectionSettings_t — the settings structure for BrlAPI connection. Yes. That's the whole name. It's giving "little struct, big responsibilities". 👑

---

✨ SYNOPSIS ✨

#include <brlapi.h>

🎀 Data Fields

• const char * auth
• const char * host

---

🦋 Detailed Description 🦋

This structure holds every parameter you need to connect to BrlAPI: which file the authorization key can be found in, and which computer to connect to. That's it. Two fields. Two little strings. And yet. 😌

🌸 Examples

brlapi_connectionSettings_t settings;

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

so what's happening here? libbrlapi will read the authorization key from the file /etc/brlapi.key and connect to the machine called "foo", on the default TCP port. slay. 💅

settings.host="10.1.0.2";

this lets you directly enter an IP address instead of a machine name. no name resolution, just vibes (and numbers). 🔥

settings.host=":1";

and this one lets libbrlapi connect to the local computer, on port BRLAPI_SOCKETPORTNUM+1. iconic behaviour honestly.

💜 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. And this field is the path to the file which holds it — which means that file will hence have to be readable by the application. fr fr, check your permissions.

Setting NULL defaults it to the local installation setup, or to the content of the BRLAPI_AUTH environment variable, if it exists. 🫶

🧚 const char* brlapi_connectionSettings_t::host

this one tells you 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 a computer called "foo".

⚠️ Note: Please check that resolving this name works before complaining. 😭 (that's not me being mean, that's literally what the page says, and honestly? valid.)

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. not a human, just a robot doing its little thing. 🤖

---

aaaand that's the whole page bestie, you ate it, you understood it, you're basically a BrlAPI connection expert now 💅✨ This was BrlAPI, Version 0.8 — page brlapi_con...nSettings_t(3), dated the same as the source code it came from. bye bestie, go connect to something 🦋💖