1TICKIT_STRING(7)       Miscellaneous Information Manual       TICKIT_STRING(7)
2
3
4

NAME

6       TickitString - a reference-counted string buffer
7

SYNOPSIS

9       #include <tickit.h>
10
11       typedef struct TickitString;
12
13

DESCRIPTION

15       A  TickitString instance stores a NUL-terminated character buffer (i.e.
16       a plain C string) and a reference count. It allows string buffers to be
17       efficiently  shared while their usage is tracked, and reclaimed once no
18       longer required.
19

FUNCTIONS

21       A new TickitString instance is created by calling tickit_string_new(3).
22       Once    constructed,    its    buffer    can   be   read   by   calling
23       tickit_string_get(3) and its length  queried  by  tickit_string_len(3).
24       The buffer should be considered immutable; it cannot be modified.
25
26       A  string  instance  maintains  a reference count to make it easier for
27       applications to share and manage the lifetime of these buffers.  A  new
28       string  starts  with  a  count  of  one,  and  it can be adjusted using
29       tickit_string_ref(3) and tickit_string_unref(3). When the count reaches
30       zero the instance is destroyed.
31

SEE ALSO

33       tickit(7)
34
35
36
37                                                              TICKIT_STRING(7)
Impressum