You are reading 13.4.0. See this page in 13.4.1.
Titanium.Network.TCPSocket
Extends Titanium.Proxy
Deprecated since 1.7.0
Use Titanium.Network.Socket.TCP where possible.
The TCPSocket instance returned from Titanium.Network.createTCPSocket. This object represents a socket which either listens locally on the device for connections, or connects to a remote machine.
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 7
Inherited from Titanium.Proxy
The name of the API that this proxy corresponds to.
Inherited from Titanium.Proxy
Indicates if the proxy will bubble an event to its parent.
Default: true
hostName
Stringthe host name to connect to. Must be <Titanium.Network.INADDR_ANY> or an identifier for the local device in order to listen
isValid
Booleanwhether or not the socket is valid
mode
Numberthe socket's mode
port
Numberthe port to connect/listen on
stripTerminator
Booleanstrip terminating null character when sending string data; default is false
Methods 8
Inherited from Titanium.Proxy
Adds the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. 4 fields
|
applyProperties
since 3.0.0Inherited from Titanium.Proxy
Applies the properties to the proxy.
| Parameters | Type | Description |
|---|---|---|
| props | Dictionary | A dictionary of properties to apply. |
close the socket
connect the socket to a TCP server
Inherited from Titanium.Proxy
Fires a synthesized event to any registered listeners.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| event? | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. |
set up the socket to receive connections
Inherited from Titanium.Proxy
Removes the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to 4 fields
|
write data to the socket, if the mode is WRITE_MODE or READ_WRITE_MODE
| Parameters | 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 |
Events 3
new data was read off the socket
| Event properties | 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 |
an error occurred when reading
| Event properties | 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. |
an error occurred when writing
| Event properties | 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. |