Parcourir la source

Add host:destroy() to documentation

Kyle McLamb il y a 10 ans
Parent
commit
dc0a7a5f14
1 fichiers modifiés avec 4 ajouts et 0 suppressions
  1. 4 0
      docs/index.md

+ 4 - 0
docs/index.md

@@ -137,6 +137,10 @@ the channel count on the server. Defaults to `1`.
 `data` is an integer value that can be associated with the connect event.
 `data` is an integer value that can be associated with the connect event.
 Defaults to `0`.
 Defaults to `0`.
 
 
+### `host:destroy()`
+
+Destroys host, freeing up the port it's bound to. Automatically called when `host` is garbage collected.
+
 ### `host:service([timeout])`
 ### `host:service([timeout])`
 
 
 Wait for events, send and receive any ready packets. `timeout` is the max
 Wait for events, send and receive any ready packets. `timeout` is the max