Titanium.Network.TCPSocket
> 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.
Extends: Titanium.Proxy · Since: 1.2.0 · Platforms: iphone, ipad
Properties #
apiName#
Type: String
The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Button
returns Ti.UI.Button.
bubbleParent#
Type: Boolean
Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often
established by the add() method. For example, for a button added to a window, a
click event on the button would bubble up to the window. Other common parents are
table sections to their rows, table views to their sections, and scrollable views
to their views. Set this property to false to disable the bubbling to the proxy's parent.
hostName#
Type: String
the host name to connect to. Must be Titanium.Network.INADDR_ANY or an identifier for the local device in order to listen
lifecycleContainer#
Type: Titanium.UI.Window, Titanium.UI.TabGroup
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks
will also be called on the proxy. Proxies that require the activity lifecycle will need this property set
to the appropriate containing Window or TabGroup.
stripTerminator#
Type: Boolean
strip terminating null character when sending string data; default is false
Methods #
addEventListener #
Adds the specified callback as an event listener for the named event.
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. | No |
applyProperties #
Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that
myproxy[key] = value.
| Name | Type | Summary | Optional |
|---|---|---|---|
props | Dictionary | A dictionary of properties to apply. | No |
close #
close the socket
connect #
connect the socket to a TCP server
fireEvent #
Fires a synthesized event to any registered listeners.
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. | Yes |
listen #
set up the socket to receive connections
removeEventListener #
Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function
in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to addEventListener. | No |
write #
write data to the socket, if the mode is WRITE_MODE or READ_WRITE_MODE
| Name | Type | Summary | Optional |
|---|---|---|---|
data | Object, String | either a string or blob object representing the data to be transferred | No |
sendTo | Number | the socket reference to send the data to. Default is to send to all connected sockets | No |
Events #
read #
new data was read off the socket
| Name | Type | Summary |
|---|---|---|
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 |
readError #
an error occurred when reading
| Name | Type | Summary |
|---|---|---|
success | Boolean | Indicates a successful operation. Returns false. |
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. |
writeError #
an error occurred when writing
| Name | Type | Summary |
|---|---|---|
success | Boolean | Indicates a successful operation. Returns false. |
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. |