瀏覽代碼

added documentation for host:get_socket_address()

fysx 12 年之前
父節點
當前提交
12edeed034
共有 1 個文件被更改,包括 6 次插入0 次删除
  1. 6 0
      docs/index.md

+ 6 - 0
docs/index.md

@@ -202,6 +202,12 @@ stores all peers in an array of the corresponding host and re-uses unused
 peers for new connections. You can query the state of a peer using 
 peers for new connections. You can query the state of a peer using 
 [peer:state](#peerstate).
 [peer:state](#peerstate).
 
 
+### `host:get_socket_address()`
+
+Returns a string that describes the socket address of the given host. The
+string is formatted as "a.b.c.d:port", where "a.b.c.d" is the ip address of
+the used socket.
+
 ### `peer:connect_id()`
 ### `peer:connect_id()`
 
 
 Returns the field ENetPeer::connectID that is assigned for each
 Returns the field ENetPeer::connectID that is assigned for each