folly/test/SynchronizedTestLib.h

   1 /*
   2  * Copyright 2012 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef FOLLY_TEST_SYNCHRONIZEDTESTLIB_H
  18 #define FOLLY_TEST_SYNCHRONIZEDTESTLIB_H
  19
  20 // We have mutex types outside of folly that we want to test with Synchronized.
  21 // Make it easy for mutex implementators to test their classes with
  22 // Synchronized by just having a test like:
  23 //
  24 // class MyMutex { ... };
  25 //
  26 // TEST(Synchronized, Basic) {
  27 //   testBasic<MyMutex>();
  28 // }
  29 //
  30 // ... similar for testConcurrency, testDualLocking, etc.
  31
  32
  33 template <class Mutex> void testBasic();
  34
  35 template <class Mutex> void testConcurrency();
  36
  37 template <class Mutex> void testDualLocking();
  38
  39 template <class Mutex> void testDualLockingWithConst();
  40
  41 template <class Mutex> void testTimedSynchronized();
  42
  43 template <class Mutex> void testConstCopy();
  44
  45 #include "folly/test/SynchronizedTestLib-inl.h"
  46
  47 #endif /* FOLLY_TEST_SYNCHRONIZEDTESTLIB_H */