pbs_connect(3B)

💖 pbs_connect — bestie, let's get you connected 💖

okay so real talk: this is a page from the PBS Professional manual, section 3B, and it's literally all about getting a connection handle from a PBS batch server. no cap, it's giving "networking but make it library-call." let's break it down 🫶

---

✨ NAME ✨

pbs_connect — return a connection handle from a PBS batch server 💅

---

🌸 SYNOPSIS 🌸

okay so first you gotta include these, bestie:

#include <pbs_error.h>
#include <pbs_ifl.h>

int pbs_connect(char *server)

---

🦋 DESCRIPTION 🦋

so what this function does, right? it establishes a virtual stream connection (that's a TCP/IP connection, iykyk) with the batch server you specify. slay.

then it hands you back a connection handle. iconic behavior fr fr.

pbs_connect() also does some detective work: it figures out whether or not your complex has a failover server configured 👀. and it determines which server is the primary and which one is the secondary. main character energy, honestly.

---

🎀 ARGUMENTS 🎀

• server — Specifies the name of the server to connect to. The format is literally this:

<hostname>[:<port>]

If you don't specify a port, don't stress — PBS just uses the default. 💅

And if server is a null pointer or a null string? no worries bestie, this function opens a connection to the default server instead. that default server is specified in the PBS_DEFAULT environment variable, or the PBS_SERVER parameter in /etc/pbs.conf. periodt. 🍓

---

🔥 USAGE 🔥

okay this part matters: use this function to establish a connection handle to the server you want before you call any of the other pbs_* API functions. those functions are gonna send their batch requests over the connection that this one sets up. the way that works?? you can send multiple requests over one single connection. efficiency queen 👑

---

🌈 CLEANUP 🌈

when you're done using the connection handle — and I mean actually done — close the connection via a call to pbs_disconnect(). don't leave it hanging, that's not cute. 💀

---

👑 SIDE EFFECTS 👑

so there's this global variable called pbs_server, and it's declared in pbs_ifl.h. on return, this variable gets set to point to the server name that pbs_connect() connected to — or attempted to connect to. either way, it's getting set. 🙈

🧚 Windows Requirement 🧚

if you wanna use pbs_connect() with Windows, you gotta initialize the network library AND link with winsock2. here's the whole vibe:

• call winsock_init() before calling pbs_connect()
• link against the ws2_32.lib library

that's it, that's the requirement. 🎀

---

⭐ RETURN VALUE ⭐

okay so on success, the routine returns a connection handle, which is a non-negative integer. yay! ✨

but if an error occurred? the routine returns -1, and the error number is available in the global integer pbs_errno. so like, check that if things go sideways. 😭

---

💜 SEE ALSO 💜

• pbs_disconnect(3B)

---

that's the whole page bestie, you're so ready now. go forth and connect 💅✨

and for the record? this page is from the Local manual, dated 15 November 2019, and it's pbs_connect(3B) — write that down for the vibes. 🫶🌸💖