Update documentation.
This commit is contained in:
1 parent
6967da1e86
commit
c52ce9708b
1 file changed
+13
-9
@@ -2090,16 +2090,20 @@ MOVE operator.
|
||||
|
||||
##### type *name\_write(snapshot\_t snap)
|
||||
|
||||
Take an atomic snap of the active written contain of the snapshot 'snap'
|
||||
and clotures it.
|
||||
It returns the pointer to the new active written contain of the snapshot
|
||||
(which is not snapped).
|
||||
Publish the 'in-progress' data of the snapshot 'snap so that the read
|
||||
thread can have access to the data.
|
||||
It returns the pointer to the new 'in-progress' data buffer
|
||||
of the snapshot (which is not yet published but will be pusblished
|
||||
for the next call of name\_write).
|
||||
This functions is thread-safe and performs atomic operation on the snapshot.
|
||||
|
||||
##### type *name\_read(snapshot\_t snap)
|
||||
|
||||
Look at the last atomic snap of the active read contain of the snapshot 'snap'.
|
||||
Get access to the last published data of the snapshot 'snap'.
|
||||
It returns the pointer to the data.
|
||||
If a publication has been performed since the last call to name\_read
|
||||
a new pointer to the data is returned.
|
||||
Otherwise the previous pointer is returned.
|
||||
This functions is thread-safe and performs atomic operation on the snapshot.
|
||||
|
||||
##### bool name\_updated\_p(snapshot\_t snap)
|
||||
@@ -2110,14 +2114,14 @@ This functions is thread-safe and performs atomic operation on the snapshot.
|
||||
|
||||
##### type *name\_get\_write\_buffer(snapshot\_t snap)
|
||||
|
||||
Return a pointer to the active 'in-progress' contain of the snapshot 'snap'.
|
||||
It is the same as the last return from name\_take.
|
||||
Return a pointer to the active 'in-progress' data of the snapshot 'snap'.
|
||||
It is the same as the last return from name\_write.
|
||||
This functions is thread-safe and performs atomic operation on the snapshot.
|
||||
|
||||
##### type *name\_get\_read\_buffer(snapshot\_t snap)
|
||||
|
||||
Return a pointer to the active 'freezed' contain of the snapshot 'snap'.
|
||||
It is the same as the last return from name\_look.
|
||||
Return a pointer to the active published data of the snapshot 'snap'.
|
||||
It is the same as the last return from name\_read.
|
||||
It doesn't perform any switch of the data which has to be read.
|
||||
This functions is thread-safe and performs atomic operation on the snapshot.
|
||||
|
||||
|
||||
Reference in new issue
Block a user