Titanium Mobile # Titanium.Network.TCPSocket
The TCPSocket instance returned from createTCPSocket. This object represents a socket which either listens locally on the device for connections, or connects to a remote machine.
1.2.0DEPRECATED SINCE 1.7.0
Use Titanium.Network.Socket.TCP where possible.
# Overview
Sockets are nontrivial; it is recommended that anyone using them be familiar with the basics of BSD sockets. All sockets use TCP connections, and are asynchronous for read operations, so your program should be ready to receive 'read' events at any point. Socket references cannot be transferred to socket objects, and vice-versa - socket references are an internal mechanism which is used only to determine which sockets to send data to and read data from. For listening sockets, it is highly recommended that you use the Titanium.Network.INADDR_ANY constant as the host name. If a window containing a socket is closed, the socket MUST be closed also unless you intend to continue to receive data, otherwise the socket will consume resources (and potentially cause conflicts with opening the window again, if a listener) until the program is restarted. Be aware of the differences between the listen() and connect() functions; attempting to use one when you mean the other may result in errors, unpredictable behavior, or both.
# Properties
# hostName
1.2.0the host name to connect to. Must be INADDR_ANY or an identifier for the local device in order to listen
# stripTerminator
1.2.0strip terminating null character when sending string data; default is false
# Methods
# write
1.2.0write data to the socket, if the mode is WRITE_MODE or READ_WRITE_MODE
Parameters
| Name | Type | Description |
|---|---|---|
data | Object | String | either a string or blob object representing the data to be transferred |
sendTo | Number | the socket reference to send the data to. Default is to send to all connected sockets |
Returns
- Type
- void
# Events
# read
1.2.0new data was read off the socket
Properties
| Name | Type | Description |
|---|---|---|
| from | Number | the reference for the socket that data was retrieved from |
| data | Titanium.Blob | a blob representing the data read, can be interpreted via toString |
| source | Object | Source object that fired the event. |
| type | String | Name of the event fired. |
| bubbles | Boolean | True if the event will try to bubble up if possible. |
| cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# readError
1.2.0an error occured when reading
Properties
| Name | Type | Description |
|---|---|---|
| success | Boolean | Indicates a successful operation. Returns |
| error | String | Error message, if any returned. May be undefined. |
| code | Number | Error code. If the error was generated by the operating system, that system's error value is used. Otherwise, this value will be -1. |
| source | Object | Source object that fired the event. |
| type | String | Name of the event fired. |
| bubbles | Boolean | True if the event will try to bubble up if possible. |
| cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# writeError
1.2.0an error occured when writing
Properties
| Name | Type | Description |
|---|---|---|
| success | Boolean | Indicates a successful operation. Returns |
| error | String | Error message, if any returned. May be undefined. |
| code | Number | Error code. If the error was generated by the operating system, that system's error value is used. Otherwise, this value will be -1. |
| source | Object | Source object that fired the event. |
| type | String | Name of the event fired. |
| bubbles | Boolean | True if the event will try to bubble up if possible. |
| cancelBubble | Boolean | Set to true to stop the event from bubbling. |