X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/550343399aa1355469ffed72c8cf84c732dcf98b..b6428abaa5ac53c69c6113b86c0a0b8b05b93df7:/include/wx/thread.h?ds=sidebyside diff --git a/include/wx/thread.h b/include/wx/thread.h index 86b94bd467..036b3d0adb 100644 --- a/include/wx/thread.h +++ b/include/wx/thread.h @@ -324,19 +324,19 @@ public: wxCondError Wait(); // exactly as Wait() except that it may also return if the specified - // timeout ellapses even if the condition hasn't been signalled: in this + // timeout elapses even if the condition hasn't been signalled: in this // case, the return value is false, otherwise (i.e. in case of a normal // return) it is true // - // the timeeout parameter specifies a interval that needs to be waited in - // milliseconds + // the timeout parameter specifies an interval that needs to be waited for + // in milliseconds wxCondError WaitTimeout(unsigned long milliseconds); // NB: the associated mutex may or may not be locked by the calling thread // // this method unblocks one thread if any are blocking on the condition. // if no thread is blocking in Wait(), then the signal is NOT remembered - // The thread which was blocking on Wait(), will then reacquire the lock + // The thread which was blocking on Wait() will then reacquire the lock // on the associated mutex object before returning wxCondError Signal(); @@ -344,14 +344,15 @@ public: // // this method unblocks all threads if any are blocking on the condition. // if no thread is blocking in Wait(), then the signal is NOT remembered - // The threads which were blocking on Wait(), will then reacquire the lock + // The threads which were blocking on Wait() will then reacquire the lock // on the associated mutex object before returning. wxCondError Broadcast(); +#if WXWIN_COMPATIBILITY_2_6 // deprecated version, don't use - bool Wait(unsigned long milliseconds) - { return WaitTimeout(milliseconds) == wxCOND_NO_ERROR; } + wxDEPRECATED( bool Wait(unsigned long milliseconds) ); +#endif // WXWIN_COMPATIBILITY_2_6 private: wxConditionInternal *m_internal; @@ -359,6 +360,11 @@ private: DECLARE_NO_COPY_CLASS(wxCondition) }; +#if WXWIN_COMPATIBILITY_2_6 + inline bool wxCondition::Wait(unsigned long milliseconds) + { return WaitTimeout(milliseconds) == wxCOND_NO_ERROR; } +#endif // WXWIN_COMPATIBILITY_2_6 + // ---------------------------------------------------------------------------- // wxSemaphore: a counter limiting the number of threads concurrently accessing // a shared resource @@ -387,7 +393,7 @@ public: wxSemaError TryWait(); // same as Wait(), but as a timeout limit, returns wxSEMA_NO_ERROR if the - // semaphore was acquired and wxSEMA_TIMEOUT if the timeout has ellapsed + // semaphore was acquired and wxSEMA_TIMEOUT if the timeout has elapsed wxSemaError WaitTimeout(unsigned long milliseconds); // increments the semaphore count and signals one of the waiting threads @@ -436,7 +442,7 @@ public: // Returns true if current thread is the main thread. static bool IsMain(); - // Release the rest of our time slice leting the other threads run + // Release the rest of our time slice letting the other threads run static void Yield(); // Sleep during the specified period of time in milliseconds @@ -502,9 +508,9 @@ public: ExitCode Wait(); // kills the thread without giving it any chance to clean up - should - // not be used in normal circumstances, use Delete() instead. It is a - // dangerous function that should only be used in the most extreme - // cases! + // not be used under normal circumstances, use Delete() instead. + // It is a dangerous function that should only be used in the most + // extreme cases! // // The wxThread object is deleted by Kill() if the thread is // detachable, but you still have to delete it manually for joinable