add more files... && create sockaddr struct
This commit is contained in:
114
doc/manual.md
114
doc/manual.md
@@ -0,0 +1,114 @@
|
||||
# Manual
|
||||
|
||||
```lua
|
||||
local syscalls = require("syscalls")
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Events
|
||||
|
||||
```lua
|
||||
syscalls.Event.<EventName>
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Graphic
|
||||
|
||||
|
||||
|
||||
## Sockets
|
||||
|
||||
### OpenSocket
|
||||
|
||||
```lua
|
||||
local socket, err = syscalls.OpenSocket()
|
||||
|
||||
if err then
|
||||
print("Error", err)
|
||||
else
|
||||
print("Ok")
|
||||
end
|
||||
```
|
||||
|
||||
### CloseSocket(socket)
|
||||
|
||||
### PairSocket()
|
||||
|
||||
```lua
|
||||
local first, second = PairSocket()
|
||||
|
||||
if first then
|
||||
print("OK")
|
||||
else
|
||||
print("Error:", second)
|
||||
end
|
||||
```
|
||||
|
||||
### Bind(socket, address)
|
||||
|
||||
### Listen(socket, backlog)
|
||||
|
||||
### Connect()
|
||||
|
||||
### Accept
|
||||
|
||||
### Receive
|
||||
|
||||
## SetSocketOption
|
||||
|
||||
### GetSocketOption
|
||||
|
||||
### Socket types
|
||||
|
||||
```lua
|
||||
syscalls.SOCK.<Value>
|
||||
```
|
||||
|
||||
+ `STREAM`
|
||||
+ `RAW`
|
||||
+ `DGRAM`
|
||||
|
||||
### Address families
|
||||
|
||||
```lua
|
||||
syscalls.AF.<Value>
|
||||
```
|
||||
|
||||
+ `UNSPEC`
|
||||
+ `LOCAL`
|
||||
+ `INET`
|
||||
+ `INET4`
|
||||
+ `INET6`
|
||||
|
||||
### IP options
|
||||
|
||||
```lua
|
||||
syscalls.IP.<Value>
|
||||
```
|
||||
|
||||
+ `TTL`
|
||||
|
||||
### IP protocols
|
||||
|
||||
```lua
|
||||
syscalls.IPPROTO.<Value>
|
||||
```
|
||||
|
||||
+ `IP`
|
||||
+ `ICMP`
|
||||
+ `TCP`
|
||||
+ `UDP`
|
||||
+ `RAW`
|
||||
|
||||
### Socket options
|
||||
|
||||
```lua
|
||||
syscalls.SO.<Value>
|
||||
```
|
||||
|
||||
+ `BINDTODEVICE`
|
||||
+ `NONBLOCK`
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user