Package ch.bailu.gtk.gio

Class InputStream

java.lang.Object

ch.bailu.gtk.type.Type

ch.bailu.gtk.type.Pointer

ch.bailu.gtk.gobject.Object

ch.bailu.gtk.gio.InputStream

All Implemented Interfaces:

PointerInterface

Direct Known Subclasses:

FileInputStream, FilterInputStream, InputStreamBridge, MemoryInputStream, UnixInputStream

public class InputStream
extends Object

#GInputStream has functions to read from a stream (g_input_stream_read()),
to close a stream (g_input_stream_close()) and to skip some content
(g_input_stream_skip()).

To copy the content of an input stream to an output stream without
manually handling the reads and writes, use g_output_stream_splice().

See the documentation for #GIOStream for details of thread safety of
streaming APIs.

All of these functions have async variants too.

https://docs.gtk.org/gio/class.InputStream.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InputStream.OnAsyncReadyCallback

Nested classes/interfaces inherited from class ch.bailu.gtk.gobject.Object

Object.OnBindingTransformFunc, Object.OnDestroyNotify, Object.OnDuplicateFunc, Object.OnNotify, Object.OnToggleNotify, Object.OnWeakNotify

Field Summary

Fields inherited from class ch.bailu.gtk.gobject.Object

SIGNAL_ON_NOTIFY

Fields inherited from class ch.bailu.gtk.type.Pointer

NULL

Constructor Summary

Constructors

Constructor	Description
InputStream(PointerContainer pointer)

Method Summary

Modifier and Type	Method	Description
void	clearPending()	Clears the pending flag on @stream.
boolean	close(Cancellable cancellable)	Closes the stream, releasing resources related to it.
void	closeAsync(int io_priority, Cancellable cancellable, InputStream.OnAsyncReadyCallback callback, Pointer user_data)	Requests an asynchronous closes of the stream, releasing resources related to it.
boolean	closeFinish(AsyncResult result)	Finishes closing a stream asynchronously, started from g_input_stream_close_async().
static ClassHandler	getClassHandler()
static int	getInstanceSize()
static long	getParentTypeID()
static TypeSystem.TypeSize	getParentTypeSize()
static long	getTypeID()
static TypeSystem.TypeSize	getTypeSize()
boolean	hasPending()	Checks if an input stream has pending actions.
boolean	isClosed()	Checks if an input stream is closed.
long	read(Pointer buffer, long count, Cancellable cancellable)	Tries to read @count bytes from the stream into the buffer starting at @buffer.
boolean	readAll(Pointer buffer, long count, Int64 bytes_read, Cancellable cancellable)	Tries to read @count bytes from the stream into the buffer starting at @buffer.
void	readAllAsync(Pointer buffer, long count, int io_priority, Cancellable cancellable, InputStream.OnAsyncReadyCallback callback, Pointer user_data)	Request an asynchronous read of @count bytes from the stream into the buffer starting at @buffer.
boolean	readAllFinish(AsyncResult result, Int64 bytes_read)	Finishes an asynchronous stream read operation started with g_input_stream_read_all_async().
void	readAsync(Pointer buffer, long count, int io_priority, Cancellable cancellable, InputStream.OnAsyncReadyCallback callback, Pointer user_data)	Request an asynchronous read of @count bytes from the stream into the buffer starting at @buffer.
Bytes	readBytes(long count, Cancellable cancellable)	Like g_input_stream_read(), this tries to read @count bytes from the stream in a blocking fashion.
void	readBytesAsync(long count, int io_priority, Cancellable cancellable, InputStream.OnAsyncReadyCallback callback, Pointer user_data)	Request an asynchronous read of @count bytes from the stream into a new #GBytes.
Bytes	readBytesFinish(AsyncResult result)	Finishes an asynchronous stream read-into-#GBytes operation.
long	readFinish(AsyncResult result)	Finishes an asynchronous stream read operation.
boolean	setPending()	Sets @stream to have actions pending.
long	skip(long count, Cancellable cancellable)	Tries to skip @count bytes from the stream.
void	skipAsync(long count, int io_priority, Cancellable cancellable, InputStream.OnAsyncReadyCallback callback, Pointer user_data)	Request an asynchronous skip of @count bytes from the stream.
long	skipFinish(AsyncResult result)	Finishes a stream skip operation.

Methods inherited from class ch.bailu.gtk.gobject.Object

addToggleRef, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, disconnect, disconnect, dupData, dupData, dupQdata, forceFloating, freezeNotify, get, get, getData, getData, getProperty, getProperty, getQdata, interfaceFindProperty, interfaceInstallProperty, isFloating, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, replaceData, replaceData, replaceQdata, runDispose, set, set, setData, setData, setDataFull, setDataFull, setProperty, setProperty, setQdata, setQdataFull, stealData, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref

Methods inherited from class ch.bailu.gtk.type.Pointer

asCPointer, cast, connectSignal, disconnectSignals, disconnectSignals, equals, hashCode, throwIfNull, throwNullPointerException, toString, unregisterCallbacks, unregisterCallbacks

Methods inherited from class ch.bailu.gtk.type.Type

asCPointer, asCPointer, asCPointerNotNull, asJnaPointer, asJnaPointer, asPointer, asPointer, cast, cast, throwIfNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.bailu.gtk.type.PointerInterface

asCPointerNotNull, asJnaPointer, asPointer, isNotNull, isNull

Constructor Details

InputStream

public InputStream(PointerContainer pointer)

Method Details

getClassHandler

public static ClassHandler getClassHandler()

clearPending

public void clearPending()

Clears the pending flag on @stream.

close

public boolean close(@Nullable
 Cancellable cancellable)
              throws AllocationError

Closes the stream, releasing resources related to it.

Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED.
Closing a stream multiple times will not return an error.

Streams will be automatically closed when the last reference
is dropped, but you might want to call this function to make sure
resources are released as early as possible.

Some streams might keep the backing store of the stream (e.g. a file descriptor)
open after the stream is closed. See the documentation for the individual
stream for details.

On failure the first error that happened will be reported, but the close
operation will finish as much as possible. A stream that failed to
close will still return %G_IO_ERROR_CLOSED for all operations. Still, it
is important to check and report the error to the user.

If @cancellable is not %NULL, then the operation can be cancelled by
triggering the cancellable object from another thread. If the operation
was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
Cancelling a close will still leave the stream closed, but some streams
can use a faster close that doesn't block to e.g. check errors.

Parameters:

cancellable - optional #GCancellable object, %NULL to ignore.

Returns:

%TRUE on success, %FALSE on failure

Throws:

AllocationError

closeAsync

public void closeAsync(int io_priority,
 @Nullable
 Cancellable cancellable,
 InputStream.OnAsyncReadyCallback callback,
 @Nullable
 Pointer user_data)

Requests an asynchronous closes of the stream, releasing resources related to it.
When the operation is finished @callback will be called.
You can then call g_input_stream_close_finish() to get the result of the
operation.

For behaviour details see g_input_stream_close().

The asynchronous methods have a default fallback that uses threads to implement
asynchronicity, so they are optional for inheriting classes. However, if you
override one you must override all.

Parameters:

io_priority - the [I/O priority][io-priority] of the request

cancellable - optional cancellable object

callback - callback to call when the request is satisfied

user_data - the data to pass to callback function

closeFinish

public boolean closeFinish(@Nonnull
 AsyncResult result)
                    throws AllocationError

Finishes closing a stream asynchronously, started from g_input_stream_close_async().

Parameters:

result - a #GAsyncResult.

Returns:

%TRUE if the stream was closed successfully.

Throws:

AllocationError

hasPending

public boolean hasPending()

Checks if an input stream has pending actions.

Returns:

%TRUE if @stream has pending actions.

isClosed

public boolean isClosed()

Checks if an input stream is closed.

Returns:

%TRUE if the stream is closed.

read

public long read(@Nonnull
 Pointer buffer,
 long count,
 @Nullable
 Cancellable cancellable)
          throws AllocationError

Tries to read @count bytes from the stream into the buffer starting at
@buffer. Will block during this read.

If count is zero returns zero and does nothing. A value of @count
larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.

On success, the number of bytes read into the buffer is returned.
It is not an error if this is not the same as the requested size, as it
can happen e.g. near the end of a file. Zero is returned on end of file
(or if @count is zero), but never otherwise.

The returned @buffer is not a nul-terminated string, it can contain nul bytes
at any position, and this function doesn't nul-terminate the @buffer.

If @cancellable is not %NULL, then the operation can be cancelled by
triggering the cancellable object from another thread. If the operation
was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.

On error -1 is returned and @error is set accordingly.

Parameters:

buffer - a buffer to read data into (which should be at least count bytes long).

count - the number of bytes that will be read from the stream

cancellable - optional #GCancellable object, %NULL to ignore.

Returns:

Number of bytes read, or -1 on error, or 0 on end of file.

Throws:

AllocationError

readAll

public boolean readAll(@Nonnull
 Pointer buffer,
 long count,
 @Nonnull
 Int64 bytes_read,
 @Nullable
 Cancellable cancellable)
                throws AllocationError

Tries to read @count bytes from the stream into the buffer starting at
@buffer. Will block during this read.

This function is similar to g_input_stream_read(), except it tries to
read as many bytes as requested, only stopping on an error or end of stream.

On a successful read of @count bytes, or if we reached the end of the
stream, %TRUE is returned, and @bytes_read is set to the number of bytes
read into @buffer.

If there is an error during the operation %FALSE is returned and @error
is set to indicate the error status.

As a special exception to the normal conventions for functions that
use #GError, if this function returns %FALSE (and sets @error) then
@bytes_read will be set to the number of bytes that were successfully
read before the error was encountered. This functionality is only
available from C. If you need it from another language then you must
write your own loop around g_input_stream_read().

Parameters:

buffer - a buffer to read data into (which should be at least count bytes long).

count - the number of bytes that will be read from the stream

bytes_read - location to store the number of bytes that was read from the stream

cancellable - optional #GCancellable object, %NULL to ignore.

Returns:

%TRUE on success, %FALSE if there was an error

Throws:

AllocationError

readAllAsync

public void readAllAsync(@Nonnull
 Pointer buffer,
 long count,
 int io_priority,
 @Nullable
 Cancellable cancellable,
 InputStream.OnAsyncReadyCallback callback,
 @Nullable
 Pointer user_data)

Request an asynchronous read of @count bytes from the stream into the
buffer starting at @buffer.

This is the asynchronous equivalent of g_input_stream_read_all().

Call g_input_stream_read_all_finish() to collect the result.

Any outstanding I/O request with higher priority (lower numerical
value) will be executed before an outstanding request with lower
priority. Default priority is %G_PRIORITY_DEFAULT.

Parameters:

buffer - a buffer to read data into (which should be at least count bytes long)

count - the number of bytes that will be read from the stream

io_priority - the [I/O priority][io-priority] of the request

cancellable - optional #GCancellable object, %NULL to ignore

callback - callback to call when the request is satisfied

user_data - the data to pass to callback function

readAllFinish

public boolean readAllFinish(@Nonnull
 AsyncResult result,
 @Nonnull
 Int64 bytes_read)
                      throws AllocationError

Finishes an asynchronous stream read operation started with
g_input_stream_read_all_async().

As a special exception to the normal conventions for functions that
use #GError, if this function returns %FALSE (and sets @error) then
@bytes_read will be set to the number of bytes that were successfully
read before the error was encountered. This functionality is only
available from C. If you need it from another language then you must
write your own loop around g_input_stream_read_async().

Parameters:

result - a #GAsyncResult

bytes_read - location to store the number of bytes that was read from the stream

Returns:

%TRUE on success, %FALSE if there was an error

Throws:

AllocationError

readAsync

public void readAsync(@Nonnull
 Pointer buffer,
 long count,
 int io_priority,
 @Nullable
 Cancellable cancellable,
 InputStream.OnAsyncReadyCallback callback,
 @Nullable
 Pointer user_data)

Request an asynchronous read of @count bytes from the stream into the buffer
starting at @buffer. When the operation is finished @callback will be called.
You can then call g_input_stream_read_finish() to get the result of the
operation.

During an async request no other sync and async calls are allowed on @stream, and will
result in %G_IO_ERROR_PENDING errors.

A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.

On success, the number of bytes read into the buffer will be passed to the
callback. It is not an error if this is not the same as the requested size, as it
can happen e.g. near the end of a file, but generally we try to read
as many bytes as requested. Zero is returned on end of file
(or if @count is zero), but never otherwise.

Any outstanding i/o request with higher priority (lower numerical value) will
be executed before an outstanding request with lower priority. Default
priority is %G_PRIORITY_DEFAULT.

The asynchronous methods have a default fallback that uses threads to implement
asynchronicity, so they are optional for inheriting classes. However, if you
override one you must override all.

Parameters:

buffer - a buffer to read data into (which should be at least count bytes long).

count - the number of bytes that will be read from the stream

io_priority - the [I/O priority][io-priority] of the request.

cancellable - optional #GCancellable object, %NULL to ignore.

callback - callback to call when the request is satisfied

user_data - the data to pass to callback function

readBytes

public Bytes readBytes(long count,
 @Nullable
 Cancellable cancellable)
                throws AllocationError

Like g_input_stream_read(), this tries to read @count bytes from
the stream in a blocking fashion. However, rather than reading into
a user-supplied buffer, this will create a new #GBytes containing
the data that was read. This may be easier to use from language
bindings.

If count is zero, returns a zero-length #GBytes and does nothing. A
value of @count larger than %G_MAXSSIZE will cause a
%G_IO_ERROR_INVALID_ARGUMENT error.

On success, a new #GBytes is returned. It is not an error if the
size of this object is not the same as the requested size, as it
can happen e.g. near the end of a file. A zero-length #GBytes is
returned on end of file (or if @count is zero), but never
otherwise.

If @cancellable is not %NULL, then the operation can be cancelled by
triggering the cancellable object from another thread. If the operation
was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.

On error %NULL is returned and @error is set accordingly.

Parameters:

count - maximum number of bytes that will be read from the stream. Common values include 4096 and 8192.

cancellable - optional #GCancellable object, %NULL to ignore.

Returns:

a new #GBytes, or %NULL on error

Throws:

AllocationError

readBytesAsync

public void readBytesAsync(long count,
 int io_priority,
 @Nullable
 Cancellable cancellable,
 InputStream.OnAsyncReadyCallback callback,
 @Nullable
 Pointer user_data)

Request an asynchronous read of @count bytes from the stream into a
new #GBytes. When the operation is finished @callback will be
called. You can then call g_input_stream_read_bytes_finish() to get the
result of the operation.

During an async request no other sync and async calls are allowed
on @stream, and will result in %G_IO_ERROR_PENDING errors.

A value of @count larger than %G_MAXSSIZE will cause a
%G_IO_ERROR_INVALID_ARGUMENT error.

On success, the new #GBytes will be passed to the callback. It is
not an error if this is smaller than the requested size, as it can
happen e.g. near the end of a file, but generally we try to read as
many bytes as requested. Zero is returned on end of file (or if
@count is zero), but never otherwise.

Any outstanding I/O request with higher priority (lower numerical
value) will be executed before an outstanding request with lower
priority. Default priority is %G_PRIORITY_DEFAULT.

Parameters:

count - the number of bytes that will be read from the stream

io_priority - the [I/O priority][io-priority] of the request

cancellable - optional #GCancellable object, %NULL to ignore.

callback - callback to call when the request is satisfied

user_data - the data to pass to callback function

readBytesFinish

public Bytes readBytesFinish(@Nonnull
 AsyncResult result)
                      throws AllocationError

Finishes an asynchronous stream read-into-#GBytes operation.

Parameters:

result - a #GAsyncResult.

Returns:

the newly-allocated #GBytes, or %NULL on error

Throws:

AllocationError

readFinish

public long readFinish(@Nonnull
 AsyncResult result)
                throws AllocationError

Finishes an asynchronous stream read operation.

Parameters:

result - a #GAsyncResult.

Returns:

number of bytes read in, or -1 on error, or 0 on end of file.

Throws:

AllocationError

setPending

public boolean setPending()
                   throws AllocationError

Sets @stream to have actions pending. If the pending flag is
already set or @stream is closed, it will return %FALSE and set
@error.

Returns:

%TRUE if pending was previously unset and is now set.

Throws:

AllocationError

skip

public long skip(long count,
 @Nullable
 Cancellable cancellable)
          throws AllocationError

Tries to skip @count bytes from the stream. Will block during the operation.

This is identical to g_input_stream_read(), from a behaviour standpoint,
but the bytes that are skipped are not returned to the user. Some
streams have an implementation that is more efficient than reading the data.

This function is optional for inherited classes, as the default implementation
emulates it using read.

If @cancellable is not %NULL, then the operation can be cancelled by
triggering the cancellable object from another thread. If the operation
was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.

Parameters:

count - the number of bytes that will be skipped from the stream

cancellable - optional #GCancellable object, %NULL to ignore.

Returns:

Number of bytes skipped, or -1 on error

Throws:

AllocationError

skipAsync

public void skipAsync(long count,
 int io_priority,
 @Nullable
 Cancellable cancellable,
 InputStream.OnAsyncReadyCallback callback,
 @Nullable
 Pointer user_data)

Request an asynchronous skip of @count bytes from the stream.
When the operation is finished @callback will be called.
You can then call g_input_stream_skip_finish() to get the result
of the operation.

During an async request no other sync and async calls are allowed,
and will result in %G_IO_ERROR_PENDING errors.

A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.

On success, the number of bytes skipped will be passed to the callback.
It is not an error if this is not the same as the requested size, as it
can happen e.g. near the end of a file, but generally we try to skip
as many bytes as requested. Zero is returned on end of file
(or if @count is zero), but never otherwise.

Any outstanding i/o request with higher priority (lower numerical value)
will be executed before an outstanding request with lower priority.
Default priority is %G_PRIORITY_DEFAULT.

The asynchronous methods have a default fallback that uses threads to
implement asynchronicity, so they are optional for inheriting classes.
However, if you override one, you must override all.

Parameters:

count - the number of bytes that will be skipped from the stream

io_priority - the [I/O priority][io-priority] of the request

cancellable - optional #GCancellable object, %NULL to ignore.

callback - callback to call when the request is satisfied

user_data - the data to pass to callback function

skipFinish

public long skipFinish(@Nonnull
 AsyncResult result)
                throws AllocationError

Finishes a stream skip operation.

Parameters:

result - a #GAsyncResult.

Returns:

the size of the bytes skipped, or `-1` on error.

Throws:

AllocationError

getTypeID

public static long getTypeID()

getParentTypeID

public static long getParentTypeID()

getTypeSize

public static TypeSystem.TypeSize getTypeSize()

getParentTypeSize

public static TypeSystem.TypeSize getParentTypeSize()

getInstanceSize

public static int getInstanceSize()