sources/internal_includes/parallel/parallel_events.h

Go to the documentation of this file.

/*
** Copyright 2009-2011, helixis.org
** All rights reserved.
**
** Redistribution and use in source and binary forms, with or without modification, are permitted provided
** that the following conditions are met:
**
** Redistributions of source code must retain the above copyright notice, this list of conditions and the
** following disclaimer.
**
** Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
** the following disclaimer in the documentation and/or other materials provided with the distribution.
**
** Neither the name of the helixis.org nor the names of its contributors may be used to endorse or promote
** products derived from this software without specific prior written permission.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
** WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
** PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
** ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
** TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
** HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
** NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
** POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef __HLX_PARALLEL_EVENTS_H__
# define __HLX_PARALLEL_EVENTS_H__

#if defined(HLX_BUILD_WITH_PARALLEL_THREADING)

#ifdef __cplusplus
extern "C"      {
#endif

/*
** TYPES
*/

typedef struct
{
        unsigned long                   hash_code;
        unsigned int                    param_size;
        struct slist_state      *callbacks;
}                                       _hlx_event_handler;

typedef struct
{
        hlx_event_manager       reserved;
        struct slist_state      *handlers;
}                                               _hlx_event_manager;

typedef struct
{
        void*                           user_data;
        hlx_task_callback       callback;
}                                                               _hlx_event_params;

typedef struct
{
        hlx_event_user_callback         func;
        hlx_task_func                           task;
        _hlx_event_params                       params;
        hlx_group_id                            group_id;
}                                                               _hlx_event_callback;


/*
** FUNCTIONS
*/

_hlx_event_handler*             _hlx_event_handler_create(unsigned long id);
hlx_event_errors                _hlx_event_handler_create_by_hash(_hlx_event_manager* manager, unsigned long id, unsigned int size);
void                                    _hlx_event_handler_destroy(_hlx_event_handler* handler);
hlx_event_errors                _hlx_event_register_callback_with_group(_hlx_event_manager* manager, _hlx_event_handler* handler, unsigned long id, _hlx_event_callback* callback, hlx_group_id group_id);
hlx_event_errors                _hlx_event_unregister_callback(_hlx_event_manager* manager, unsigned long id, void* user_callback);
hlx_event_errors                _hlx_event_unregister_callback_through_handler(_hlx_event_handler* handler, void* user_callback);
_hlx_event_handler*             _hlx_event_return_handler_by_hash(_hlx_event_manager* manager, unsigned long id);
_hlx_event_handler*             _hlx_event_return_handler(_hlx_event_manager* manager, unsigned long id);
void                                    _hlx_event_task_callback(void* param, hlx_group_id group_id, int status);
void                                    _hlx_event_default_manager_destroy(void);
void                                    _hlx_event_delete_callback(void *data, void *state);

#ifdef __cplusplus
}
#endif

#endif /* HLX_BUILD_WITH_KERNEL_THREAD */

#endif /* !__HLX_PARALLEL_EVENTS_H__ */

/*
** END OF FILE
*/