inc/FBaseRtTypes.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 // http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file                FBaseRtTypes.h
  20  * @brief               This is the header file for types in the Runtime package.
  21  *
  22  * This header file defines the types in the Runtime package.
  23  */
  24 #ifndef _FBASE_RT_TYPES_H_
  25 #define _FBASE_RT_TYPES_H_
  26
  27 #include <FBaseTypes.h>
  28
  29 namespace Tizen { namespace Base { namespace Runtime
  30 {
  31
  32 /**
  33 * This method is for internal use only. Using this method can cause behavioral, security-related,
  34 * and consistency-related issues in the application.
  35 *
  36 * @since 2.0
  37 */
  38 enum TimerStatus
  39 {
  40         TIMER_STATUS_NOT_ACTIVATED, // This enum value is for internal use only. Using this enum can cause behavioral, security-related, and consistency-related issues in the application.
  41         TIMER_STATUS_ACTIVATED,     // This enum value is for internal use only. Using this enum can cause behavioral, security-related, and consistency-related issues in the application.
  42         TIMER_STATUS_CANCELED,      // This enum value is for internal use only. Using this enum can cause behavioral, security-related, and consistency-related issues in the application.
  43         TIMER_STATUS_EXPIRED,       // This enum value is for internal use only. Using this enum can cause behavioral, security-related, and consistency-related issues in the application.
  44         TIMER_STATUS_ACTIVATED_REPEATABLE,       // This enum value is for internal use only. Using this enum can cause behavioral, security-related, and consistency-related issues in the application.
  45 };
  46
  47 /**
  48 * @struct       TryTag
  49 * @brief        This struct is used only for supporting non-blocking acquisition of a resource
  50 *
  51 * This struct is used for just discriminating between blocking and non-blocking acquisition
  52 * of a resource. So, the definition is empty.
  53 *
  54 * @since 2.0
  55 *
  56 * @see          MutexGuard
  57 * @see          SemaphoreGuard
  58 * @see          Try
  59 */
  60 struct TryTag
  61 {
  62 };
  63
  64 /**
  65 * @brief        Used only for for just discriminating between blocking and non-blocking acquisition
  66 *
  67 * @code
  68 * Mutex m;
  69 * m.Create();
  70 * {
  71 *     MutexGuard guard(m, Try);
  72 *     // Access to shared resources
  73 * }
  74 *
  75 * Semaphore s;
  76 * s.Create();
  77 * {
  78 *     SemaphoreGuard guard(s, Try);
  79 *     // Access to multiple shared resources
  80 * }
  81 * @endcode
  82 */
  83 static const TryTag Try = {};
  84
  85 } } } // Tizen::Runtime
  86
  87 #endif // _FBASE_RT_TYPES_H_