includes/hlx/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_EVENTS_H__
# define __HLX_EVENTS_H__

#ifdef __cplusplus
extern "C"
{
#endif

/*
** MACROS
*/

# define HLX_EVENT_NO_ARGS      (0)

/*
** TYPES
*/

typedef struct
{
        char    dev_slash_0; /* we have nothing in the manager today. */
}                               hlx_event_manager;


/* EVENT ERRORS */
typedef enum
{
        EV_ERROR_SUCCESS = 0,
        EV_ERROR_INTERNAL_ERROR = 1,
        EV_ERROR_MEMORY_EXHAUSTED = 2,
        EV_ERROR_ALREADY_EXISTS = 3,
        EV_ERROR_UNDEFINED = 4,
        EV_ERROR_NO_EVENT_DATA = 5
}               hlx_event_errors;

/* EVENT ARGS */
typedef struct
{
        void*                           event_data;
        void*                           user_data;
        hlx_task_callback       callback;
}                                               hlx_event_args;

typedef void                    (*hlx_event_user_callback)(hlx_event_args*);

/*
** FUNCTIONS
*/

hlx_event_manager*              hlx_event_manager_create(void);
hlx_event_manager*              hlx_event_get_default_manager(void);
void                                    hlx_event_manager_destroy(hlx_event_manager* manager);
hlx_event_errors                hlx_event_handler_create(hlx_event_manager* manager, unsigned long id, unsigned int size);
hlx_event_errors                hlx_event_handler_destroy(hlx_event_manager* manager, unsigned long id);
hlx_event_errors                hlx_event_register_callback_func(hlx_event_manager* manager, unsigned long id, hlx_event_user_callback func, void* user_data);
hlx_event_errors                hlx_event_register_callback_func_with_group(hlx_event_manager* manager, unsigned long id, hlx_event_user_callback func, void* user_data, hlx_group_id group_id);
hlx_event_errors                hlx_event_register_callback_task(hlx_event_manager* manager, unsigned long id, hlx_task_func task, void* user_data);
hlx_event_errors                hlx_event_register_callback_task_with_group(hlx_event_manager* manager, unsigned long id, hlx_task_func task, void* user_data, hlx_group_id group_id);
hlx_event_errors                hlx_event_notify(hlx_event_manager* manager, unsigned long id, void* event_data);

#ifdef __cplusplus
}
#endif

#endif  /* !_HLX_EVENTS_H_ */

/*
** END OF FILE
*/