Class WebsocketExtension

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.soup.WebsocketExtension

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

WebsocketExtension.WebsocketExtension$Impl, WebsocketExtensionDeflate

@Generated("org.javagi.JavaGI")
public abstract class WebsocketExtension
extends GObject

A WebSocket extension

WebsocketExtension 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.WebsocketExtension$Impl	The WebsocketExtension$Impl type represents a native instance of the abstract WebsocketExtension class.
static class	WebsocketExtension.WebsocketExtensionClass	The class structure for the WebsocketExtension.

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected WebsocketExtension	asParent()	Return this instance as if it were its parent type.
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.
@Nullable String	getRequestParams()	Get the parameters strings to be included in the request header.
@Nullable String	getResponseParams()	Get the parameters strings to be included in the response header.
static @Nullable Type	getType()	Get the GType of the WebsocketExtension class.
byte[]	processIncomingMessage(Out<Byte> header, byte[] payload)	Process a message after it's received.
byte[]	processOutgoingMessage(Out<Byte> header, byte[] payload)	Process a message before it's sent.

Methods inherited from class GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, builder, 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 TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

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

Constructor Details

WebsocketExtension

public WebsocketExtension(MemorySegment address)

Create a WebsocketExtension instance for the provided memory address.

Parameters:

address - the memory address of the native object

WebsocketExtension

public WebsocketExtension()

Create a new WebsocketExtension.

Method Details

getType

public static @Nullable 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()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class GObject

Returns:

the instance as if it were its parent type

configure

public boolean configure(WebsocketConnectionType connectionType,
 @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 @Nullable 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 @Nullable 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 byte[] processIncomingMessage(Out<Byte> header,
 byte[] payload)
                              throws GErrorException

Process a message after it's received.

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 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 byte[] processOutgoingMessage(Out<Byte> header,
 byte[] 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