B C D E F G H I L M N P Q R S T V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
B
- build() - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Constructs a
PluginFactory
instance that will createPlugin
instances using the configuration provided to this builder. - builder(WasmModule) - Static method in interface io.roastedroot.proxywasm.PluginFactory
-
Creates a new
PluginFactory.Builder
to configure and construct aPluginFactory
instance from the given WASM module.
C
- cas() - Method in class io.roastedroot.proxywasm.SharedData
-
Gets the Compare-And-Swap (CAS) value associated with this data.
- COUNTER - io.roastedroot.proxywasm.MetricType
-
A metric that only increments.
- create() - Method in interface io.roastedroot.proxywasm.PluginFactory
-
Creates and returns a new
Plugin
instance. - CRITICAL - io.roastedroot.proxywasm.LogLevel
-
Critical log level.
D
- data - Variable in class io.roastedroot.proxywasm.SimpleSharedQueueHandler.SharedQueue
-
The underlying list holding the byte array messages in the queue (FIFO order).
- data() - Method in class io.roastedroot.proxywasm.SharedData
-
Gets the raw data bytes.
- DEBUG - io.roastedroot.proxywasm.LogLevel
-
Debug log level.
- DEFAULT - Static variable in interface io.roastedroot.proxywasm.LogHandler
-
A default, no-operation
LogHandler
. - DEFAULT - Static variable in interface io.roastedroot.proxywasm.MetricsHandler
-
A default, non-functional instance of
MetricsHandler
. - DEFAULT - Static variable in interface io.roastedroot.proxywasm.SharedDataHandler
-
A default, non-functional instance of
SharedDataHandler
. - DEFAULT - Static variable in interface io.roastedroot.proxywasm.SharedQueueHandler
-
A default, non-functional instance of
SharedQueueHandler
. - defineMetric(MetricType, String) - Method in interface io.roastedroot.proxywasm.MetricsHandler
-
Defines a new metric.
- defineMetric(MetricType, String) - Method in class io.roastedroot.proxywasm.SimpleMetricsHandler
-
Defines a new metric with the specified type and name.
- dequeueSharedQueue(int) - Method in interface io.roastedroot.proxywasm.SharedQueueHandler
-
Removes and returns the next available message (byte array) from the front of the specified queue.
- dequeueSharedQueue(int) - Method in class io.roastedroot.proxywasm.SimpleSharedQueueHandler
-
Removes and returns the message at the front of the specified queue.
E
- enqueueSharedQueue(int, byte[]) - Method in interface io.roastedroot.proxywasm.SharedQueueHandler
-
Adds a message (byte array) to the end of the specified shared queue.
- enqueueSharedQueue(int, byte[]) - Method in class io.roastedroot.proxywasm.SimpleSharedQueueHandler
-
Adds a message (byte array) to the end of the specified queue.
- equals(Object) - Method in class io.roastedroot.proxywasm.QueueName
- ERROR - io.roastedroot.proxywasm.LogLevel
-
Error log level.
F
- ForeignFunction - Interface in io.roastedroot.proxywasm
-
A functional interface that represents a foreign function call in the Proxy-Wasm.
- fromInt(int) - Static method in enum io.roastedroot.proxywasm.LogLevel
-
Convert an integer value to its corresponding LogLevel enum constant.
- fromInt(int) - Static method in enum io.roastedroot.proxywasm.MetricType
-
Convert an integer value to its corresponding MetricType enum constant.
G
- GAUGE - io.roastedroot.proxywasm.MetricType
-
A metric that can be arbitrarily set.
- getLogLevel() - Method in interface io.roastedroot.proxywasm.LogHandler
-
Gets the current log level.
- getMetric(int) - Method in interface io.roastedroot.proxywasm.MetricsHandler
-
Retrieves the current value of a metric.
- getMetric(int) - Method in class io.roastedroot.proxywasm.SimpleMetricsHandler
-
Retrieves the current value of the specified metric.
- getSharedData(String) - Method in interface io.roastedroot.proxywasm.SharedDataHandler
-
Retrieves the shared data associated with the given key.
- getSharedData(String) - Method in class io.roastedroot.proxywasm.SimpleSharedDataHandler
-
Retrieves the shared data associated with the given key from the in-memory store.
- getSharedQueue(int) - Method in class io.roastedroot.proxywasm.SimpleSharedQueueHandler
-
Retrieves the internal
SimpleSharedQueueHandler.SharedQueue
object associated with the given ID. - getValue() - Method in enum io.roastedroot.proxywasm.MetricType
-
Get the integer value of this metric type as defined by the Proxy-WASM ABI.
- getValue() - Method in class io.roastedroot.proxywasm.SimpleMetricsHandler.Metric
-
Gets the current value of the metric.
H
- hashCode() - Method in class io.roastedroot.proxywasm.QueueName
- HISTOGRAM - io.roastedroot.proxywasm.MetricType
-
A metric that accumulates observations into predefined buckets and a sum of observations.
I
- id - Variable in class io.roastedroot.proxywasm.SimpleSharedQueueHandler.SharedQueue
-
The unique integer ID assigned to this queue by the handler.
- id() - Method in class io.roastedroot.proxywasm.SimpleMetricsHandler.Metric
-
Gets the unique integer ID of the metric.
- incrementMetric(int, long) - Method in interface io.roastedroot.proxywasm.MetricsHandler
-
Increments a metric's value (typically used for Counters).
- incrementMetric(int, long) - Method in class io.roastedroot.proxywasm.SimpleMetricsHandler
-
Increments the value of the specified metric by the given amount.
- INFO - io.roastedroot.proxywasm.LogLevel
-
Info log level.
- io.roastedroot.proxywasm - package io.roastedroot.proxywasm
L
- log(LogLevel, String) - Method in interface io.roastedroot.proxywasm.LogHandler
-
Logs a message at the specified log level.
- LogHandler - Interface in io.roastedroot.proxywasm
-
Interface for handling logging sent form the guest of Proxy-WASM environment.
- LogLevel - Enum in io.roastedroot.proxywasm
-
Represents log levels used within the Proxy-WASM ABI specification.
M
- Metric(int, MetricType, String) - Constructor for class io.roastedroot.proxywasm.SimpleMetricsHandler.Metric
-
Constructs a new Metric instance.
- MetricsHandler - Interface in io.roastedroot.proxywasm
-
Defines the contract for handling metrics operations initiated by a Proxy-WASM module.
- MetricType - Enum in io.roastedroot.proxywasm
-
Represents the types of metrics that can be defined and manipulated via the Proxy-WASM ABI.
N
- name() - Method in interface io.roastedroot.proxywasm.Plugin
-
Returns the configured name of this plugin instance.
- name() - Method in interface io.roastedroot.proxywasm.PluginFactory
-
Returns the configured name of the plugin.
- name() - Method in class io.roastedroot.proxywasm.QueueName
-
Gets the specific name string part of the queue name.
- name() - Method in class io.roastedroot.proxywasm.SimpleMetricsHandler.Metric
-
Gets the name of the metric.
P
- Plugin - Interface in io.roastedroot.proxywasm
-
Represents a Proxy-WASM plugin, providing the bridge between the host environment and the WASM module.
- PluginFactory - Interface in io.roastedroot.proxywasm
-
A functional interface representing a factory for creating
Plugin
instances. - PluginFactory.Builder - Class in io.roastedroot.proxywasm
-
Builder for creating a PluginFactory instance that can create Plugin instances with pre-configured settings.
Q
- queueName - Variable in class io.roastedroot.proxywasm.SimpleSharedQueueHandler.SharedQueue
-
The name identifying this queue, composed of a VM ID and queue name string.
- QueueName - Class in io.roastedroot.proxywasm
-
Represents the identifier for a shared queue within the Proxy-WASM environment.
- QueueName(String, String) - Constructor for class io.roastedroot.proxywasm.QueueName
-
Constructs a new QueueName.
R
- recordMetric(int, long) - Method in interface io.roastedroot.proxywasm.MetricsHandler
-
Records a value for a metric (typically used for Gauges or Histograms).
- recordMetric(int, long) - Method in class io.roastedroot.proxywasm.SimpleMetricsHandler
-
Sets the value of the specified metric to the given value.
- registerSharedQueue(QueueName) - Method in interface io.roastedroot.proxywasm.SharedQueueHandler
-
Registers a shared queue with the given name, creating it if it doesn't exist, and returns its unique identifier (queue ID).
- registerSharedQueue(QueueName) - Method in class io.roastedroot.proxywasm.SimpleSharedQueueHandler
-
Registers a new shared queue with the given name or returns the ID if it already exists.
- removeMetric(int) - Method in interface io.roastedroot.proxywasm.MetricsHandler
-
Removes or deletes a previously defined metric.
- removeMetric(int) - Method in class io.roastedroot.proxywasm.SimpleMetricsHandler
-
Removes the metric definition and its associated value.
- resolveSharedQueue(QueueName) - Method in interface io.roastedroot.proxywasm.SharedQueueHandler
-
Resolves the unique identifier (queue ID) for a shared queue given its name.
- resolveSharedQueue(QueueName) - Method in class io.roastedroot.proxywasm.SimpleSharedQueueHandler
-
Finds the ID of an existing queue based on its name.
- result() - Method in exception io.roastedroot.proxywasm.WasmException
-
Gets the underlying
WasmResult
code associated with this exception.
S
- setSharedData(String, byte[], int) - Method in interface io.roastedroot.proxywasm.SharedDataHandler
-
Sets or updates the shared data associated with the given key.
- setSharedData(String, byte[], int) - Method in class io.roastedroot.proxywasm.SimpleSharedDataHandler
-
Sets or updates the shared data associated with the given key in the in-memory store, potentially performing a Compare-And-Swap (CAS) check.
- setValue(long) - Method in class io.roastedroot.proxywasm.SimpleMetricsHandler.Metric
-
Sets the current value of the metric.
- shared() - Method in interface io.roastedroot.proxywasm.PluginFactory
-
Indicates whether this plugin instance is shared across multiple contexts or requests.
- SharedData - Class in io.roastedroot.proxywasm
-
Represents a unit of shared data retrieved from the host environment via
SharedDataHandler.getSharedData(String)
. - SharedData(byte[], int) - Constructor for class io.roastedroot.proxywasm.SharedData
-
Constructs a new SharedData instance.
- SharedDataHandler - Interface in io.roastedroot.proxywasm
-
Defines the contract for handling shared key-value data accessible by Proxy-WASM modules.
- SharedQueue(QueueName, int) - Constructor for class io.roastedroot.proxywasm.SimpleSharedQueueHandler.SharedQueue
-
Constructs a new SharedQueue instance.
- SharedQueueHandler - Interface in io.roastedroot.proxywasm
-
Defines the contract for handling shared message queues accessible by Proxy-WASM modules.
- SimpleMetricsHandler - Class in io.roastedroot.proxywasm
-
A basic, in-memory implementation of the
MetricsHandler
interface. - SimpleMetricsHandler() - Constructor for class io.roastedroot.proxywasm.SimpleMetricsHandler
-
Default constructor.
- SimpleMetricsHandler.Metric - Class in io.roastedroot.proxywasm
-
Represents an individual metric managed by
SimpleMetricsHandler
. - SimpleSharedDataHandler - Class in io.roastedroot.proxywasm
-
A basic, in-memory implementation of the
SharedDataHandler
interface. - SimpleSharedDataHandler() - Constructor for class io.roastedroot.proxywasm.SimpleSharedDataHandler
-
Default constructor.
- SimpleSharedQueueHandler - Class in io.roastedroot.proxywasm
-
A basic, in-memory implementation of the
SharedQueueHandler
interface. - SimpleSharedQueueHandler() - Constructor for class io.roastedroot.proxywasm.SimpleSharedQueueHandler
-
Default constructor.
- SimpleSharedQueueHandler.SharedQueue - Class in io.roastedroot.proxywasm
-
Represents an individual shared queue managed by
SimpleSharedQueueHandler
. - StartException - Exception in io.roastedroot.proxywasm
-
Exception thrown when an error occurs during the initialization or startup phase of a Proxy-WASM plugin.
- StartException(String) - Constructor for exception io.roastedroot.proxywasm.StartException
-
Constructs a new StartException with the specified detail message.
- StartException(String, Throwable) - Constructor for exception io.roastedroot.proxywasm.StartException
-
Constructs a new StartException with the specified detail message and cause.
- SYSTEM - Static variable in interface io.roastedroot.proxywasm.LogHandler
-
A simple
LogHandler
that logs all messages toSystem.out
.
T
- TRACE - io.roastedroot.proxywasm.LogLevel
-
Trace log level.
- type() - Method in class io.roastedroot.proxywasm.SimpleMetricsHandler.Metric
-
Gets the type of the metric.
V
- value() - Method in enum io.roastedroot.proxywasm.LogLevel
-
Get the integer value of this log level as defined by the Proxy-WASM ABI.
- valueOf(String) - Static method in enum io.roastedroot.proxywasm.LogLevel
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.roastedroot.proxywasm.MetricType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum io.roastedroot.proxywasm.LogLevel
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.roastedroot.proxywasm.MetricType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- vmId() - Method in class io.roastedroot.proxywasm.QueueName
-
Gets the VM identifier part of the queue name.
W
- WARN - io.roastedroot.proxywasm.LogLevel
-
Warn log level.
- WasmException - Exception in io.roastedroot.proxywasm
-
An exception used to signal specific outcomes or errors from host functions back to the calling Proxy-WASM module.
- WasmException(WasmResult) - Constructor for exception io.roastedroot.proxywasm.WasmException
-
Constructs a new WasmException with the specified result code.
- withForeignFunctions(Map<String, ForeignFunction>) - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Registers foreign (host-provided) functions that can be called by the WASM plugin.
- withImportMemory(ImportMemory) - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Provides an explicit memory instance to be used by the WASM module.
- withLogger(LogHandler) - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Provides a
LogHandler
implementation for the plugin to use. - withMachineFactory(Function<Instance, Machine>) - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Configures a custom factory for creating the
Machine
used to execute the WASM code. - withMetricsHandler(MetricsHandler) - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Provides a
MetricsHandler
implementation for the plugin to use. - withMinTickPeriodMilliseconds(int) - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Sets a minimum interval for the plugin's periodic timer ticks (
proxy_on_tick
). - withName(String) - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Sets the optional name for this plugin instance.
- withPluginConfig(byte[]) - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Sets the specific configuration data for this plugin instance.
- withPluginConfig(String) - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Sets the specific configuration data for this plugin instance using a String.
- withShared(boolean) - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Configures whether the plugin instance should be shared across multiple host requests or contexts.
- withSharedDataHandler(SharedDataHandler) - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Provides a
SharedDataHandler
implementation for the plugin to use. - withSharedQueueHandler(SharedQueueHandler) - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Provides a
SharedQueueHandler
implementation for the plugin to use. - withStrictUpstreams(boolean) - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Configures the behavior when a plugin attempts to call an upstream that is not defined in the `upstreams` map provided via
PluginFactory.Builder.withUpstreams(Map)
. - withUpstreams(Map<String, URI>) - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Defines mappings from logical upstream names (used within the plugin) to actual network URIs.
- withVmConfig(byte[]) - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Sets the Virtual Machine (VM) configuration data for the plugin.
- withVmConfig(String) - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Sets the Virtual Machine (VM) configuration data for the plugin using a String.
- withWasiOptions(WasiOptions) - Method in class io.roastedroot.proxywasm.PluginFactory.Builder
-
Configures WebAssembly System Interface (WASI) options for the plugin instance.
All Classes All Packages