cassyarduino cassyarduino / UIPEthernet

UIPEthernet library for Arduino IDE, Eclipse with arduino plugin and MBED/SMeshStudio (AVR,STM32F,ESP8266,Intel ARC32,Nordic nRF51,Teensy boards,Realtek Ameba(RTL8195A,RTL8710)), ENC28j60 network chip. Compatible with Wiznet W5100 Ethernet library API. Compiled and tested on Nucleo-F302R8. Master repository is: https://github.com/UIPEthernet/UIPEthernet/

utility/uip_timer.h@39:deeb00b81cc9, 2018-01-23 (annotated)

Committer:
cassyarduino
Date:
Tue Jan 23 15:08:43 2018 +0100
Revision:
39:deeb00b81cc9
Parent:
0:e3fb1267e3c3 
Release: 2.0.4

Who changed what in which revision?

UserRevisionLine numberNew contents of line
cassyarduino 0:e3fb1267e3c3 1 /**
cassyarduino 0:e3fb1267e3c3 2 * \defgroup timer Timer library
cassyarduino 0:e3fb1267e3c3 3 *
cassyarduino 0:e3fb1267e3c3 4 * The timer library provides functions for setting, resetting and
cassyarduino 0:e3fb1267e3c3 5 * restarting timers, and for checking if a timer has expired. An
cassyarduino 0:e3fb1267e3c3 6 * application must "manually" check if its timers have expired; this
cassyarduino 0:e3fb1267e3c3 7 * is not done automatically.
cassyarduino 0:e3fb1267e3c3 8 *
cassyarduino 0:e3fb1267e3c3 9 * A timer is declared as a \c struct \c timer and all access to the
cassyarduino 0:e3fb1267e3c3 10 * timer is made by a pointer to the declared timer.
cassyarduino 0:e3fb1267e3c3 11 *
cassyarduino 0:e3fb1267e3c3 12 * \note The timer library uses the \ref clock "Clock library" to
cassyarduino 0:e3fb1267e3c3 13 * measure time. Intervals should be specified in the format used by
cassyarduino 0:e3fb1267e3c3 14 * the clock library.
cassyarduino 0:e3fb1267e3c3 15 *
cassyarduino 0:e3fb1267e3c3 16 * @{
cassyarduino 0:e3fb1267e3c3 17 */
cassyarduino 0:e3fb1267e3c3 18
cassyarduino 0:e3fb1267e3c3 19
cassyarduino 0:e3fb1267e3c3 20 /**
cassyarduino 0:e3fb1267e3c3 21 * \file
cassyarduino 0:e3fb1267e3c3 22 * Timer library header file.
cassyarduino 0:e3fb1267e3c3 23 * \author
cassyarduino 0:e3fb1267e3c3 24 * Adam Dunkels <adam@sics.se>
cassyarduino 0:e3fb1267e3c3 25 */
cassyarduino 0:e3fb1267e3c3 26
cassyarduino 0:e3fb1267e3c3 27 /*
cassyarduino 0:e3fb1267e3c3 28 * Copyright (c) 2004, Swedish Institute of Computer Science.
cassyarduino 0:e3fb1267e3c3 29 * All rights reserved.
cassyarduino 0:e3fb1267e3c3 30 *
cassyarduino 0:e3fb1267e3c3 31 * Redistribution and use in source and binary forms, with or without
cassyarduino 0:e3fb1267e3c3 32 * modification, are permitted provided that the following conditions
cassyarduino 0:e3fb1267e3c3 33 * are met:
cassyarduino 0:e3fb1267e3c3 34 * 1. Redistributions of source code must retain the above copyright
cassyarduino 0:e3fb1267e3c3 35 * notice, this list of conditions and the following disclaimer.
cassyarduino 0:e3fb1267e3c3 36 * 2. Redistributions in binary form must reproduce the above copyright
cassyarduino 0:e3fb1267e3c3 37 * notice, this list of conditions and the following disclaimer in the
cassyarduino 0:e3fb1267e3c3 38 * documentation and/or other materials provided with the distribution.
cassyarduino 0:e3fb1267e3c3 39 * 3. Neither the name of the Institute nor the names of its contributors
cassyarduino 0:e3fb1267e3c3 40 * may be used to endorse or promote products derived from this software
cassyarduino 0:e3fb1267e3c3 41 * without specific prior written permission.
cassyarduino 0:e3fb1267e3c3 42 *
cassyarduino 0:e3fb1267e3c3 43 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
cassyarduino 0:e3fb1267e3c3 44 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
cassyarduino 0:e3fb1267e3c3 45 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
cassyarduino 0:e3fb1267e3c3 46 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
cassyarduino 0:e3fb1267e3c3 47 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
cassyarduino 0:e3fb1267e3c3 48 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
cassyarduino 0:e3fb1267e3c3 49 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
cassyarduino 0:e3fb1267e3c3 50 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
cassyarduino 0:e3fb1267e3c3 51 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
cassyarduino 0:e3fb1267e3c3 52 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
cassyarduino 0:e3fb1267e3c3 53 * SUCH DAMAGE.
cassyarduino 0:e3fb1267e3c3 54 *
cassyarduino 0:e3fb1267e3c3 55 * This file is part of the uIP TCP/IP stack
cassyarduino 0:e3fb1267e3c3 56 *
cassyarduino 0:e3fb1267e3c3 57 * Author: Adam Dunkels <adam@sics.se>
cassyarduino 0:e3fb1267e3c3 58 *
cassyarduino 0:e3fb1267e3c3 59 * $Id: timer.h,v 1.3 2006/06/11 21:46:39 adam Exp $
cassyarduino 0:e3fb1267e3c3 60 */
cassyarduino 0:e3fb1267e3c3 61 #ifndef __UIP_TIMER_H__
cassyarduino 0:e3fb1267e3c3 62 #define __UIP_TIMER_H__
cassyarduino 0:e3fb1267e3c3 63
cassyarduino 0:e3fb1267e3c3 64 #include "uip_clock.h"
cassyarduino 0:e3fb1267e3c3 65
cassyarduino 0:e3fb1267e3c3 66 /**
cassyarduino 0:e3fb1267e3c3 67 * A timer.
cassyarduino 0:e3fb1267e3c3 68 *
cassyarduino 0:e3fb1267e3c3 69 * This structure is used for declaring a timer. The timer must be set
cassyarduino 0:e3fb1267e3c3 70 * with timer_set() before it can be used.
cassyarduino 0:e3fb1267e3c3 71 *
cassyarduino 0:e3fb1267e3c3 72 * \hideinitializer
cassyarduino 0:e3fb1267e3c3 73 */
cassyarduino 0:e3fb1267e3c3 74 struct uip_timer {
cassyarduino 0:e3fb1267e3c3 75 clock_time_t start;
cassyarduino 0:e3fb1267e3c3 76 clock_time_t interval;
cassyarduino 0:e3fb1267e3c3 77 };
cassyarduino 0:e3fb1267e3c3 78
cassyarduino 0:e3fb1267e3c3 79 void uip_timer_set(struct uip_timer *t, clock_time_t interval);
cassyarduino 0:e3fb1267e3c3 80 void uip_timer_reset(struct uip_timer *t);
cassyarduino 0:e3fb1267e3c3 81 void uip_timer_restart(struct uip_timer *t);
cassyarduino 0:e3fb1267e3c3 82 int uip_timer_expired(struct uip_timer *t);
cassyarduino 0:e3fb1267e3c3 83
cassyarduino 0:e3fb1267e3c3 84 #endif /* __UIP_TIMER_H__ */
cassyarduino 0:e3fb1267e3c3 85
cassyarduino 0:e3fb1267e3c3 86 /** @} */