Simple API definition documented
This commit is contained in:
parent
8e063aada4
commit
6b9a74fec8
1 changed files with 12 additions and 1 deletions
13
README.md
13
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)
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue