sircondition.c File Reference

Functions
bool	_sir_condcreate (sir_condition *cond)
	Creates/initializes a new condition variable.
bool	_sir_condbroadcast (sir_condition *cond)
	Broadcast signals a condition variable.
bool	_sir_conddestroy (sir_condition *cond)
	Destroys a condition variable.
bool	_sir_condwait_timeout (sir_condition *cond, sir_mutex *mutex, const sir_wait *howlong)
	Waits a given amount of time for a condition variable to become signaled.

Detailed Description

Version

2.2.5

---

SPDX-License-Identifier: MIT

Copyright (c) 2018-2024 Ryan M. Lederman leder.nosp@m.man@.nosp@m.gmail.nosp@m..com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---

Function Documentation

_sir_condbroadcast()

bool _sir_condbroadcast

(

sir_condition *

cond

)

Broadcast signals a condition variable.

Parameters

cond	Pointer to a sir_condition to broadcast on.

Returns

bool true if successful, false otherwise.

_sir_condcreate()

bool _sir_condcreate

(

sir_condition *

cond

)

Creates/initializes a new condition variable.

Parameters

cond	Pointer to a sir_condition to initialize

Returns

bool true if successful, false otherwise.

_sir_conddestroy()

bool _sir_conddestroy

(

sir_condition *

cond

)

Destroys a condition variable.

Parameters

cond	Pointer to a sir_condition to destroy.

Returns

bool true if successful, false otherwise.

_sir_condwait_timeout()

bool _sir_condwait_timeout	(	sir_condition *	cond,
		sir_mutex *	mutex,
		const sir_wait *	howlong )

Waits a given amount of time for a condition variable to become signaled.

Parameters

cond	Pointer to a sir_condition to wait on.
mutex	Associated mutex object.
howlong	How long to wait before timing out.

Returns

bool true if successful, false if an error occurred or the operation timed out..