You are reading 12.6.1. See this page in 13.4.1.
Titanium.IOStream
Extends Titanium.Proxy
Extended by Titanium.BlobStreamTitanium.BufferStreamTitanium.Filesystem.FileStreamTitanium.Network.Socket.TCP
IOStream is the interface that all stream types implement.
See the Titanium.Stream module for related utility methods that support asynchronous I/O.
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());
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 ]
Properties 3
Inherited from Titanium.Proxy
The name of the API that this proxy corresponds to.
Inherited from Titanium.Proxy
Indicates if the proxy will bubble an event to its parent.
Default: true
Inherited from Titanium.Proxy
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
Methods 9
Inherited from Titanium.Proxy
Adds the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. 4 fields
|
applyProperties
since 3.0.0Inherited from Titanium.Proxy
Applies the properties to the proxy.
| Parameters | Type | Description |
|---|---|---|
| props | Dictionary | A dictionary of properties to apply. |
Closes this stream.
Throws an exception on error.
Inherited from Titanium.Proxy
Fires a synthesized event to any registered listeners.
| Parameters | 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. |
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.
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
lengthbytes 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 | Type | Description |
|---|---|---|
| buffer | Titanium.Buffer | Buffer to read stream data into. |
| offset? | Number | Offset into the buffer to start writing stream data.
If specified, |
| length? | Number | Maximum number of bytes to read.
If specified, |
| resultsCallback? | Callback<ReadCallbackArgs> | Function to call with the results of the read operation. |
Number of bytes read.
Inherited from Titanium.Proxy
Removes the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to 4 fields
|
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
lengthbytes 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 | Type | Description |
|---|---|---|
| buffer | Titanium.Buffer | Buffer to write to this stream. |
| offset? | Number | Offset in the buffer of the first byte to write to the stream.
If specified, |
| length? | Number | Maximum number of bytes to write to the stream.
If specified, |
| resultsCallback? | Callback<WriteCallbackArgs> | Function to call with the results of the write operation. |
Number of bytes written.