X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6e6110ee8194ee39944dffd57cce9f22cd8b961e..aa0ff209bc82d0f7c48263bb28609769d09f051b:/docs/latex/wx/critsect.tex diff --git a/docs/latex/wx/critsect.tex b/docs/latex/wx/critsect.tex index 884c3ed19c..83cf6fb8c7 100644 --- a/docs/latex/wx/critsect.tex +++ b/docs/latex/wx/critsect.tex @@ -1,7 +1,7 @@ \section{\class{wxCriticalSection}}\label{wxcriticalsection} -A critical section object is used exactly for the same purpose as -\helpref{mutexes}{wxMutex}. The only difference is that under Windows platform +A critical section object is used for exactly the same purpose as +\helpref{mutexes}{wxmutex}. The only difference is that under Windows platform critical sections are only visible inside one process, while mutexes may be shared between processes, so using critical sections is slightly more efficient. The terminology is also slightly different: mutex may be locked (or @@ -18,24 +18,31 @@ possible instead of directly using wxCriticalSection for the same reasons None. +\wxheading{Include files} + + + \wxheading{See also} -\helpref{wxThread}{wxthread}, \helpref{wxCondition}{wxcondition}, -\helpref{wxMutexLocker}{wxmutexlocker}, \helpref{wxCriticalSection}{wxcriticalsection} +\helpref{wxThread}{wxthread}, \helpref{wxCondition}{wxcondition}, +\helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker} \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxCriticalSection::wxCriticalSection}\label{wxcriticalsectionctor} + \func{}{wxCriticalSection}{\void} Default constructor initializes critical section object. \membersection{wxCriticalSection::\destruct{wxCriticalSection}}\label{wxcriticalsectiondtor} + \func{}{\destruct{wxCriticalSection}}{\void} -Destructor frees the ressources. +Destructor frees the resources. \membersection{wxCriticalSection::Enter}\label{wxcriticalsectionenter} + \func{void }{Enter}{\void} Enter the critical section (same as locking a mutex). There is no error return @@ -43,7 +50,9 @@ for this function. After entering the critical section protecting some global data the thread running in critical section may safely use/modify it. \membersection{wxCriticalSection::Leave}\label{wxcriticalsectionleave} + \func{void }{Leave}{\void} Leave the critical section allowing other threads use the global data protected by it. There is no error return for this function. +