IOStream is the interface that all stream types implement.
See the Titanium.Stream module for related utility methods that support asynchronous I/O.
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
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.");
}
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());
The second read overwrites the data from the first read, so the output looks
like this:
[INFO] Bytes read: 6
[INFO] Hello [ World ]
[INFO] Bytes read: 8
[INFO] Hello [ Titanium ]
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.
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
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.
Adds the specified callback as an event listener for the named event.
Name of the event.
Callback function to invoke when the event is fired.
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.
A dictionary of properties to apply.
Fires a synthesized event to any registered listeners.
Name of the event.
A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.
Indicates whether this stream is readable.
True if stream is readable, false otherwise.
Indicates whether this stream is writable.
True if stream is writable, false otherwise.
Reads data from this stream into a buffer.
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:
length bytes have been read from the streamIf offset and length are omitted, data is written starting at the beginning
of the buffer.
Returns the number of bytes read, or -1 if the end of stream was reached before any data was read.
Throws an exception on error. For example, if the offset value is past
the last byte of buffer.
This method is synchronous. To perform an asynchronous read on an IOStream, use
Titanium.Stream.read.
Buffer to read stream data into.
Offset into the buffer to start writing stream data.
If specified, length must also be specified.
Maximum number of bytes to read.
If specified, offset must also be specified.
Number of bytes read.
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 of the event.
Callback function to remove. Must be the same function passed to addEventListener.
Sets the value of the bubbleParent property.
New value for the property.
Sets the value of the lifecycleContainer property.
New value for the property.
Writes data from a buffer to this stream.
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:
length bytes have been writtenIf offset and length are omitted, all of the data in the buffer is written to
this stream.
Returns the number of bytes actually written.
Throws an exception if an error is encountered.
Buffer to write to this stream.
Offset in the buffer of the first byte to write to the stream.
If specified, length must also be specified.
Maximum number of bytes to write to the stream.
If specified, offset must also be specified.
Number of bytes written.