Accessibility::StreamableContent::Stream Interface Reference

An interface by which the requested data from a StreamableContent object may be read by the client. More...

import "Accessibility_StreamableContent.idl";

List of all members.

Public Member Functions
long	seek (in long offset, in SeekType whence) raises (NoPermission, IOError, NotSupported)
	Seek to a specified position in the Stream.
long	read (in long count, out iobuf buffer) raises (NoPermission, IOError)
	Request/read a specified amount of data from a Stream.
void	close ()
	close the stream and release associated resources.

---

Detailed Description

An interface by which the requested data from a StreamableContent object may be read by the client.

Note:

this interface supercedes the use of BonoboStream by previous versions of StreamableContent.

Since:

AT-SPI 1.7.0

Definition at line 91 of file Accessibility_StreamableContent.idl.

---

Member Function Documentation

long Accessibility::StreamableContent::Stream::seek (  in long  offset, in SeekType  whence )  raises (NoPermission, IOError, NotSupported)

Seek to a specified position in the Stream. Parameters: offset  an offset specifying the requested position in the stream, relative to the SeekType specified in whence. whence  a SeekType specifying the reference point from which the seek offset is calculated. Some forms of seek are not supported by certain implementations of Stream, in which case a NotSupported exception will be raised. Returns: the actual resulting offset, if no exception was raised.

long Accessibility::StreamableContent::Stream::read (  in long  count, out iobuf  buffer )  raises (NoPermission, IOError)

Request/read a specified amount of data from a Stream. Returns: the number of bytes actually read into the client buffer.

void Accessibility::StreamableContent::Stream::close (   )

close the stream and release associated resources. A client should not perform further operations on a StreamableContent::Stream object after closing it.

---

The documentation for this interface was generated from the following file:

• Accessibility_StreamableContent.idl

---