maintenance
[m6w6/ext-raphf] / php_raphf.h
1 /*
2 +--------------------------------------------------------------------+
3 | PECL :: raphf |
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2013, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
11 */
12
13 #ifndef PHP_RAPHF_H
14 #define PHP_RAPHF_H
15
16 extern zend_module_entry raphf_module_entry;
17 #define phpext_raphf_ptr &raphf_module_entry
18
19 #define PHP_RAPHF_VERSION "1.0.0"
20
21 #ifdef PHP_WIN32
22 # define PHP_RAPHF_API __declspec(dllexport)
23 #elif defined(__GNUC__) && __GNUC__ >= 4
24 # define PHP_RAPHF_API __attribute__ ((visibility("default")))
25 #else
26 # define PHP_RAPHF_API
27 #endif
28
29 #ifdef ZTS
30 # include "TSRM.h"
31 #endif
32
33 typedef void *(*php_resource_factory_handle_ctor_t)(void *opaque, void *init_arg TSRMLS_DC);
34 typedef void *(*php_resource_factory_handle_copy_t)(void *opaque, void *handle TSRMLS_DC);
35 typedef void (*php_resource_factory_handle_dtor_t)(void *opaque, void *handle TSRMLS_DC);
36
37 typedef struct php_resource_factory_ops {
38 php_resource_factory_handle_ctor_t ctor;
39 php_resource_factory_handle_copy_t copy;
40 php_resource_factory_handle_dtor_t dtor;
41 } php_resource_factory_ops_t;
42
43 typedef struct php_resource_factory {
44 php_resource_factory_ops_t fops;
45
46 void *data;
47 void (*dtor)(void *data);
48
49 unsigned refcount;
50 } php_resource_factory_t;
51
52 PHP_RAPHF_API php_resource_factory_t *php_resource_factory_init(php_resource_factory_t *f, php_resource_factory_ops_t *fops, void *data, void (*dtor)(void *data));
53 PHP_RAPHF_API unsigned php_resource_factory_addref(php_resource_factory_t *rf);
54 PHP_RAPHF_API void php_resource_factory_dtor(php_resource_factory_t *f);
55 PHP_RAPHF_API void php_resource_factory_free(php_resource_factory_t **f);
56
57 PHP_RAPHF_API void *php_resource_factory_handle_ctor(php_resource_factory_t *f, void *init_arg TSRMLS_DC);
58 PHP_RAPHF_API void *php_resource_factory_handle_copy(php_resource_factory_t *f, void *handle TSRMLS_DC);
59 PHP_RAPHF_API void php_resource_factory_handle_dtor(php_resource_factory_t *f, void *handle TSRMLS_DC);
60
61 typedef struct php_persistent_handle_factory {
62 void *provider;
63
64 struct {
65 char *str;
66 size_t len;
67 } ident;
68
69 unsigned free_on_abandon:1;
70 } php_persistent_handle_factory_t;
71
72 struct php_persistent_handle_globals {
73 ulong limit;
74 struct {
75 ulong h;
76 char *s;
77 size_t l;
78 } ident;
79 };
80
81 PHP_RAPHF_API int /* SUCCESS|FAILURE */ php_persistent_handle_provide(const char *name_str, size_t name_len, php_resource_factory_ops_t *fops, void *data, void (*dtor)(void *));
82 PHP_RAPHF_API php_persistent_handle_factory_t *php_persistent_handle_concede(php_persistent_handle_factory_t *a, const char *name_str, size_t name_len, const char *ident_str, size_t ident_len TSRMLS_DC);
83 PHP_RAPHF_API void php_persistent_handle_abandon(php_persistent_handle_factory_t *a);
84 PHP_RAPHF_API void *php_persistent_handle_acquire(php_persistent_handle_factory_t *a, void *init_arg TSRMLS_DC);
85 PHP_RAPHF_API void php_persistent_handle_release(php_persistent_handle_factory_t *a, void *handle TSRMLS_DC);
86 PHP_RAPHF_API void *php_persistent_handle_accrete(php_persistent_handle_factory_t *a, void *handle TSRMLS_DC);
87
88 PHP_RAPHF_API php_resource_factory_ops_t *php_persistent_handle_get_resource_factory_ops(void);
89
90 PHP_RAPHF_API void php_persistent_handle_cleanup(const char *name_str, size_t name_len, const char *ident_str, size_t ident_len TSRMLS_DC);
91 PHP_RAPHF_API HashTable *php_persistent_handle_statall(HashTable *ht TSRMLS_DC);
92
93 ZEND_BEGIN_MODULE_GLOBALS(raphf)
94 struct php_persistent_handle_globals persistent_handle;
95 ZEND_END_MODULE_GLOBALS(raphf)
96
97 #ifdef ZTS
98 # define PHP_RAPHF_G ((zend_raphf_globals *) (*((void ***) tsrm_ls))[TSRM_UNSHUFFLE_RSRC_ID(raphf_globals_id)])
99 #else
100 # define PHP_RAPHF_G (&raphf_globals)
101 #endif
102
103 #endif /* PHP_RAPHF_H */
104
105
106 /*
107 * Local variables:
108 * tab-width: 4
109 * c-basic-offset: 4
110 * End:
111 * vim600: noet sw=4 ts=4 fdm=marker
112 * vim<600: noet sw=4 ts=4
113 */