status-im/nim-chronos
2
0
Fork 0
mirror of https://github.com/status-im/nim-chronos.git synced 2025-02-21 23:48:15 +00:00
Code Issues Projects Releases Wiki Activity

Updated README.

Browse Source
This commit is contained in:
cheatfate 2018-05-29 02:45:15 +03:00
parent 3c7273d532
commit e33ed13fb5
1 changed files with 23 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -8,15 +8,16 @@ Asyncdispatch hard fork.
1. Unified callback type `CallbackFunc`.
Current version of asyncdispatch uses many types of callbacks.
- `proc ()` used in callSoon() callbacks and Future[T] completion callbacks.
- `proc (fut: Future[T])` used in Future[T] completion callbacks.
- `proc (fd: AsyncFD, bytesTransferred: Dword, errcode: OSErrorCode)` used in Windows IO completion callbacks.
- `proc (fd: AsyncFD): bool` used in Unix IO events callbacks.
* `proc ()` used in callSoon() callbacks and Future[T] completion callbacks.
* `proc (fut: Future[T])` used in Future[T] completion callbacks.
* `proc (fd: AsyncFD, bytesTransferred: Dword, errcode: OSErrorCode)` used in Windows IO completion callbacks.
* `proc (fd: AsyncFD): bool` used in Unix IO events callbacks.
Such a number of different types creates big problems in the storage, processing and interaction between callbacks. Lack of ability to pass custom user data to
callback also creates difficulties and inefficiency, to pass custom user-defined data you need to use closures (one more allocation).
To resolve this issue introduced unified callback type `CallbackFunc`, which is looks like
To resolve this issue introduced unified callback type `CallbackFunc`, which is looks like:
```nim
type
CallbackFunc* = proc (arg: pointer = nil) {.gcsafe.}
@ -32,7 +33,7 @@ Asyncdispatch hard fork.
2. Future[T] completion callbacks order.
Current version of asyncdispatch processing Future[T] completion callbacks in reverse order, asyncdispatch2 schedule callbacks in forward order.
- https://github.com/nim-lang/Nim/issues/7197
* https://github.com/nim-lang/Nim/issues/7197
3. Changed behavior of OS decriptor events callbacks.
For some unknown reason current version of asyncdispatch uses seq[T] to hold list of descriptor event listeners. Actually in asynchronous environment there no need to have list of event listeners.
@ -42,32 +43,30 @@ Asyncdispatch hard fork.
4. Removed default timeout value for poll() procedure, which allows incorrect
usage asyncdispatch and produces 500ms timeouts in correct usage.
5. Changed behavior of scheduler in poll() procedure.
Fixed issues:
- https://github.com/nim-lang/Nim/issues/7758
- https://github.com/nim-lang/Nim/issues/7197
- https://github.com/nim-lang/Nim/issues/7193
- https://github.com/nim-lang/Nim/issues/7192
- https://github.com/nim-lang/Nim/issues/6846
- https://github.com/nim-lang/Nim/issues/6929
5. Changed behavior of scheduler in poll() procedure. Fixed issues:
* https://github.com/nim-lang/Nim/issues/7758
* https://github.com/nim-lang/Nim/issues/7197
* https://github.com/nim-lang/Nim/issues/7193
* https://github.com/nim-lang/Nim/issues/7192
* https://github.com/nim-lang/Nim/issues/6846
* https://github.com/nim-lang/Nim/issues/6929
5. Asyncdispatch2 no longer use `epochTime()`, it uses most fastest time primitives for specific OS `fastEpochTime()`. Also because MacOS supports only millisecond resolution in `kqueue` there no need on submillisecond resolution.
6. Asyncdispatch2 no longer use `epochTime()`, it uses most fastest time primitives for specific OS `fastEpochTime()`. Also because MacOS supports only millisecond resolution in `kqueue` there no need on submillisecond resolution.
https://github.com/nim-lang/Nim/issues/3909
https://github.com/nim-lang/Nim/issues/3909
7. Removed all IO primitives `recv()`, `recvFrom()`, `connect()`, `accept()`, `send()`, `sendTo()`` from public API, and moved all it functionality into Transports.
6. Removed all IO primitives recv(), recvFrom(), connect(), accept(), send(), sendTo() from public API, and moved all it functionality into Transports.
8. Introduced `addTimer()` / `removeTimer()` callback interface.
7. Introduced addTimer/removeTimer callback interface.
9. Introduced `removeReader()` for `addReader()` and `removeWriter()` for `addWriter()`.
8. Introduced removeReader() for addReader() and removeWriter() for addWriter().
10. Changed behavior of `addReader()`, `addWriter()`, `addTimer()` callbacks, now only explicit removal of callbacks must be supplied via (`removeReader()`, `removeWriter()`, `removeTimer()`)
9. Changed behavior of addReader()/addWriter()/addTimer() callbacks, now only explicit removal of callbacks must be supplied via (removeReader(), removeWriter(), removeTimer())
11. Support cross-platform `sendfile()` operation.
10. Support cross-platform `sendfile` operation.
12. Removed expensive `AsyncEvent`, also removed support of hardware timers and ``addProcess``. (``addProcess`` will be implement as SubprocessTransport, while hardware based `AsyncEvent` will be renamed to ``ThreadAsyncEvent``).
11. Removed expensive `AsyncEvent`, also removed support of hardware timers and ``addProcess``. (``addProcess`` will be implement as SubprocessTransport, while hardware based `AsyncEvent` will be renamed to ``ThreadAsyncEvent``).
12. Added cheap synchronization primitives AsyncLock, AsyncEvent, AsyncQueue[T].
13. Added cheap synchronization primitives `AsyncLock`, `AsyncEvent`, `AsyncQueue[T]`.
## Transport concept.