Package org.gnome.glib

Class UnixPipe

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.glib.UnixPipe

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class UnixPipe
extends ProxyInstance

A Unix pipe. The advantage of this type over int[2] is that it can be closed automatically when it goes out of scope, using g_auto(GUnixPipe), on compilers that support that feature.

Since:

2.80

Constructor Summary

Constructors

Constructor	Description
UnixPipe()	Allocate a new UnixPipe.
UnixPipe(int[] fds)	Allocate a new UnixPipe with the fields set to the provided values.
UnixPipe(int[] fds, Arena arena)	Allocate a new UnixPipe with the fields set to the provided values.
UnixPipe(Arena arena)	Allocate a new UnixPipe.
UnixPipe(MemorySegment address)	Create a UnixPipe proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
@org.jspecify.annotations.Nullable int @Nullable []	readFds()	Read the value of the field fds.
void	writeFds(@org.jspecify.annotations.Nullable int @Nullable [] fds, Arena _arena)	Write a value in the field fds.

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

UnixPipe

public UnixPipe(MemorySegment address)

Create a UnixPipe proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

UnixPipe

public UnixPipe(Arena arena)

Allocate a new UnixPipe.

Parameters:

arena - to control the memory allocation scope

UnixPipe

public UnixPipe()

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

UnixPipe

public UnixPipe(int[] fds,
 Arena arena)

Allocate a new UnixPipe with the fields set to the provided values.

Parameters:

fds - value for the field fds

arena - to control the memory allocation scope

UnixPipe

public UnixPipe(int[] fds)

Allocate a new UnixPipe with the fields set to the provided values. The memory is allocated with Arena.ofAuto().

Parameters:

fds - value for the field fds

Method Details

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

readFds

public @org.jspecify.annotations.Nullable int @Nullable [] readFds()

Read the value of the field fds.

Returns:

The value of the field fds

writeFds

public void writeFds(@org.jspecify.annotations.Nullable int @Nullable [] fds,
 Arena _arena)

Write a value in the field fds.

Parameters:

fds - The new value for the field fds