# Titanium.Network.TCPSocket

> The TCPSocket instance returned from [Titanium.Network.createTCPSocket](https://titaniumsdk.com/docs/sdk/Titanium.Network.md#createTCPSocket). This object represents a socket which either listens locally on the device for connections, or connects to a remote machine.

- Source: https://titaniumsdk.com/docs/sdk/12.6.3/Titanium.Network.TCPSocket
- Titanium SDK version: 12.6.3
- Kind: proxy
- Platforms: iPhone, iPad
- Since: Titanium SDK 1.2.0
- Extends: Titanium.Proxy
- Inheritance: Titanium.Proxy
- DEPRECATED since 1.7.0, removed in 9.0.0. Use [Titanium.Network.Socket.TCP](Titanium.Network.Socket.TCP) where possible.

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

- Type: String
- Platforms: iPhone, iPad

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

### isValid

- Type: Boolean
- Platforms: iPhone, iPad

whether or not the socket is valid

### mode

- Type: Number
- Platforms: iPhone, iPad

the socket's mode

### port

- Type: Number
- Platforms: iPhone, iPad

the port to connect/listen on

### stripTerminator

- Type: Boolean
- Platforms: iPhone, iPad

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

## Methods

### close

- Platforms: iPhone, iPad

close the socket

### connect

- Platforms: iPhone, iPad

connect the scocket to a TCP server

### listen

- Platforms: iPhone, iPad

set up the socket to receive connections

### write

- Platforms: iPhone, iPad

write data to the socket, if the mode is WRITE_MODE or READ_WRITE_MODE

Parameters:

- `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

### read

- Platforms: iPhone, iPad

new data was read off the socket

Event properties:

- `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

- Platforms: iPhone, iPad

an error occured when reading

Event properties:

- `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

- Platforms: iPhone, iPad

an error occured when writing

Event properties:

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

## Inherited members

6 members are inherited. Each is documented on the type that declares it.

- [Titanium.Proxy](https://titaniumsdk.com/docs/sdk/12.6.3/Titanium.Proxy.md): `addEventListener`, `apiName`, `applyProperties`, `bubbleParent`, `fireEvent`, `removeEventListener`

---

- This corpus documents Titanium SDK 13.4.1. Anything here that does not name a version describes 13.4.1.
- Titanium is maintained by TiDev. The Appcelerator toolchain is retired: there is no `appc` CLI, no Appcelerator Studio and no hosted build service. The supported CLI is `titanium` on npm, invoked as `ti`.

