Package org.gnome.gio

Class PollableOutputStream.PollableOutputStreamInterface

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInterface

org.gnome.gio.PollableOutputStream.PollableOutputStreamInterface

All Implemented Interfaces:

Proxy

Enclosing interface:

PollableOutputStream

public static class PollableOutputStream.PollableOutputStreamInterface
extends TypeInterface

The interface for pollable output streams.

The default implementation of canPoll always returns true.

The default implementation of writeNonblocking calls g_pollable_output_stream_is_writable(), and then calls g_output_stream_write() if it returns true. This means you only need to override it if it is possible that your isWritable implementation may return true when the stream is not actually writable.

The default implementation of writevNonblocking calls g_pollable_output_stream_write_nonblocking() for each vector, and converts its return value and error (if set) to a GPollableReturn. You should override this where possible to avoid having to allocate a GError to return IOErrorEnum.WOULD_BLOCK.

Constructor Summary

Constructors

Constructor	Description
PollableOutputStreamInterface()	Allocate a new PollableOutputStreamInterface.
PollableOutputStreamInterface(Arena arena)	Allocate a new PollableOutputStreamInterface.
PollableOutputStreamInterface(MemorySegment address)	Create a PollableOutputStreamInterface proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
void	overrideCanPoll(Arena arena, Method method)	Override virtual method can_poll.
void	overrideCreateSource(Arena arena, Method method)	Override virtual method create_source.
void	overrideIsWritable(Arena arena, Method method)	Override virtual method is_writable.
void	overrideWriteNonblocking(Arena arena, Method method)	Override virtual method write_nonblocking.
void	overrideWritevNonblocking(Arena arena, Method method)	Override virtual method writev_nonblocking.

Methods inherited from class org.gnome.gobject.TypeInterface

addPrerequisite, getPlugin, instantiatablePrerequisite, peek, peekParent, prerequisites, readGInstanceType, readGType, writeGInstanceType, writeGType

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

PollableOutputStreamInterface

public PollableOutputStreamInterface(MemorySegment address)

Create a PollableOutputStreamInterface proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

PollableOutputStreamInterface

public PollableOutputStreamInterface(Arena arena)

Allocate a new PollableOutputStreamInterface.

Parameters:

arena - to control the memory allocation scope

PollableOutputStreamInterface

public PollableOutputStreamInterface()

Allocate a new PollableOutputStreamInterface. The memory is allocated with Arena.ofAuto().

Method Details

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

overrideCanPoll

public void overrideCanPoll(Arena arena,
 Method method)

Override virtual method can_poll.

Parameters:

method - the method to invoke

overrideIsWritable

public void overrideIsWritable(Arena arena,
 Method method)

Override virtual method is_writable.

Parameters:

method - the method to invoke

overrideCreateSource

public void overrideCreateSource(Arena arena,
 Method method)

Override virtual method create_source.

Parameters:

method - the method to invoke

overrideWriteNonblocking

public void overrideWriteNonblocking(Arena arena,
 Method method)

Override virtual method write_nonblocking.

Parameters:

method - the method to invoke

overrideWritevNonblocking

public void overrideWritevNonblocking(Arena arena,
 Method method)

Override virtual method writev_nonblocking.

Parameters:

method - the method to invoke