From 6b9a74fec8bcf858c3e3bbddad5f2c6e1b9d0348 Mon Sep 17 00:00:00 2001 From: birme Date: Sat, 20 Jun 2020 23:04:52 +0200 Subject: [PATCH] Simple API definition documented --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e07bc8f..4e3c355 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,18 @@ if (fd) { ## API -TO BE DOCUMENTED +``` +class SRT { + createSocket(): socket:Number + bind(socket:Number, address:String, port:Number): result:Number + listen(socket:Number, backlog:Number): result:Number + connect(socket:Number, host:String, port:Number): result:Number + accept(socket:Number): fileDescriptor:Number + close(socket:Number): result:Number + read(socket:Number, chunkSize:Number): chunk:Buffer + write(socket:Number, chunk:Buffer): result:Number +} +``` ## [Contributing](CONTRIBUTING.md)