X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6e6110ee8194ee39944dffd57cce9f22cd8b961e..4e28924cdb58dfbba0ec6cd5d52ef1346d0cb569:/docs/latex/wx/critsect.tex diff --git a/docs/latex/wx/critsect.tex b/docs/latex/wx/critsect.tex index 884c3ed19c..0851745cd8 100644 --- a/docs/latex/wx/critsect.tex +++ b/docs/latex/wx/critsect.tex @@ -1,6 +1,6 @@ \section{\class{wxCriticalSection}}\label{wxcriticalsection} -A critical section object is used exactly for the same purpose as +A critical section object is used for the same exactly 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 @@ -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{wxThread}{wxthread}, \helpref{wxCondition}{wxcondition}, \helpref{wxMutexLocker}{wxmutexlocker}, \helpref{wxCriticalSection}{wxcriticalsection} \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. \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. +