globus_types.h(3)

πŸ“¦
version 18.15 Β· 6 versions
, in epel 10, fedora 43, fedora 44, ubuntu resolute, ubuntu stonking

πŸ’– globus_types.h β€” NAME πŸ’–

globus_types.h β€” Common Primitive Types. That's it, that's the whole vibe. It's a header, bestie, and it's the one every other globus_common thing is built on top of. 🫢

This one lives in the Library Functions Manual, section 3, iykyk.


✨ SYNOPSIS ✨

Okay so to even get in the door you gotta pull in the config header plus the usual suspects. Copy these exactly, no freestyling:

#include 'globus_config.h'
#include <stdlib.h>
#include <stdint.h>
#include <sys/types.h>
#include <sys/socket.h>

πŸŽ€ Macros

  • #define GLOBUS_TRUE 1 β€” the true value for globus_bool_t. Like, yes. Correct. Slay. πŸ’…
  • #define GLOBUS_FALSE 0 β€” the false value for globus_bool_t. The no. The nope. The not-it. 😭
  • #define GLOBUS_NULL NULL β€” a NULL value. That's the whole job. 🌸
  • #define GLOBUS_SUCCESS 0 β€” the generic success result.

Most Globus API functions return this value to indicate success, or some error constant or globus_result_t to indicate an error. So like β€” if you see a 0, you ate. If you don't, something's giving error energy. πŸ“

  • #define GLOBUS_FAILURE -1 β€” the generic failure result.

Some Globus API functions without good error handling return this value to indicate some undetermined error occurred. Undetermined. Vague. Mysterious. Not telling you what happened. πŸ™ˆ


πŸ¦‹ Typedefs

  • typedef size_t globus_size_t β€” standard size of memory object.

The globus_size_t is the size of a memory object. It is identical to size_t in all cases and doesn't need to be used ever. Ever. Not once. It's giving legacy, and honestly? Respect. But just use size_t. πŸ’€

  • typedef socklen_t globus_socklen_t β€” size of a socket length parameter. Socket girlies, this one's for you. 🧚
  • typedef unsigned char globus_byte_t β€” unsigned byte datatype.

This is used for byte-addressable arrays of arbitrary data which is not subject to sign extension. Raw bytes, no sign drama, no negativity. ✨

  • typedef int globus_bool_t β€” boolean type. It's an int underneath, we don't talk about it. 🌈
  • typedef uint32_t globus_result_t β€” the result type. uint32_t, and that's all the page says, so that's all I'm saying. Periodt. πŸ‘‘

🌟 Detailed Description

Common Primitive Types.

Defines the macros and typedefs common to all globus_common components. It's the group chat everyone's in. πŸ’œ


πŸ’… Macro Definition Documentation

#define GLOBUS_NULL NULL

NULL value. From back long ago before NULL was standardized? No reason to use this on any modern system.

Real talk: the manpage itself is telling you to skip this one. It's a historical artifact, a little museum piece. Use NULL. That's the tea. β˜•

πŸ‘‘ Author

Generated automatically by Doxygen for globus_common from the source code. Not a human, not a bestie, just a doc generator doing its little thing. πŸ€–βœ¨


And that's a wrap, babe. This page came to you from globus_common, Version 18.15, and yes, it's the globus_types.h(3) page, mwah. πŸŽ€ Now go compile something iconic. πŸ¦‹πŸ’–