.TH "include/Zycore/API/Synchronization.h" 3 "Version 1.5.0.0" "Zycore" \" -*- nroff -*-
.ad l
.nh
.SH NAME
include/Zycore/API/Synchronization.h
.SH SYNOPSIS
.br
.PP
\fC#include <Zycore/Defines\&.h>\fP
.br
\fC#include <Zycore/Status\&.h>\fP
.br

.SS "Functions"

.in +1c
.ti -1c
.RI "\fBZYCORE_EXPORT\fP \fBZyanStatus\fP \fBZyanCriticalSectionInitialize\fP (ZyanCriticalSection *critical_section)"
.br
.ti -1c
.RI "\fBZYCORE_EXPORT\fP \fBZyanStatus\fP \fBZyanCriticalSectionEnter\fP (ZyanCriticalSection *critical_section)"
.br
.ti -1c
.RI "\fBZYCORE_EXPORT\fP \fBZyanBool\fP \fBZyanCriticalSectionTryEnter\fP (ZyanCriticalSection *critical_section)"
.br
.ti -1c
.RI "\fBZYCORE_EXPORT\fP \fBZyanStatus\fP \fBZyanCriticalSectionLeave\fP (ZyanCriticalSection *critical_section)"
.br
.ti -1c
.RI "\fBZYCORE_EXPORT\fP \fBZyanStatus\fP \fBZyanCriticalSectionDelete\fP (ZyanCriticalSection *critical_section)"
.br
.in -1c
.SH "Function Documentation"
.PP 
.SS "\fBZYCORE_EXPORT\fP \fBZyanStatus\fP ZyanCriticalSectionDelete (ZyanCriticalSection * critical_section)"
Deletes a critical section\&.
.PP
\fBParameters\fP
.RS 4
\fIcritical_section\fP A pointer to the \fCZyanCriticalSection\fP struct\&. 
.RE
.PP

.SS "\fBZYCORE_EXPORT\fP \fBZyanStatus\fP ZyanCriticalSectionEnter (ZyanCriticalSection * critical_section)"
Enters a critical section\&.
.PP
\fBParameters\fP
.RS 4
\fIcritical_section\fP A pointer to the \fCZyanCriticalSection\fP struct\&. 
.RE
.PP

.SS "\fBZYCORE_EXPORT\fP \fBZyanStatus\fP ZyanCriticalSectionInitialize (ZyanCriticalSection * critical_section)"
Initializes a critical section\&.
.PP
\fBParameters\fP
.RS 4
\fIcritical_section\fP A pointer to the \fCZyanCriticalSection\fP struct\&. 
.RE
.PP

.SS "\fBZYCORE_EXPORT\fP \fBZyanStatus\fP ZyanCriticalSectionLeave (ZyanCriticalSection * critical_section)"
Leaves a critical section\&.
.PP
\fBParameters\fP
.RS 4
\fIcritical_section\fP A pointer to the \fCZyanCriticalSection\fP struct\&. 
.RE
.PP

.SS "\fBZYCORE_EXPORT\fP \fBZyanBool\fP ZyanCriticalSectionTryEnter (ZyanCriticalSection * critical_section)"
Tries to enter a critical section\&.
.PP
\fBParameters\fP
.RS 4
\fIcritical_section\fP A pointer to the \fCZyanCriticalSection\fP struct\&.
.RE
.PP
\fBReturns\fP
.RS 4
Returns \fCZYAN_TRUE\fP if the critical section was successfully entered or \fCZYAN_FALSE\fP, if not\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for Zycore from the source code\&.