1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
=head1 NAME
rinit - initalize the roy library
=head1 SYNOPSIS
#include <roy.h>
void rinit (void);
void rinit_threaded (void);
void rcleanup (void);
void rcleanup_add_hook (RCleanupHook function)
typedef void (*RCleanupHook) (void);
=head1 DESCRIPTION
Call rinit(3) before calling any roy api functions or macros.
This call setups important globals needed by many of the data
structures and helper functions.
rinit_threaded(3) is identical to rinit(3) except this must be
used in its place if you are planning to do any threading work.
This enables the locks around rchunk(3) and other data structures
within roy.
rcleanup(3) cleans up any memory used by roy in globals.
rcleanup_add_hook(3) adds a function to be called when rcleanup(3)
is called. The function should be defined as RCleanupHook above,
for example:
void cleanuphook (void);
=head1 RETURN VALUE
These calls returns no value.
=head1 ERRORS
A call to rinit(3), rinit_threaded(3), rcleanup(3) or
rcleanup_add_hook(3) will never fail.
=head1 SEE ALSO
L<roy(3)|roy(3)>
|
