Automatic tying of fastbufs to resources.

[libucw.git] / ucw / doc / fastbuf.txt

diff --git a/ucw/doc/fastbuf.txt b/ucw/doc/fastbuf.txt
index a31b6bc3b8fcef779b8a178619b4c97362dc4171..86ab55d923dba0b55026c31489b4e050d4e9dfc9 100644 (file)
--- a/ucw/doc/fastbuf.txt
+++ b/ucw/doc/fastbuf.txt
@@ -13,28 +13,34 @@ Once you have a fastbuf, you can access it by fuctions similar to those of
 formatted operations.
 
 Please keep in mind that fastbufs do not allow arbitrary mixing of reads and
 formatted operations.
 
 Please keep in mind that fastbufs do not allow arbitrary mixing of reads and

-writes on the same stream. If you need to mix them, you have to call bflush()
-inbetween and remember that the file position reported by btell() points after
+writes on the same stream. If you need to mix them, you have to call @bflush()
+inbetween and remember that the file position reported by @btell() points after

 the flushed buffer, which is not necessarily the same as after the data you've
 really read.
 
 the flushed buffer, which is not necessarily the same as after the data you've
 really read.
 

+Most fastbuf back-ends also participate in the libucw resource management system.
+If you have a resource pool active, newly created fastbufs are automatically tied
+to resources in the pool, so when the pool gets cleaned up, the fastbufs are
+freed, too. The bclose() function is still available and it removes the tie
+as needed.
+

 .Back-ends:
 .Back-ends:

-- xref:fbparam[Files (parametrized)]
-- xref:fbfile[Regular files]
-- xref:fbtemp[Temporary files]
-- xref:fblim[File fragments]
-- xref:fbmem[In-memory streams]
-- xref:fbbuf[Buffers]
-- xref:fbgrow[Growing buffers]
-- xref:fbpool[Memory pools]
-- xref:fbatomic[Atomic files]
+- <<fbparam,Files (parametrized)>>
+- <<fbfile,Regular files>>
+- <<fbtemp,Temporary files>>
+- <<fblim,File fragments>>
+- <<fbmem,In-memory streams>>
+- <<fbbuf,Buffers>>
+- <<fbgrow,Growing buffers>>
+- <<fbpool,Memory pools>>
+- <<fbatomic,Atomic files>>

 
 .Front-ends:
 
 .Front-ends:

-- xref:ffbasic[Basic functions]
+- <<ffbasic,Basic functions>>

 
 .Other reading:
 
 .Other reading:

-- xref:internal[Internal structure]
-- xref:bconfig[Configuring streams]
+- <<internal,Internal structure>>
+- <<bconfig,Configuring streams>>

 
 ucw/fastbuf.h
 -------------
 
 ucw/fastbuf.h
 -------------


@@ -53,11 +59,11 @@ ucw/ff-unicode.h
 
 Reading and writing of unicode characters.
 
 
 Reading and writing of unicode characters.
 

-Invalid codes are replaced by +UNI_REPLACEMENT+ when reading.
+Invalid codes are replaced by `UNI_REPLACEMENT` when reading.

 
 !!ucw/ff-unicode.h
 
 ucw/ff-binary.h
 ---------------
 
 
 !!ucw/ff-unicode.h
 
 ucw/ff-binary.h
 ---------------
 

-Reading and writing of binary values.
+!!ucw/ff-binary.h