includes/hlx/channels.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_CHANNELS_H__
# define __HLX_CHANNELS_H__

#ifdef __cplusplus
extern "C"      {
#endif

/*
** TYPES
*/

/* CHANNEL ERRORS */
typedef enum
{
        CHAN_ERROR_SUCCESS = 0,
        CHAN_ERROR_INTERNAL_ERROR = 1,
        CHAN_ERROR_MEMORY_EXHAUSTED = 2,
        CHAN_ERROR_ALREADY_EXISTS = 3,
        CHAN_ERROR_UNDEFINED = 4,
        CHAN_ERROR_NOT_EXISTS = 5
}               hlx_channel_errors;

/*
** MACROS
*/

# define HLX_CHAN_WRITE(chan, value, type) HLX_TASK_YIELD_UNTIL(__hlx_chan_write_##type(chan, (type)value) > 0);
# define HLX_CHAN_READ(chan, var_ptr, type) HLX_TASK_YIELD_UNTIL(__hlx_chan_read_##type(chan, (type *)var_ptr) > 0);

# define HLX_CHAN_WRITE_PTR(chan, value) HLX_TASK_YIELD_UNTIL(__hlx_chan_write_ptr(chan, (void *)value) > 0);
# define HLX_CHAN_READ_PTR(chan, var_ptr) HLX_TASK_YIELD_UNTIL(__hlx_chan_read_ptr(chan, (void **)var_ptr) > 0);

/*
** FUNCTIONS
*/

hlx_channel_errors      hlx_chan_create(unsigned long id);

/*
** /!\ THESE FUNCTIONS MUST NEVER BE USED DIRECTLY, USE MACROS INSTEAD /!\
*/

int             __hlx_chan_write_int(unsigned long id, int value);
int             __hlx_chan_read_int(unsigned long id, int* value);
int             __hlx_chan_write_char(unsigned long id, char value);
int             __hlx_chan_read_char(unsigned long id, char* value);
int             __hlx_chan_write_short(unsigned long id, short value);
int             __hlx_chan_read_short(unsigned long id, short* value);
int             __hlx_chan_write_float(unsigned long id, float value);
int             __hlx_chan_read_float(unsigned long id, float* value);
int             __hlx_chan_write_ptr(unsigned long id, void* value);
int             __hlx_chan_read_ptr(unsigned long id, void** value);

#ifdef __cplusplus
}
#endif

#endif /* !__HLX_CHANNELS_H__ */

/*
** END OF FILE
*/