debian-packages/eventcore
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Improve documentation w.r.t to concurrent writes/reads

Browse source
This commit is contained in:
Tobias Pankrath 2020-08-28 20:39:03 +02:00 committed by Mathias LANG
parent ac4aec341e
commit 1fcc941b1f
1 changed files with 26 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
source/eventcore/driver.d
View file

@ -264,7 +264,6 @@ interface EventDriverSockets {
Note that only a single read operation is allowed at once. The caller Note that only a single read operation is allowed at once. The caller
needs to make sure that either `on_read_finish` got called, or needs to make sure that either `on_read_finish` got called, or
`cancelRead` was called before issuing the next call to `read`. `cancelRead` was called before issuing the next call to `read`.
However, concurrent writes are legal.
Waiting_for_data_availability: Waiting_for_data_availability:
With the special combination of a zero-length buffer and `mode` With the special combination of a zero-length buffer and `mode`
@ -291,7 +290,6 @@ interface EventDriverSockets {
Note that only a single write operation is allowed at once. The caller Note that only a single write operation is allowed at once. The caller
needs to make sure that either `on_write_finish` got called, or needs to make sure that either `on_write_finish` got called, or
`cancelWrite` was called before issuing the next call to `write`. `cancelWrite` was called before issuing the next call to `write`.
However, concurrent reads are legal.
*/ */
void write(StreamSocketFD socket, const(ubyte)[] buffer, IOMode mode, IOCallback on_write_finish); void write(StreamSocketFD socket, const(ubyte)[] buffer, IOMode mode, IOCallback on_write_finish);
@ -479,9 +477,34 @@ interface EventDriverFiles {
*/ */
void truncate(FileFD file, ulong size, FileIOCallback on_finish); void truncate(FileFD file, ulong size, FileIOCallback on_finish);
/** Writes data to a file
Note that only a single read operation is allowed at once. The caller
needs to make sure that either `on_read_finish` got called, or
`cancelRead` was called before issuing the next call to `read`.
*/
void write(FileFD file, ulong offset, const(ubyte)[] buffer, IOMode mode, FileIOCallback on_write_finish); void write(FileFD file, ulong offset, const(ubyte)[] buffer, IOMode mode, FileIOCallback on_write_finish);
void read(FileFD file, ulong offset, ubyte[] buffer, IOMode mode, FileIOCallback on_read_finish);
/** Cancels an ongoing write operation.
After this function has been called, the `FileIOCallback` specified in
the call to `write` is guaranteed not to be called.
*/
void cancelWrite(FileFD file); void cancelWrite(FileFD file);
/** Reads data from a file.
Note that only a single read operation is allowed at once. The caller
needs to make sure that either `on_read_finish` got called, or
`cancelRead` was called before issuing the next call to `read`.
*/
void read(FileFD file, ulong offset, ubyte[] buffer, IOMode mode, FileIOCallback on_read_finish);
/** Cancels an ongoing read operation.
After this function has been called, the `FileIOCallback` specified in
the call to `read` is guaranteed not to be called.
*/
void cancelRead(FileFD file); void cancelRead(FileFD file);
/** Determines whether the given file handle is valid. /** Determines whether the given file handle is valid.