Tervel  1.0.0
A collection of wait-free containers and algorithms.
descriptor.h
Go to the documentation of this file.
1 /*
2 The MIT License (MIT)
3 
4 Copyright (c) 2015 University of Central Florida's Computer Software Engineering
5 Scalable & Secure Systems (CSE - S3) Lab
6 
7 Permission is hereby granted, free of charge, to any person obtaining a copy
8 of this software and associated documentation files (the "Software"), to deal
9 in the Software without restriction, including without limitation the rights
10 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 copies of the Software, and to permit persons to whom the Software is
12 furnished to do so, subject to the following conditions:
13 
14 The above copyright notice and this permission notice shall be included in
15 all copies or substantial portions of the Software.
16 
17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 THE SOFTWARE.
24 */
25 #ifndef TERVEL_UTIL_DESCRIPTOR_H_
26 #define TERVEL_UTIL_DESCRIPTOR_H_
27 
28 #include <atomic>
29 
30 #include <assert.h>
31 #include <stdint.h>
32 
33 #include <tervel/util/info.h>
34 #include <tervel/util/util.h>
35 
36 namespace tervel {
37 namespace util {
60 class Descriptor {
61  public:
63  virtual ~Descriptor() {}
71  virtual void * complete(void *current, std::atomic<void *> *address) = 0;
72 
83  virtual void * get_logical_value() = 0;
84 
99  virtual bool on_watch(std::atomic<void *>* /*address*/, void * /*expected*/) {
100  return true;
101  }
102 
109  virtual void on_unwatch() {}
110 
117  virtual bool on_is_watched() { return false; }
118 
119  private:
121 };
122 
123 } // namespace util
124 } // namespace tervel
125 
126 
127 #endif // TERVEL_UTIL_DESCRIPTOR_H_
virtual void * get_logical_value()=0
This method is implemented by each sub class.
virtual void on_unwatch()
This method must be implemented if on_watch is implemented, and is optional otherwise.
Definition: descriptor.h:109
Descriptor()
Definition: descriptor.h:62
DISALLOW_COPY_AND_ASSIGN(Descriptor)
TODO(steven):
Definition: mcas.h:36
virtual bool on_is_watched()
This method is optional to implement for each sub class.
Definition: descriptor.h:117
This defines the Descriptor class, this class is designed to be extend and be used in conjunction wit...
Definition: descriptor.h:60
virtual void * complete(void *current, std::atomic< void * > *address)=0
This method is implemented by each sub class and must guarantee that upon return that the descriptor ...
virtual bool on_watch(std::atomic< void * > *, void *)
This method is optional to implement for each sub class.
Definition: descriptor.h:99
virtual ~Descriptor()
Definition: descriptor.h:63