/******************************************************************************** * sched/timer/timer_delete.c * * Copyright (C) 2007, 2008 Gregory Nutt. All rights reserved. * Author: Gregory Nutt * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. 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. * 3. Neither the name NuttX 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 OWNER 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. * ********************************************************************************/ /******************************************************************************** * Included Files ********************************************************************************/ #include #include #include #include "timer/timer.h" #ifndef CONFIG_DISABLE_POSIX_TIMERS /******************************************************************************** * Public Functions ********************************************************************************/ /******************************************************************************** * Name: timer_delete * * Description: * The timer_delete() function deletes the specified timer, timerid, previously * created by the timer_create() function. If the timer is armed when * timer_delete() is called, the timer will be automatically disarmed before * removal. The disposition of pending signals for the deleted timer is * unspecified. * * Parameters: * timerid - The per-thread timer, previously created by the call to * timer_create(), to be deleted. * * Return Value: * If the call succeeds, timer_create() will return 0 (OK). Otherwise, the * function will return a value of -1 (ERROR) and set errno to indicate the * error. * * EINVAL - The timer specified timerid is not valid. * * Assumptions: * ********************************************************************************/ int timer_delete(timer_t timerid) { int ret = timer_release((FAR struct posix_timer_s *)timerid); if (ret < 0) { set_errno(-ret); return ERROR; } return OK; } #endif /* CONFIG_DISABLE_POSIX_TIMERS */