gPTP Documentation
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
avbts_ostimerq.hpp
Go to the documentation of this file.
1 /******************************************************************************
2 
3  Copyright (c) 2009-2012, Intel Corporation
4  All rights reserved.
5 
6  Redistribution and use in source and binary forms, with or without
7  modification, are permitted provided that the following conditions are met:
8 
9  1. Redistributions of source code must retain the above copyright notice,
10  this list of conditions and the following disclaimer.
11 
12  2. Redistributions in binary form must reproduce the above copyright
13  notice, this list of conditions and the following disclaimer in the
14  documentation and/or other materials provided with the distribution.
15 
16  3. Neither the name of the Intel Corporation nor the names of its
17  contributors may be used to endorse or promote products derived from
18  this software without specific prior written permission.
19 
20  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  POSSIBILITY OF SUCH DAMAGE.
31 
32 ******************************************************************************/
33 
34 #ifndef AVBTS_OSTIMERQ_HPP
35 #define AVBTS_OSTIMERQ_HPP
36 
42 typedef void (*ostimerq_handler) (void *);
43 
44 class IEEE1588Clock;
45 
49 class OSTimerQueue {
50 protected:
55  virtual bool init() { return true; }
56 
61 public:
72  virtual bool addEvent
73  (unsigned long micros, int type, ostimerq_handler func,
74  event_descriptor_t * arg, bool dynamic, unsigned *event) = 0;
75 
82  virtual bool cancelEvent(int type, unsigned *event) = 0;
83  virtual ~OSTimerQueue() = 0;
84 };
85 
86 inline OSTimerQueue::~OSTimerQueue() {}
87 
92 public:
98  virtual OSTimerQueue *createOSTimerQueue( IEEE1588Clock *clock ) = 0;
99  virtual ~OSTimerQueueFactory() = 0;
100 };
101 
102 inline OSTimerQueueFactory::~OSTimerQueueFactory() {}
103 
104 #endif
Definition: avbts_ostimerq.hpp:49
Definition: avbts_clock.hpp:77
Definition: ieee1588.hpp:93
void(* ostimerq_handler)(void *)
Definition: avbts_ostimerq.hpp:42
Definition: avbts_ostimerq.hpp:91
virtual bool cancelEvent(int type, unsigned *event)=0
Removes an event from the timer queue.
virtual bool init()
Initializes timer queue.
Definition: avbts_ostimerq.hpp:55
OSTimerQueue()
Definition: avbts_ostimerq.hpp:60
virtual OSTimerQueue * createOSTimerQueue(IEEE1588Clock *clock)=0
Creates the OSTimerQueue object.
virtual bool addEvent(unsigned long micros, int type, ostimerq_handler func, event_descriptor_t *arg, bool dynamic, unsigned *event)=0
Add an event to the timer queue.