/apidoc/Titanium/Network/TCPSocket.yml

http://github.com/appcelerator/titanium_desktop · YAML · 19 lines · 19 code · 0 blank · 0 comment · 0 complexity · 7223c6399bd208b7091339230093104e MD5 · raw file 

    

  1. ---
    2. 

  2. namespace: Titanium.Network.TCPSocket
    3. 

  3. type: object
    4. 

  4. description: An object representing a TCP client socket connection.
    5. 

  5. events:
    6. 

  6.   - name: connect
    7. 

  7.     description: The socket is now connected to the remote host.
    8. 

  8.   - name: close
    9. 

  9.     description: Connection has been closed.
    10. 

  10.   - name: data
    11. 

  11.     description: "Data has arrived to the socket and is provided within a buffer.
    12. 

  12.                  Example: socket.on('data', function (data) { })"
    13. 

  13.   - name: end
    14. 

  14.     description: Signals the remote host will be sending no more data.
    15. 

  15.   - name: timeout
    16. 

  16.     description: An operation on the socket has timed out.
    17. 

  17.   - name: drain
    18. 

  18.     description: All pending data has been written to the socket.
    19. 

  19. since: 0.2.0
    20.