Titanium.Network.TCPSocket
> Titanium.Network.TCPSocket

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.

deprecated since 1.7.0

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

  • 1.2.0
  • 1.2.0
Defined By

Properties

apiName : Stringreadonly

The name of the API that this proxy corresponds to.

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.

  • 3.2.0
  • 3.2.0
  • 3.2.0
Indicates if the proxy will bubble an event to its parent. ...

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

  • 3.0.0
  • 3.0.0
  • 3.0.0
Titanium.Network.TCPSocket
: String
the host name to connect to. ...

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

Titanium.Network.TCPSocket
isValid : Boolean

whether or not the socket is valid

whether or not the socket is valid

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

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.

  • 3.6.0
Titanium.Network.TCPSocket
mode : Number

the socket's mode

the socket's mode

Titanium.Network.TCPSocket
port : Number

the port to connect/listen on

the port to connect/listen on

Titanium.Network.TCPSocket
stripTerminator : Boolean

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

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

Defined By

Methods

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

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

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Applies the properties to the proxy. ...

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.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
Titanium.Network.TCPSocket
( )
close the socket ...

close the socket

Returns

  • void
Titanium.Network.TCPSocket
( )
connect the scocket to a TCP server ...

connect the scocket to a TCP server

Returns

  • void
Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • 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

  • void
Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2.0
  • 3.2.0
  • 3.2.0

Returns

  • String
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

  • Boolean
Titanium.Network.TCPSocket
( ) : String
Gets the value of the hostName property. ...

Gets the value of the hostName property.

Returns

  • String
Titanium.Network.TCPSocket
( ) : Boolean
Gets the value of the isValid property. ...

Gets the value of the isValid property.

Returns

  • Boolean
Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Titanium.Network.TCPSocket
( ) : Number
Gets the value of the mode property. ...

Gets the value of the mode property.

Returns

  • Number
Titanium.Network.TCPSocket
( ) : Number
Gets the value of the port property. ...

Gets the value of the port property.

Returns

  • Number
Titanium.Network.TCPSocket
( ) : Boolean
Gets the value of the stripTerminator property. ...

Gets the value of the stripTerminator property.

Returns

  • Boolean
Titanium.Network.TCPSocket
( )
set up the socket to receive connections ...

set up the socket to receive connections

Returns

  • void
Removes the specified callback as an event listener for the named event. ...

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 : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to remove. Must be the same function passed to addEventListener.

Returns

  • void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
Titanium.Network.TCPSocket
( hostName )
Sets the value of the hostName property. ...

Sets the value of the hostName property.

Parameters

  • hostName : String

    New value for the property.

Returns

  • void
Titanium.Network.TCPSocket
( isValid )
Sets the value of the isValid property. ...

Sets the value of the isValid property.

Parameters

  • isValid : Boolean

    New value for the property.

Returns

  • void
Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void
Titanium.Network.TCPSocket
( mode )
Sets the value of the mode property. ...

Sets the value of the mode property.

Parameters

  • mode : Number

    New value for the property.

Returns

  • void
Titanium.Network.TCPSocket
( port )
Sets the value of the port property. ...

Sets the value of the port property.

Parameters

  • port : Number

    New value for the property.

Returns

  • void
Titanium.Network.TCPSocket
( stripTerminator )
Sets the value of the stripTerminator property. ...

Sets the value of the stripTerminator property.

Parameters

  • stripTerminator : Boolean

    New value for the property.

Returns

  • void
Titanium.Network.TCPSocket
( data, sendTo )
write data to the socket, if the mode is WRITE_MODE or READ_WRITE_MODE ...

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

Returns

  • void
Defined By

Events

Titanium.Network.TCPSocket
new data was read off the socket ...

new data was read off the socket

Properties

  • from : String

    the reference for the socket that data was retrieved from

  • data : String

    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.

    •  
    •  
    •  
Titanium.Network.TCPSocket
an error occured when reading ...

an error occured when reading

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.

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

    •  
    •  
    •  
Titanium.Network.TCPSocket
an error occured when writing ...

an error occured when writing

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.

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

    •  
    •  
    •