* replace stream module by improved version of readable/writable impl
* rm server.js
* async api improvments:
- better tracing of calls from worker back and forth
- fix transferrable handling to avoid copying buffers for r/w
- optional debug logs
- completed jsdocs annotations
- add dispose method
- add setLogLevel method (analoguous to added binding)
* node-srt C bindings:
- add SetLogLevel to get libSRT log output if desired
- add OK static member
- add #define EPOLL_EVENTS_NUM_MAX 1024
- improve error string thrown in Read (add that it comes from srt_recvmsg)
- improve error string thrown in Write (add that it comes from srt_sendmsg2)
- misc isofunctional improvements (var names) and comments
* add SRT logging related JS-side helper
* rewrite flat TypeScript decl files without "module" keyword
* add ts enum decl for all libSRT enums
* async-worker: enable using transferrable for zero-copy
+ allow better debugging (like in api/dispatcher side)
+ misc improvements on code quality
* add async-helpers: various functions to help dealing with transferrables
+ tracing calls to native bindings in debug output
* add async read/write modes functions + async-reader-writer class
- these will allow for performing high-level r/w operations conveniently
at optimum throughput for larger pieces of payload i.e list of packets.
* add srt-server and srt-connection (can manage multiple clients),
- based on async-api
- can be used with reader/writer (i.e the underlying modes)
* srt-server/connection typings
* async srt spec: add dispose method usage (but commented out as crashing atm)
* async srt spec: rm redundant checks on SRT static members (they are done
in other spec already)
* promises api spec: formal fixes
* stream spec: add dummy test
* package.json:
- put gyp toolchain in runtime deps (since the build happens on install)
- add JEST test runner
- shorten check-tsc script
- rebuild script: check & use all CPU cores available
- run rebuild actually on install, not preinstall (fixes deps not being there)
- remove preinstall and thus "npm install git-clone" in the package scripts
* update package lock
* update typings index not to need triple-slashs anymore
* in srt.ts example: check for read return value type
* build-srt-sdk script:
- allow to use any local libSRT code repo
- when using make: use all amount of cores available for build
- isolate better code running on different platforms
* update package main index with new things
* add enum typings index
* add jest config
* add "use strict" on async-srt-await example
* add integration/smoke testing for client-to-server one-way burst write
* readme: add note on build prerequisites
* readme: add infos on new components SRTServer/Connection & AsyncReaderWriter
* various fixes to readable-stream implementation using blocking srt calls.
- refactor reading/pushing routine in order to allow higher througput:
* call srt read() in the same tick/stack as the class _read impl call
* schedule a timer only as needed if no connection yet or socket buffer empty
* blocking loop to push all bytes requested, or until push returns false
or until no more data is in the socket buffer
* generally, handle case properly where no data is yet available from srt-socket read()
* in case no more data, retains the currently requested value remainder
from last _read call
-> this will allow for getting as much data as requested (if socket delivers
it) within the tick where it was requested or any next one in a best effort
manner. it will block the main-thread with "too long" execution frames/ticks
eventually as the data-demand from the _read calls becomes high
in amout/frequency.
but that is simply a consequence of the fact the SRT calls here are
blocking I/O. the previous implementation was also resulting in this
congestion of the main loop queue as read calls would block it, but at best
there was a 100ms lag between a request for read and its actual fulfillment.
one further improvement of this fix could be to split up the requested bytes
amount onto several ticks (executing one partial read directly, and further
ones in further timer scheduled calls, in order to avoid blocking ticks).
- use 50ms timer default for read continuation retry timer
- use 50ms interval for initial connection epoll'ing
- use consts for all timeout values
- implement base class _destroy method & refactor close() in consequence
- trigger Stream base class "readable" event on connection and first packet
* server: add an event for when a client was accepted to pass the fd
* fix lint errors in eslint config :)
* index.d.s: add /* eslint-disable @typescript-eslint/triple-slash-reference */
* improve eslint calling script
* add async-worker version of the SRT JS API with await/Promise support
+ potentially out-of-order RPC-back/result-dequeuing is possible
with a type of call-ID generator and callback-map that we prototyped
(but not used atm since the worker is only doing sync/blocking internally
with the current SRT lib binding).
* add various examples for async API ("classic" callbacks / Promise / await)
* add .eslintignore (should go with commit where we just call "eslint .")
* index.js: add missing semi
* async.js: fix method name litteral in epollUWait
* async.js: allow for accept method to use a timeout opt (defaults to false),
and a custom timeout value option (default to default timeout),
which can potentially be set differently than the general default timeout.
+ make the timeout value a static class property so that it can be
user-defined module-load wide. defaults to constant in module top scope.
* async.js: fix for a rejected promise, make sure we don't resolve anymore
+ add a custom timeout value argument to _createAsyncWorkPromise
* async.js: rm an experiment
* fix a lint error in example
* add types for async api and fix some details on binding API types
* export async API to index
* async.js: add some missing docs for private methods
* include async types in index
* add typescript definition files for this JS API
* server.js: replace console.log by debug() call
* server.js: set "iface" and "port" properties on SRTServer listen call
+ and init them with null in constructor
* stream.js: SRTReadStream: init fd property with null in constructor
* stream.js: SRTReadStream: add close method (to free the fd aquired with
connect()), likewise the writable stream methods
* example files: add "use strict"; directive on all
* examples/srt.js: correctly state variable fhandle (this would crash in strict mode
otherwise)
* NAPI: NodeSRT::GetSockOpt: fix error handling to really reach ThrowAsJavaScriptException
* add example: srt.ts (TypeScript usage)
* add .editoconfig to project root (helps keeping files free of whitespaces
and maintain indentation etc)
* package.json: improve metadata quality (via npm init call)
* package.json: add dev-deps for tsc/ts-node and node type-defs
* package.json: add check-tsc script to compile typescript example
* gitignore: add tsc-lib (typescript compiler test output)
* add tsconfig.json (typescript compiler config)
* some end-of-file newline and whitespace fixes
* stream.js: add const decls for all the magic numbers in SRTReadStream
* enable eslint static analysis to find possible issues upfront
+ and maintain codestyle
* update package-lock
* stream.js: fix whitespace and eof
* add lint script for src, examples and types modules
* types: lint error fix
This commit adds Windows build support by utilizing vcpkg to build
dependencies, and CMake for the build system.
These changes rely on vcpkg to be built and located in the VCPKG_ROOT
environment variable, along with having Visual Studio 2019 installed.
