synchronicity (version 1.3.10)

boost.mutex: Create a boost.mutex object

Description

This function creates a boost.mutex object.

Usage

boost.mutex(sharedName = NULL, timeout = NULL, create = TRUE)

Arguments

sharedName

The name of the shared resource corresponding to the mutex. By default a universal unique identifier is supplied.

timeout

The amount of time (in seconds) that the mutex should try to attempt to get a lock. By default no timeout is supplied and the mutex will attempt to acquire the lock indefinitely.

create

Should the mutex be created or are we attaching to an existing on. Default is TRUE.

Examples

# Create a boost.mutex object with default resource name and no timeout.
x = boost.mutex()
rm(x)
gc()