/**
 * CAN module object for Linux socketCAN.
 *
 * This file is a template for other microcontrollers.
 *
 * @file        CO_notify_pipe.h
 * @ingroup     CO_driver
 * @author      Martin Wagner
 * @copyright   2017 Neuberger Gebaeudeautomation GmbH
 *
 *
 * This file is part of CANopenNode, an opensource CANopen Stack.
 * Project home page is <https://github.com/CANopenNode/CANopenNode>.
 * For more information on CANopen see <http://www.can-cia.org/>.
 *
 * CANopenNode is free and open source software: you can redistribute
 * it and/or modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation, either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 * Following clarification and special exception to the GNU General Public
 * License is included to the distribution terms of CANopenNode:
 *
 * Linking this library statically or dynamically with other modules is
 * making a combined work based on this library. Thus, the terms and
 * conditions of the GNU General Public License cover the whole combination.
 *
 * As a special exception, the copyright holders of this library give
 * you permission to link this library with independent modules to
 * produce an executable, regardless of the license terms of these
 * independent modules, and to copy and distribute the resulting
 * executable under terms of your choice, provided that you also meet,
 * for each linked independent module, the terms and conditions of the
 * license of that module. An independent module is a module which is
 * not derived from or based on this library. If you modify this
 * library, you may extend this exception to your version of the
 * library, but you are not obliged to do so. If you do not wish
 * to do so, delete this exception statement from your version.
 */
#ifndef CO_NOTIFY_PIPE_H_
#define CO_NOTIFY_PIPE_H_

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @defgroup CO_pipe Pipe
 * @ingroup CO_driver
 * @{
 *
 * This is needed to wake up the can socket when blocking in select
 */

/**
 * Object
 */
typedef struct CO_NotifyPipe CO_NotifyPipe_t;

/**
 * Create Pipe
 *
 * @return != null if successfully created
 */
CO_NotifyPipe_t *CO_NotifyPipeCreate(void);

/**
 * Delete Pipe
 *
 * @param p pointer to object
 */
void CO_NotifyPipeFree(CO_NotifyPipe_t *p);

/**
 * Get file descriptor for select
 *
 * @param p pointer to object
 */
int CO_NotifyPipeGetFd(CO_NotifyPipe_t *p);

/**
 * Send event
 *
 * @param p pointer to object
 */
void CO_NotifyPipeSend(CO_NotifyPipe_t *p);

/** @} */

#ifdef __cplusplus
}
#endif /*__cplusplus*/

#endif /* CO_NOTIFY_PIPE_H_ */

/**
* @} @}
**/