# 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.

Availability

1.2.0

Extends

Titanium.Proxy

DEPRECATED 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

# apiName READONLY

Availability

3.2.0

apiName :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, Titanium.UI.Button returns Ti.UI.Button.

# bubbleParent

Availability

3.0.0

bubbleParent :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.

Default: true

# hostName

Availability

1.2.0

hostName :String

the host name to connect to. Must be <Titanium.Network.INADDR_ANY> or an identifier for the local device in order to listen

# isValid

Availability

1.2.0

isValid :Boolean

whether or not the socket is valid

# mode

Availability

1.2.0

mode :Number

the socket's mode

# port

Availability

1.2.0

port :Number

the port to connect/listen on

# stripTerminator

Availability

1.2.0

stripTerminator :Boolean

strip terminating null character when sending string data; default is false

# Methods

# addEventListener

Availability

1.2.0

addEventListener(name, callback) → void

Adds the specified callback as an event listener for the named event.

Parameters

Name	Type	Description
`name`	String	Name of the event.
`callback`	Callback<Titanium.Event>	Callback function to invoke when the event is fired.

Returns

Type: void

# applyProperties

Availability

3.0.0

applyProperties(props) → void

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.

Parameters

Name	Type	Description
`props`	Dictionary	A dictionary of properties to apply.

Returns

Type: void

# close

Availability

1.2.0

close() → void

close the socket

Returns

Type: void

# connect

Availability

1.2.0

connect() → void

connect the scocket to a TCP server

Returns

Type: void

# fireEvent

Availability

1.2.0

fireEvent(name[, event]) → void

Fires a synthesized event to any registered listeners.

Parameters

Name	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.

Returns

Type: void

# listen

Availability

1.2.0

listen() → void

set up the socket to receive connections

Returns

Type: void

# removeEventListener

Availability

1.2.0

removeEventListener(name, callback) → void

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);

Parameters

Name	Type	Description
`name`	String	Name of the event.
`callback`	Callback<Titanium.Event>	Callback function to remove. Must be the same function passed to `addEventListener`.

Returns

Type: void

# write

Availability

1.2.0

write(data, sendTo) → void

write 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

Availability

1.2.0

new 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

Availability

1.2.0

an error occured when reading

Properties

Name	Type	Description
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.
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

Availability

1.2.0

an error occured when writing

Properties

Name	Type	Description
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.
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.