2016-01-07 16:06:06 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
< meta name = "generator" content = "Doxygen 1.8.10" / >
< title > WUT: Condition Variable< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "search/searchdata.js" > < / script >
< script type = "text/javascript" src = "search/search.js" > < / script >
< script type = "text/javascript" >
$(document).ready(function() { init_search(); });
< / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
< td id = "projectalign" style = "padding-left: 0.5em;" >
< div id = "projectname" > WUT
  < span id = "projectnumber" > 0.1< / span >
< / div >
< div id = "projectbrief" > Wii U Toolchain< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
< script type = "text/javascript" >
var searchBox = new SearchBox("searchBox", "search",false,'Search');
< / script >
< div id = "navrow1" class = "tabs" >
< ul class = "tablist" >
< li > < a href = "index.html" > < span > Main  Page< / span > < / a > < / li >
< li > < a href = "modules.html" > < span > Modules< / span > < / a > < / li >
< li > < a href = "annotated.html" > < span > Data  Structures< / span > < / a > < / li >
< li > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< li >
< div id = "MSearchBox" class = "MSearchBoxInactive" >
< span class = "left" >
< img id = "MSearchSelect" src = "search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
< input type = "text" id = "MSearchField" value = "Search" accesskey = "S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
< / span > < span class = "right" >
< a id = "MSearchClose" href = "javascript:searchBox.CloseResultsWindow()" > < img id = "MSearchCloseImg" border = "0" src = "search/close.png" alt = "" / > < / a >
< / span >
< / div >
< / li >
< / ul >
< / div >
< / div > <!-- top -->
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< iframe src = "javascript:void(0)" frameborder = "0"
name="MSearchResults" id="MSearchResults">
< / iframe >
< / div >
< div class = "header" >
< div class = "summary" >
< a href = "#nested-classes" > Data Structures< / a > |
< a href = "#define-members" > Macros< / a > |
< a href = "#typedef-members" > Typedefs< / a > |
< a href = "#func-members" > Functions< / a > < / div >
< div class = "headertitle" >
2016-01-07 16:14:21 +00:00
< div class = "title" > Condition Variable< div class = "ingroups" > < a class = "el" href = "group__coreinit.html" > coreinit< / a > < / div > < / div > < / div >
2016-01-07 16:06:06 +00:00
< / div > <!-- header -->
< div class = "contents" >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "nested-classes" > < / a >
Data Structures< / h2 > < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct_o_s_condition.html" > OSCondition< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "define-members" > < / a >
Macros< / h2 > < / td > < / tr >
< tr class = "memitem:ga9d3012d9d937bcd9fcfc12824af9011d" > < td class = "memItemLeft" align = "right" valign = "top" > #define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__coreinit__cond.html#ga9d3012d9d937bcd9fcfc12824af9011d" > OS_CONDITION_TAG< / a >       0x634E6456u< / td > < / tr >
< tr class = "separator:ga9d3012d9d937bcd9fcfc12824af9011d" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "typedef-members" > < / a >
Typedefs< / h2 > < / td > < / tr >
< tr class = "memitem:ga00db74c3d6ce5f40511557e92df133eb" > < td class = "memItemLeft" align = "right" valign = "top" > typedef struct < a class = "el" href = "struct_o_s_condition.html" > OSCondition< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__coreinit__cond.html#ga00db74c3d6ce5f40511557e92df133eb" > OSCondition< / a > < / td > < / tr >
< tr class = "separator:ga00db74c3d6ce5f40511557e92df133eb" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga42b7c5a07043d7f6c8324f51ac1747c8" > < td class = "memItemLeft" align = "right" valign = "top" > typedef struct < a class = "el" href = "struct_o_s_mutex.html" > OSMutex< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__coreinit__cond.html#ga42b7c5a07043d7f6c8324f51ac1747c8" > OSMutex< / a > < / td > < / tr >
< tr class = "separator:ga42b7c5a07043d7f6c8324f51ac1747c8" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
< tr class = "memitem:ga3380e1614dffb59637175a508d6f8395" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__coreinit__cond.html#ga3380e1614dffb59637175a508d6f8395" > OSInitCond< / a > (< a class = "el" href = "struct_o_s_condition.html" > OSCondition< / a > *condition)< / td > < / tr >
< tr class = "separator:ga3380e1614dffb59637175a508d6f8395" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga3fb5e451c43c561142042258ab65650d" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__coreinit__cond.html#ga3fb5e451c43c561142042258ab65650d" > OSInitCondEx< / a > (< a class = "el" href = "struct_o_s_condition.html" > OSCondition< / a > *condition, const char *name)< / td > < / tr >
< tr class = "separator:ga3fb5e451c43c561142042258ab65650d" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gab0defea1070e1f129578d98dc023f05d" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__coreinit__cond.html#gab0defea1070e1f129578d98dc023f05d" > OSWaitCond< / a > (< a class = "el" href = "struct_o_s_condition.html" > OSCondition< / a > *condition, < a class = "el" href = "struct_o_s_mutex.html" > OSMutex< / a > *mutex)< / td > < / tr >
< tr class = "separator:gab0defea1070e1f129578d98dc023f05d" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga4ad088d1be5fd1558263491a65b48984" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__coreinit__cond.html#ga4ad088d1be5fd1558263491a65b48984" > OSSignalCond< / a > (< a class = "el" href = "struct_o_s_condition.html" > OSCondition< / a > *condition)< / td > < / tr >
< tr class = "separator:ga4ad088d1be5fd1558263491a65b48984" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
2016-01-07 19:25:33 +00:00
< p > Standard condition variable implementation.< / p >
< p > Similar to < a href = "http://en.cppreference.com/w/cpp/thread/condition_variable" > std::condition_variable< / a > . < / p >
2016-01-07 16:06:06 +00:00
< h2 class = "groupheader" > Macro Definition Documentation< / h2 >
< a class = "anchor" id = "ga9d3012d9d937bcd9fcfc12824af9011d" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > #define OS_CONDITION_TAG      0x634E6456u< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2016-01-07 19:25:33 +00:00
< p > Definition at line < a class = "el" href = "condition_8h_source.html#l00022" > 22< / a > of file < a class = "el" href = "condition_8h_source.html" > condition.h< / a > .< / p >
2016-01-07 16:06:06 +00:00
< / div >
< / div >
< h2 class = "groupheader" > Typedef Documentation< / h2 >
< a class = "anchor" id = "ga00db74c3d6ce5f40511557e92df133eb" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef struct < a class = "el" href = "struct_o_s_condition.html" > OSCondition< / a > < a class = "el" href = "struct_o_s_condition.html" > OSCondition< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2016-01-07 19:25:33 +00:00
< p > Definition at line < a class = "el" href = "condition_8h_source.html#l00019" > 19< / a > of file < a class = "el" href = "condition_8h_source.html" > condition.h< / a > .< / p >
2016-01-07 16:06:06 +00:00
< / div >
< / div >
< a class = "anchor" id = "ga42b7c5a07043d7f6c8324f51ac1747c8" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef struct < a class = "el" href = "struct_o_s_mutex.html" > OSMutex< / a > < a class = "el" href = "struct_o_s_mutex.html" > OSMutex< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2016-01-07 19:25:33 +00:00
< p > Definition at line < a class = "el" href = "condition_8h_source.html#l00020" > 20< / a > of file < a class = "el" href = "condition_8h_source.html" > condition.h< / a > .< / p >
2016-01-07 16:06:06 +00:00
< / div >
< / div >
< h2 class = "groupheader" > Function Documentation< / h2 >
< a class = "anchor" id = "ga3380e1614dffb59637175a508d6f8395" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void OSInitCond < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_o_s_condition.html" > OSCondition< / a > *  < / td >
< td class = "paramname" > < em > condition< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2016-01-07 19:25:33 +00:00
< p > Initialise a condition variable structure. < / p >
2016-01-07 16:06:06 +00:00
< / div >
< / div >
< a class = "anchor" id = "ga3fb5e451c43c561142042258ab65650d" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void OSInitCondEx < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_o_s_condition.html" > OSCondition< / a > *  < / td >
< td class = "paramname" > < em > condition< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const char *  < / td >
< td class = "paramname" > < em > name< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2016-01-07 19:25:33 +00:00
< p > Initialise a condition variable structure with a name. < / p >
2016-01-07 16:06:06 +00:00
< / div >
< / div >
< a class = "anchor" id = "ga4ad088d1be5fd1558263491a65b48984" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void OSSignalCond < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_o_s_condition.html" > OSCondition< / a > *  < / td >
< td class = "paramname" > < em > condition< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2016-01-07 19:25:33 +00:00
< p > Will wake up any threads waiting on the condition with OSWaitCond.< / p >
< p > Similar to < a href = "http://en.cppreference.com/w/cpp/thread/condition_variable/notify_all" > std::condition_variable::notify_all< / a > . < / p >
2016-01-07 16:06:06 +00:00
< / div >
< / div >
< a class = "anchor" id = "gab0defea1070e1f129578d98dc023f05d" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void OSWaitCond < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_o_s_condition.html" > OSCondition< / a > *  < / td >
< td class = "paramname" > < em > condition< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > < a class = "el" href = "struct_o_s_mutex.html" > OSMutex< / a > *  < / td >
< td class = "paramname" > < em > mutex< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2016-01-07 19:25:33 +00:00
< p > Sleep the current thread until the condition variable has been signalled.< / p >
< p > The mutex must be locked when entering this function. Will unlock the mutex and then sleep, reacquiring the mutex when woken.< / p >
< p > Similar to < a href = "http://en.cppreference.com/w/cpp/thread/condition_variable/wait" > std::condition_variable::wait< / a > . < / p >
2016-01-07 16:06:06 +00:00
< / div >
< / div >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
Generated by   < a href = "http://www.doxygen.org/index.html" >
< img class = "footer" src = "doxygen.png" alt = "doxygen" / >
< / a > 1.8.10
< / small > < / address >
< / body >
< / html >