enet: ENet global functions

enet

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

Functions
ENet global functions

## Functions
ENET_API int | enet_initialize (void)
| Initializes ENet globally. More...
ENET_API int | enet_initialize_with_callbacks (ENetVersion version, const ENetCallbacks *inits)
| Initializes ENet globally and supplies user-overridden callbacks. More...
ENET_API void | enet_deinitialize (void)
| Shuts down ENet globally. More...
ENET_API ENetVersion | enet_linked_version (void)
| Gives the linked version of the ENet library. More...

## Detailed Description

## Function Documentation

ENET_API void enet_deinitialize | ( | void |  | ) |

Should be called when a program that has initialized ENet exits.

ENET_API int enet_initialize | ( | void |  | ) |

Must be called prior to using any functions in ENet.

Returns
  0 on success, < 0 on failure

Referenced by enet_initialize_with_callbacks().

ENET_API int enet_initialize_with_callbacks | ( | ENetVersion | version,
|  | const ENetCallbacks * | inits
| ) |  |

Must be called prior to using any functions in ENet. Do not use enet_initialize() if you use this variant. Make sure the ENetCallbacks structure is zeroed out so that any additional callbacks added in future versions will be properly ignored.

Parameters

  version | the constant ENET_VERSION should be supplied so ENet knows which version of ENetCallbacks struct to use
  inits | user-overridden callbacks where any NULL callbacks will use ENet's defaults

Returns
  0 on success, < 0 on failure

References enet_initialize().

ENET_API ENetVersion enet_linked_version | ( | void |  | ) |

Returns
  the version number