Package org.gnome.soup

Class WebsocketExtension

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.soup.WebsocketExtension

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

WebsocketExtension.WebsocketExtensionImpl, WebsocketExtensionDeflate

@Generated("io.github.jwharm.JavaGI")
public abstract class WebsocketExtension
extends GObject

A WebSocket extension

SoupWebsocketExtension is the base class for WebSocket extension objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebsocketExtension.Builder<B extends WebsocketExtension.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	WebsocketExtension.WebsocketExtensionClass	The class structure for the SoupWebsocketExtension.
static class	WebsocketExtension.WebsocketExtensionImpl	The WebsocketExtensionImpl type represents a native instance of the abstract WebsocketExtension class.

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
WebsocketExtension(MemorySegment address)	Create a WebsocketExtension proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected WebsocketExtension	asParent()	Returns this instance as if it were its parent type.
static WebsocketExtension.Builder<? extends WebsocketExtension.Builder>	builder()	A WebsocketExtension.Builder object constructs a WebsocketExtension with the specified properties.
boolean	configure(WebsocketConnectionType connectionType, @Nullable HashTable<MemorySegment,MemorySegment> params)	Configures this WebsocketExtension with the given params.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
String	getRequestParams()	Get the parameters strings to be included in the request header.
String	getResponseParams()	Get the parameters strings to be included in the response header.
static Type	getType()	Get the GType of the WebsocketExtension class
Bytes	processIncomingMessage(Out<Byte> header, Bytes payload)	Process a message after it's received.
Bytes	processOutgoingMessage(Out<Byte> header, Bytes payload)	Process a message before it's sent.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

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

WebsocketExtension

public WebsocketExtension(MemorySegment address)

Create a WebsocketExtension proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the WebsocketExtension class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected WebsocketExtension asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

configure

public boolean configure(WebsocketConnectionType connectionType,
 @Nullable
 @Nullable HashTable<MemorySegment,MemorySegment> params)
                  throws GErrorException

Configures this WebsocketExtension with the given params.

Parameters:

connectionType - either WebsocketConnectionType.CLIENT or WebsocketConnectionType.SERVER

params - the parameters

Returns:

true if extension could be configured with the given parameters, or false otherwise

Throws:

GErrorException - see GError

getRequestParams

public String getRequestParams()

Get the parameters strings to be included in the request header.

If the extension doesn't include any parameter in the request, this function returns null.

Returns:

a new allocated string with the parameters

getResponseParams

public String getResponseParams()

Get the parameters strings to be included in the response header.

If the extension doesn't include any parameter in the response, this function returns null.

Returns:

a new allocated string with the parameters

processIncomingMessage

public Bytes processIncomingMessage(Out<Byte> header,
 Bytes payload)
                             throws GErrorException

Process a message after it's received.

If the payload isn't changed the given payload is just returned, otherwise Bytes.unref() is called on the given payload and a new GLib.Bytes is returned with the new data.

Extensions using reserved bits of the header will reset them in header.

Parameters:

header - the message header

payload - the payload data

Returns:

the message payload data, or null in case of error

Throws:

GErrorException - see GError

processOutgoingMessage

public Bytes processOutgoingMessage(Out<Byte> header,
 Bytes payload)
                             throws GErrorException

Process a message before it's sent.

If the payload isn't changed the given payload is just returned, otherwise org.gnome.glib.Bytes#unref is called on the given payload and a new GLib.Bytes is returned with the new data.

Extensions using reserved bits of the header will change them in header.

Parameters:

header - the message header

payload - the payload data

Returns:

the message payload data, or null in case of error

Throws:

GErrorException - see GError

builder

public static WebsocketExtension.Builder<? extends WebsocketExtension.Builder> builder()

A WebsocketExtension.Builder object constructs a WebsocketExtension with the specified properties. Use the various set...() methods to set properties, and finish construction with WebsocketExtension.Builder.build().