platformTLS.h

Classes:

class
Platform independent per-thread storage class.
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _PLATFORMTLS_H_
25#define _PLATFORMTLS_H_
26
27#ifndef _TORQUE_TYPES_H_
28#include "platform/types.h"
29#endif
30
31struct PlatformThreadStorage;
32
33/// Platform independent per-thread storage class.
34class ThreadStorage
35{
36   enum
37   {
38      PlatformThreadStorageStorageSize = 32,
39   };
40
41   PlatformThreadStorage *mThreadStorage;
42   U8 mStorage[PlatformThreadStorageStorageSize];
43public:
44   /// ThreadStorage constructor.
45   ThreadStorage();
46   /// ThreadStorage destructor.
47   ~ThreadStorage();
48
49   /// returns the per-thread stored void pointer for this ThreadStorage.  The default value is NULL.
50   void *get();
51   /// sets the per-thread stored void pointer for this ThreadStorage object.
52   void set(void *data);
53};
54
55
56#endif
57