flockfile(3)

flockfile3

Stdio locking functions

Usage

#include <stdio.h>

void

flockfile(FILE *file);

int

ftrylockfile(FILE *file);

void

funlockfile(FILE *file);

Library

Standard C Library (libc, -lc)

Overview

These functions provide explicit application-level locking of stdio FILE objects. They can be used to avoid output from multiple threads being interspersed, input being dispersed among multiple readers, and to avoid the overhead of locking the object for each operation.

The flockfile() function acquires an exclusive lock on the specified object. If another thread has already locked the object, flockfile() will block until the lock is released.

The ftrylockfile() function is a non-blocking version of flockfile(); if the lock cannot be acquired immediately, ftrylockfile() returns non-zero instead of blocking.

The funlockfile() function releases the lock on an object acquired by an earlier call to flockfile() or ftrylockfile().

These functions behave as if there is a lock count associated with each object. Each time flockfile() is called on the object, the count is incremented, and each time funlockfile() is called on the object, the count is decremented. The lock is only actually released when the count reaches zero.

Return values

The flockfile() and funlockfile() functions return no value.

The ftrylockfile() function returns zero if the object was successfully locked, non-zero otherwise.

Releases

145 releases since Mac OS X 10.3; the text changed 1 time.

  1. 10.3–10.4.11
  2. 10.5–26.5

Standards

The flockfile(), ftrylockfile(), and funlockfile() functions conform to IEEE Std 1003.1-2001 (“POSIX.1”).

From Libc 1752.120.2 in macOS 26.5. Parsed by carta from the page's mdoc source.