| // Copyright 2008, Google Inc. |
| // All rights reserved. |
| // |
| // Redistribution and use in source and binary forms, with or without |
| // modification, are permitted provided that the following conditions are |
| // met: |
| // |
| // * Redistributions of source code must retain the above copyright |
| // notice, this list of conditions and the following disclaimer. |
| // * Redistributions in binary form must reproduce the above |
| // copyright notice, this list of conditions and the following disclaimer |
| // in the documentation and/or other materials provided with the |
| // distribution. |
| // * Neither the name of Google Inc. nor the names of its |
| // contributors may be used to endorse or promote products derived from |
| // this software without specific prior written permission. |
| // |
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| |
| #ifndef BASE_PLATFORM_THREAD_H_ |
| #define BASE_PLATFORM_THREAD_H_ |
| |
| #include "base/basictypes.h" |
| |
| #if defined(OS_WIN) |
| typedef void* PlatformThreadHandle; // HANDLE |
| #elif defined(OS_POSIX) |
| #include <pthread.h> |
| typedef pthread_t PlatformThreadHandle; |
| #endif |
| |
| // A namespace for low-level thread functions. |
| class PlatformThread { |
| public: |
| // Gets the current thread id, which may be useful for logging purposes. |
| static int CurrentId(); |
| |
| // Yield the current thread so another thread can be scheduled. |
| static void YieldCurrentThread(); |
| |
| // Sleeps for the specified duration (units are milliseconds). |
| static void Sleep(int duration_ms); |
| |
| // Sets the thread name visible to a debugger. This has no effect otherwise. |
| // To set the name of the current thread, pass PlatformThread::CurrentId() as |
| // the thread_id parameter. |
| static void SetName(int thread_id, const char* name); |
| |
| // Implement this interface to run code on a background thread. Your |
| // ThreadMain method will be called on the newly created thread. |
| class Delegate { |
| public: |
| virtual ~Delegate() {} |
| virtual void ThreadMain() = 0; |
| }; |
| |
| // Creates a new thread. The |stack_size| parameter can be 0 to indicate |
| // that the default stack size should be used. Upon success, |
| // |*thread_handle| will be assigned a handle to the newly created thread, |
| // and |delegate|'s ThreadMain method will be executed on the newly created |
| // thread. When you are done with the thread handle, you must call Join to |
| // release system resources associated with the thread. You must ensure that |
| // the Delegate object outlives the thread. |
| static bool Create(size_t stack_size, Delegate* delegate, |
| PlatformThreadHandle* thread_handle); |
| |
| // Joins with a thread created via the Create function. This function blocks |
| // the caller until the designated thread exits. |
| static void Join(PlatformThreadHandle thread_handle); |
| |
| private: |
| DISALLOW_IMPLICIT_CONSTRUCTORS(PlatformThread); |
| }; |
| |
| #endif // BASE_PLATFORM_THREAD_H_ |