php_raphf.h

Go to the documentation of this file.

/*
    +--------------------------------------------------------------------+
    | PECL :: raphf                                                      |
    +--------------------------------------------------------------------+
    | Redistribution and use in source and binary forms, with or without |
    | modification, are permitted provided that the conditions mentioned |
    | in the accompanying LICENSE file are met.                          |
    +--------------------------------------------------------------------+
    | Copyright (c) 2013, Michael Wallner <mike@php.net>                 |
    +--------------------------------------------------------------------+
*/

#ifndef PHP_RAPHF_H
#define PHP_RAPHF_H

#ifndef DOXYGEN

extern zend_module_entry raphf_module_entry;
#define phpext_raphf_ptr &raphf_module_entry

#define PHP_RAPHF_VERSION "1.1.0"

#ifdef PHP_WIN32
#   define PHP_RAPHF_API __declspec(dllexport)
#elif defined(__GNUC__) && __GNUC__ >= 4
#   define PHP_RAPHF_API extern __attribute__ ((visibility("default")))
#else
#   define PHP_RAPHF_API extern
#endif

#ifdef ZTS
#   include "TSRM.h"
#endif

#endif

typedef void *(*php_resource_factory_handle_ctor_t)(void *opaque,
        void *init_arg TSRMLS_DC);

typedef void *(*php_resource_factory_handle_copy_t)(void *opaque,
        void *handle TSRMLS_DC);

typedef void (*php_resource_factory_handle_dtor_t)(void *opaque,
        void *handle TSRMLS_DC);

typedef struct php_resource_factory_ops {
    php_resource_factory_handle_ctor_t ctor;
    php_resource_factory_handle_copy_t copy;
    php_resource_factory_handle_dtor_t dtor;
} php_resource_factory_ops_t;

typedef struct php_resource_factory {
    php_resource_factory_ops_t fops;
    void *data;
    void (*dtor)(void *data);
    unsigned refcount;
} php_resource_factory_t;

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));

PHP_RAPHF_API unsigned php_resource_factory_addref(php_resource_factory_t *rf);

PHP_RAPHF_API void php_resource_factory_dtor(php_resource_factory_t *f);

PHP_RAPHF_API void php_resource_factory_free(php_resource_factory_t **f);

PHP_RAPHF_API void *php_resource_factory_handle_ctor(php_resource_factory_t *f,
        void *init_arg TSRMLS_DC);

PHP_RAPHF_API void *php_resource_factory_handle_copy(php_resource_factory_t *f,
        void *handle TSRMLS_DC);

PHP_RAPHF_API void php_resource_factory_handle_dtor(php_resource_factory_t *f,
        void *handle TSRMLS_DC);

typedef struct php_persistent_handle_list {
    HashTable free;
    ulong used;
} php_persistent_handle_list_t;

typedef struct php_persistent_handle_provider {
    php_persistent_handle_list_t list;

    php_resource_factory_t rf;
} php_persistent_handle_provider_t;

typedef struct php_persistent_handle_factory php_persistent_handle_factory_t;

typedef void (*php_persistent_handle_wakeup_t)(
        php_persistent_handle_factory_t *f, void **handle TSRMLS_DC);
typedef void (*php_persistent_handle_retire_t)(
        php_persistent_handle_factory_t *f, void **handle TSRMLS_DC);

struct php_persistent_handle_factory {
    php_persistent_handle_provider_t *provider;
    php_persistent_handle_wakeup_t wakeup;
    php_persistent_handle_retire_t retire;

    struct {
        char *str;
        size_t len;
    } ident;

    unsigned free_on_abandon:1;
};

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 *) TSRMLS_DC);

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,
        php_persistent_handle_wakeup_t wakeup,
        php_persistent_handle_retire_t retire TSRMLS_DC);

PHP_RAPHF_API void php_persistent_handle_abandon(
        php_persistent_handle_factory_t *a);

PHP_RAPHF_API void *php_persistent_handle_acquire(
        php_persistent_handle_factory_t *a, void *init_arg TSRMLS_DC);

PHP_RAPHF_API void php_persistent_handle_release(
        php_persistent_handle_factory_t *a, void *handle TSRMLS_DC);

PHP_RAPHF_API void *php_persistent_handle_accrete(
        php_persistent_handle_factory_t *a, void *handle TSRMLS_DC);

PHP_RAPHF_API php_resource_factory_ops_t *
php_persistent_handle_get_resource_factory_ops(void);

PHP_RAPHF_API php_resource_factory_t *
php_persistent_handle_resource_factory_init(php_resource_factory_t *a,
        php_persistent_handle_factory_t *pf);

PHP_RAPHF_API zend_bool php_resource_factory_is_persistent(
        php_resource_factory_t *a);

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);

PHP_RAPHF_API HashTable *php_persistent_handle_statall(HashTable *ht TSRMLS_DC);

#endif  /* PHP_RAPHF_H */


/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * End:
 * vim600: noet sw=4 ts=4 fdm=marker
 * vim<600: noet sw=4 ts=4
 */