From: Ilia Alshanetsky <iliaa@php.net>
Date: Tue, 4 Mar 2003 21:46:33 +0000 (+0000)
Subject: Added notes about locking functions.
X-Git-Tag: RELEASE_0_5~615
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=6efd9ea5c4f5d1d849bc5885050b87d0bf2cff10;p=php

Added notes about locking functions.
---

diff --git a/README.STREAMS b/README.STREAMS
index 16108cc822..f625406a3b 100644
--- a/README.STREAMS
+++ b/README.STREAMS
@@ -37,9 +37,10 @@ PHPAPI int php_stream_close(php_stream * stream);
 PHPAPI int php_stream_flush(php_stream * stream);
 PHPAPI int php_stream_seek(php_stream * stream, off_t offset, int whence);
 PHPAPI off_t php_stream_tell(php_stream * stream);
+PHPAPI int php_stream_lock(php_stream * stream, int mode);
 
 These (should) behave in the same way as the ANSI stdio functions with similar
-names: fread, fwrite, fprintf, feof, fgetc, fgets, fclose, fflush, fseek, ftell.
+names: fread, fwrite, fprintf, feof, fgetc, fgets, fclose, fflush, fseek, ftell, flock.
 
 Opening Streams
 ===============
@@ -157,6 +158,11 @@ can lead to a crash when the resource is later used/released.
 NOTE: If you are opening a stream and need it to be seekable, use the
 STREAM_MUST_SEEK option to php_stream_open_wrapper();
 
+PHPAPI int php_stream_supports_lock(php_stream * stream);
+
+This function will return either 1 (success) or 0 (failure) indicating whether or
+not a lock can be set on this stream. Typically you can only set locks on stdio streams.
+
 Casting Streams
 ===============
 What if your extension needs to access the FILE* of a user level file pointer?