Package org.gnome.soup

Class MessageHeadersIter

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.soup.MessageHeadersIter

All Implemented Interfaces:

Proxy

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

An opaque type used to iterate over a SoupMessageHeaders structure.

After intializing the iterator with init(org.gnome.soup.MessageHeadersIter, org.gnome.soup.MessageHeaders), call next(io.github.jwharm.javagi.base.Out<java.lang.String>, io.github.jwharm.javagi.base.Out<java.lang.String>) to fetch data from it.

You may not modify the headers while iterating over them.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static void	init(MessageHeadersIter iter, MessageHeaders hdrs)	Initializes iter for iterating hdrs.
boolean	next(Out<String> name, Out<String> value)	Yields the next name/value pair in the MessageHeaders being iterated by this MessageHeadersIter.
MemorySegment[]	readDummy()	Read the value of the field dummy.
void	writeDummy(MemorySegment[] dummy, Arena _arena)	Write a value in the field dummy.

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

MessageHeadersIter

public MessageHeadersIter(MemorySegment address)

Create a MessageHeadersIter proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

MessageHeadersIter

public MessageHeadersIter(Arena arena)

Allocate a new MessageHeadersIter.

Parameters:

arena - to control the memory allocation scope

MessageHeadersIter

public MessageHeadersIter()

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

MessageHeadersIter

public MessageHeadersIter(MemorySegment[] dummy,
 Arena arena)

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

Parameters:

dummy - value for the field dummy

arena - to control the memory allocation scope

MessageHeadersIter

public MessageHeadersIter(MemorySegment[] dummy)

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

Parameters:

dummy - value for the field dummy

Method Details

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

readDummy

public MemorySegment[] readDummy()

Read the value of the field dummy.

Returns:

The value of the field dummy

writeDummy

public void writeDummy(MemorySegment[] dummy,
 Arena _arena)

Write a value in the field dummy.

Parameters:

dummy - The new value for the field dummy

_arena - to control the memory allocation scope

init

public static void init(MessageHeadersIter iter,
 MessageHeaders hdrs)
                 throws UnsupportedPlatformException

Initializes iter for iterating hdrs.

Parameters:

iter - a pointer to a SoupMessageHeadersIter structure

hdrs - a SoupMessageHeaders

Throws:

UnsupportedPlatformException - when run on a platform other than linux

next

public boolean next(Out<String> name,
 Out<String> value)

Yields the next name/value pair in the MessageHeaders being iterated by this MessageHeadersIter.

If this MessageHeadersIter has already yielded the last header, then next(io.github.jwharm.javagi.base.Out<java.lang.String>, io.github.jwharm.javagi.base.Out<java.lang.String>) will return false and name and value will be unchanged.

Parameters:

name - pointer to a variable to return the header name in

value - pointer to a variable to return the header value in

Returns:

true if another name and value were returned, false if the end of the headers has been reached.