Titanium.IOStream

IOStream is the interface that all stream types implement.

See the Titanium.Stream module for related utility methods that support asynchronous I/O.

Extends: Titanium.Proxy · Since: 1.7, 1.7, 1.7, 9.2.0 · Platforms: android, iphone, ipad, macos

Properties

apiName

extended

3.2.0

3.2.0

3.2.0

9.2.0

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

extended

3.0.0

3.0.0

3.0.0

9.2.0

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.

lifecycleContainer

extended

3.6.0

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.

Methods

addEventListener

extended

0.9

0.9

0.9

9.2.0

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

Parameters:

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

extended

3.0.0

3.0.0

3.0.0

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	Summary	Optional
props	Dictionary	A dictionary of properties to apply.	No

close

0.9

0.9

0.9

9.2.0

Closes this stream.

Throws an exception on error.

fireEvent

extended

0.9

0.9

0.9

9.2.0

Fires a synthesized event to any registered listeners.

Parameters:

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

isReadable

0.9

0.9

0.9

9.2.0

Indicates whether this stream is readable.

Returns: Boolean — True if stream is readable, false otherwise.

isWritable

0.9

0.9

0.9

9.2.0

Indicates whether this stream is writable.

Returns: Boolean — True if stream is writable, false otherwise.

read

0.9

0.9

0.9

9.2.0

Reads data from this stream into a buffer.

Takes an optional resultsCallback function as the last argument. If specified,
the operation is done asynchronously. If no callback is passed in, the
operation is done synchronously.

If offset and length are specified, data is written into the buffer starting at
position offset. Data is read from this stream until one of the following occurs:

• the end of this stream is reached
• the end of the buffer is reached
• a total of length bytes have been read from the stream

If offset and length are omitted, data is written starting at the beginning
of the buffer.

When called synchronously: returns the number of bytes read, or -1 if the end of
stream was reached before any data was read.

Returns 0 when called asynchronously.

Throws an exception on error. For example, if the offset value is past
the last byte of buffer.

Parameters:

Name	Type	Summary	Optional
buffer	Titanium.Buffer	Buffer to read stream data into.	No
offset	Number	Offset into the buffer to start writing stream data. If specified, length must also be specified.	Yes
length	Number	Maximum number of bytes to read. If specified, offset must also be specified.	Yes
resultsCallback	Callback<ReadCallbackArgs>	Function to call with the results of the read operation.	Yes

Returns: Number — Number of bytes read.

removeEventListener

extended

0.9

0.9

0.9

9.2.0

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

0.9

0.9

0.9

9.2.0

Writes data from a buffer to this stream.

Takes an optional resultsCallback function as the last argument. If specified,
the operation is done asynchronously. If no callback is passed in, the
operation is done synchronously.

If offset and length are specified, data is read from the buffer starting at
offset. Bytes are read from the buffer and written to the stream until:

• the end of the buffer is reached
• length bytes have been written
• the stream returns an error

If offset and length are omitted, all of the data in the buffer is written to
this stream.

Returns the number of bytes actually written when called synchronously.

Returns 0 when called asynchronously.

Throws an exception if an error is encountered.

Parameters:

Name	Type	Summary	Optional
buffer	Titanium.Buffer	Buffer to write to this stream.	No
offset	Number	Offset in the buffer of the first byte to write to the stream. If specified, length must also be specified.	Yes
length	Number	Maximum number of bytes to write to the stream. If specified, offset must also be specified.	Yes
resultsCallback	Callback<WriteCallbackArgs>	Function to call with the results of the write operation.	Yes

Returns: Number — Number of bytes written.

Examples

Write Data to a Stream

This example demonstrates writing data to a stream.

var outBuffer = Ti.createBuffer({data: "write me"});
// stream object could be socket, file, buffer or blob
var outStream = Ti.Stream.createStream({mode: Ti.Stream.MODE_WRITE});

var bytesWritten = outStream.write(outBuffer);  // writes entire buffer to stream
Ti.API.info("Bytes written:" + bytesWritten);  // should be 8

bytesWritten = outStream.write(outBuffer, 2, 5);  // only writes "ite m" to stream
Ti.API.info("Bytes written:" + bytesWritten);  // should be 5

Read Data From a Stream

This shows a simple example of reading data from a stream, one buffer full at a time.

var size = 0;
// read data one buffer full at a time
while ((size = instream.read(buffer)) > -1) {
    // do something with the data here ...
    Ti.API.info("Read " + size + " bytes.");
}

Read Data With Offset and Length

This example shows how to read data from a stream into a buffer. We assume that the `inStream` variable holds a previously initialized stream that contains the string, "World Titanium".

var inBuffer = Ti.createBuffer({ value: "Hello [           ]" });

// Read the first 6 bytes from the stream to the buffer, starting at position 10.
var bytesRead = inStream.read(inBuffer, 10, 6);

Ti.API.info("Bytes read: " + bytesRead);
Ti.API.info(inBuffer.toString());

// Read the next 8  bytes from the stream to the buffer, starting at position 8.
bytesRead = inStream.read(inBuffer, 8, 8);

Ti.API.info("Bytes read: " + bytesRead);
Ti.API.info(inBuffer.toString());

[INFO] Bytes read: 6
[INFO] Hello [   World   ]
[INFO] Bytes read: 8
[INFO] Hello [ Titanium  ]