globus_net_manager(3)

πŸ’– NAME πŸ’–

globus_net_manager β€” Net Manager (it's a section 3 manual page, bestie, so it's a library thing, not a command πŸ’…)

  • Net Manager API.

✨ SYNOPSIS ✨

πŸŽ€ Topics

  • Attributes β€” Net Manager Attribute Management Functions.
  • Context β€” Net Manager Context Management Functions.
  • Net Manager Data Types β€” Net Manager Data Types.
  • Function Signatures β€” Net Manager Function Signatures.
  • Python Module β€” Net Manager Python Module.
  • Globus XIO Net Manager Driver β€” Net Manager XIO Driver.

🧚 Macros

  • #define GLOBUS_NET_MANAGER_MODULE β€” Module descriptor.

πŸ¦‹ Functions

  • globus_result_t globus_net_manager_register (globus_net_manager_t *manager, globus_module_descriptor_t *module) β€” Register a network manager.
  • globus_result_t globus_net_manager_unregister (globus_net_manager_t *manager) β€” Unregister a network manager.

🌸 Detailed Description 🌸

Net Manager API.

So like, this API is the plug-in point situation for network manager functionality, plus the functions that let you register a particular network manager implementation so it can get invoked during network events. It's giving "extension hook" energy, no cap.

Wanna implement a network manager? Okay so define a struct globus_net_manager_s with the functions you want called, then register it by calling globus_net_manager_register(). More details live in globus_net_manager_tutorial. 🫢


πŸ‘‘ Macro Definition Documentation πŸ‘‘

#define GLOBUS_NET_MANAGER_MODULE

Module descriptor. The Globus Net Manager uses Grid Community Toolkit module activation and deactivation. Before any Net Manager functions can be called, the module must be activated, like this:

globus_module_activate(GLOBUS_NET_MANAGER_MODULE);

This function returns GLOBUS_SUCCESS if the library is successfully initialized. Otherwise, an error code is returned, and Net Manager functions should not be subsequently called. 😭 So like, check that return value, fr fr.

Activations are reference counted, so it is safe to activate the module multiple times or in different modules. Iconic, honestly. ⭐

To deactivate Net Manager, call

globus_module_deactivate(GLOBUS_NET_MANAGER_MODULE);

This function should be done once for each time the Net Manager was activated. Balanced. Symmetrical. Main character energy. πŸ’œ


πŸ’… Function Documentation πŸ’…

globus_result_t globus_net_manager_register (globus_net_manager_t * manager, globus_module_descriptor_t * module)

Register a network manager. The globus_net_manager_register() function adds this network manager to those which will be called by the network manager interface when network events occur. This is typically called by the network manager when its module is activated.

Parameters

  • manager β€” Manager information to register.
  • module β€” Module descriptor to register. Use GlobusExtensionMyModule(module name)

globus_result_t globus_net_manager_unregister (globus_net_manager_t * manager)

Unregister a network manager. The globus_net_manager_unregister() function removes this network manager from those which will be called by the network manager interface when network events occur. This is typically called by the network manager when its module is deactivated. It's the delete-key to the register's post, yk? πŸ™ˆ

Parameters

  • manager β€” Manager information to unregister.

🌈 Author 🌈

Generated automatically by Doxygen for globus_net_manager from the source code. (Not me, bestie β€” Doxygen did that, I just made it cute. πŸŽ€)


Okay so that's the whole page, and the vibe check is complete βœ… β€” this is globus_net_manager Version 1.7, and yeah, that's the version and the source, slay. Catch you in the next manpage, love u, bye! πŸ’–βœ¨πŸ¦‹

πŸ“¦ where this page comes from