Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- address() - Method in record class dev.despical.portbridge.tunnel.TunnelSnapshot
-
Returns the value of the
addressrecord component. - address(CommandSender) - Method in class dev.despical.portbridge.command.BridgeCommands
- address(CommandSender, TunnelSnapshot) - Method in class dev.despical.portbridge.command.ChatUI
- Appearance(Map, Map) - Constructor for record class dev.despical.portbridge.config.Messages.Appearance
-
Creates an instance of a
Appearancerecord class. - autoDetect() - Method in record class dev.despical.portbridge.config.BridgeSettings.Local
-
Returns the value of the
autoDetectrecord component. - autoDownload() - Method in record class dev.despical.portbridge.config.BridgeSettings.Binary
-
Returns the value of the
autoDownloadrecord component. - autoStart() - Method in record class dev.despical.portbridge.config.BridgeSettings.Startup
-
Returns the value of the
autoStartrecord component.
B
- binary() - Method in record class dev.despical.portbridge.config.BridgeSettings
-
Returns the value of the
binaryrecord component. - Binary(boolean, String, int) - Constructor for record class dev.despical.portbridge.config.BridgeSettings.Binary
-
Creates an instance of a
Binaryrecord class. - BoreInstaller - Class in dev.despical.portbridge.bore
-
Resolves a configured Bore executable or installs a verified managed release.
- BoreInstaller(Path, Logger) - Constructor for class dev.despical.portbridge.bore.BoreInstaller
- BoreOutput - Class in dev.despical.portbridge.bore
-
Recognizes public-port announcements from the pinned Bore client.
- BridgeCommands - Class in dev.despical.portbridge.command
-
Receives ACF command invocations for tunnel status and lifecycle management.
- BridgeCommands(PortBridgePlugin) - Constructor for class dev.despical.portbridge.command.BridgeCommands
- BridgeSettings - Record Class in dev.despical.portbridge.config
-
Captures validated bridge configuration for asynchronous tunnel operations.
- BridgeSettings(BridgeSettings.Startup, BridgeSettings.Local, BridgeSettings.Relay, BridgeSettings.Binary, BridgeSettings.Reconnect, BridgeSettings.Health, boolean, boolean) - Constructor for record class dev.despical.portbridge.config.BridgeSettings
-
Creates an instance of a
BridgeSettingsrecord class. - BridgeSettings.Binary - Record Class in dev.despical.portbridge.config
-
Stores managed-download policy, an optional executable path and download timeout.
- BridgeSettings.Health - Record Class in dev.despical.portbridge.config
-
Stores public-probe enablement, timing and the consecutive-failure threshold.
- BridgeSettings.Local - Record Class in dev.despical.portbridge.config
-
Stores the resolved Minecraft listener and automatic-detection preference.
- BridgeSettings.Reconnect - Record Class in dev.despical.portbridge.config
-
Stores retry enablement, capped delay bounds and the optional attempt limit.
- BridgeSettings.Relay - Record Class in dev.despical.portbridge.config
-
Stores relay endpoints, public-port selection and the optional shared secret.
- BridgeSettings.Startup - Record Class in dev.despical.portbridge.config
-
Stores whether and when automatic tunnel startup should be scheduled.
C
- canRetry(BridgeSettings.Reconnect, int) - Static method in class dev.despical.portbridge.tunnel.RetryPolicy
- chat() - Method in class dev.despical.portbridge.PortBridgePlugin
- ChatUI - Class in dev.despical.portbridge.command
-
Renders Adventure chat panels with configured text and permission-aware actions.
- ChatUI(Messages) - Constructor for class dev.despical.portbridge.command.ChatUI
- ChatUI(JavaPlugin) - Constructor for class dev.despical.portbridge.command.ChatUI
- clean(String) - Static method in class dev.despical.portbridge.bore.BoreOutput
- close() - Method in class dev.despical.portbridge.tunnel.TunnelService
- color(String) - Method in record class dev.despical.portbridge.config.Messages.Appearance
- colors() - Method in record class dev.despical.portbridge.config.Messages.Appearance
-
Returns the value of the
colorsrecord component. - connected(CommandSender, TunnelSnapshot) - Method in class dev.despical.portbridge.command.ChatUI
- connectedAt() - Method in record class dev.despical.portbridge.tunnel.TunnelSnapshot
-
Returns the value of the
connectedAtrecord component. - CONNECTING - Enum constant in enum class dev.despical.portbridge.tunnel.TunnelState
D
- debug() - Method in record class dev.despical.portbridge.config.BridgeSettings
-
Returns the value of the
debugrecord component. - DEGRADED - Enum constant in enum class dev.despical.portbridge.tunnel.TunnelState
- delaySeconds() - Method in record class dev.despical.portbridge.config.BridgeSettings.Startup
-
Returns the value of the
delaySecondsrecord component. - delaySeconds(BridgeSettings.Reconnect, int) - Static method in class dev.despical.portbridge.tunnel.RetryPolicy
- detail() - Method in record class dev.despical.portbridge.tunnel.TunnelSnapshot
-
Returns the value of the
detailrecord component. - dev.despical.portbridge - package dev.despical.portbridge
-
Plugin lifecycle, server-thread configuration and tunnel notifications.
- dev.despical.portbridge.bore - package dev.despical.portbridge.bore
-
Native Bore executable installation, output parsing and Minecraft route probes.
- dev.despical.portbridge.command - package dev.despical.portbridge.command
-
Permission-aware command handlers and configured Adventure chat panels.
- dev.despical.portbridge.config - package dev.despical.portbridge.config
-
Strict configuration loading and immutable bridge settings.
- dev.despical.portbridge.listener - package dev.despical.portbridge.listener
-
Server-thread player notifications for the current public connection address.
- dev.despical.portbridge.tunnel - package dev.despical.portbridge.tunnel
-
Asynchronous tunnel ownership, lifecycle snapshots and reconnect policy.
- downloadTimeoutSeconds() - Method in record class dev.despical.portbridge.config.BridgeSettings.Binary
-
Returns the value of the
downloadTimeoutSecondsrecord component.
E
- enabled() - Method in record class dev.despical.portbridge.config.BridgeSettings.Health
-
Returns the value of the
enabledrecord component. - enabled() - Method in record class dev.despical.portbridge.config.BridgeSettings.Reconnect
-
Returns the value of the
enabledrecord component. - equals(Object) - Method in record class dev.despical.portbridge.config.BridgeSettings.Binary
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.despical.portbridge.config.BridgeSettings
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.despical.portbridge.config.BridgeSettings.Health
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.despical.portbridge.config.BridgeSettings.Local
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.despical.portbridge.config.BridgeSettings.Reconnect
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.despical.portbridge.config.BridgeSettings.Relay
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.despical.portbridge.config.BridgeSettings.Startup
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.despical.portbridge.config.Messages.Appearance
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.despical.portbridge.tunnel.TunnelSnapshot
-
Indicates whether some other object is "equal to" this one.
- error(CommandSender, String) - Method in class dev.despical.portbridge.command.ChatUI
- errorKey(CommandSender, String, Map) - Method in class dev.despical.portbridge.command.ChatUI
- executable() - Method in record class dev.despical.portbridge.config.BridgeSettings.Binary
-
Returns the value of the
executablerecord component.
F
- FAILED - Enum constant in enum class dev.despical.portbridge.tunnel.TunnelState
- failureThreshold() - Method in record class dev.despical.portbridge.config.BridgeSettings.Health
-
Returns the value of the
failureThresholdrecord component. - fallbackToRandom() - Method in record class dev.despical.portbridge.config.BridgeSettings.Relay
-
Returns the value of the
fallbackToRandomrecord component. - format(String, Map) - Method in record class dev.despical.portbridge.config.Messages.Appearance
- format(String, Map) - Method in class dev.despical.portbridge.config.Messages
H
- hasAddress() - Method in record class dev.despical.portbridge.tunnel.TunnelSnapshot
- hashCode() - Method in record class dev.despical.portbridge.config.BridgeSettings.Binary
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.despical.portbridge.config.BridgeSettings
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.despical.portbridge.config.BridgeSettings.Health
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.despical.portbridge.config.BridgeSettings.Local
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.despical.portbridge.config.BridgeSettings.Reconnect
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.despical.portbridge.config.BridgeSettings.Relay
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.despical.portbridge.config.BridgeSettings.Startup
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.despical.portbridge.config.Messages.Appearance
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.despical.portbridge.tunnel.TunnelSnapshot
-
Returns a hash code value for this object.
- health() - Method in record class dev.despical.portbridge.config.BridgeSettings
-
Returns the value of the
healthrecord component. - Health(boolean, int, int, int) - Constructor for record class dev.despical.portbridge.config.BridgeSettings.Health
-
Creates an instance of a
Healthrecord class. - help(CommandSender) - Method in class dev.despical.portbridge.command.BridgeCommands
- help(CommandSender) - Method in class dev.despical.portbridge.command.ChatUI
- host() - Method in record class dev.despical.portbridge.config.BridgeSettings.Local
-
Returns the value of the
hostrecord component. - host() - Method in record class dev.despical.portbridge.config.BridgeSettings.Relay
-
Returns the value of the
hostrecord component.
I
- initialDelaySeconds() - Method in record class dev.despical.portbridge.config.BridgeSettings.Reconnect
-
Returns the value of the
initialDelaySecondsrecord component. - intervalSeconds() - Method in record class dev.despical.portbridge.config.BridgeSettings.Health
-
Returns the value of the
intervalSecondsrecord component.
L
- lastError() - Method in record class dev.despical.portbridge.tunnel.TunnelSnapshot
-
Returns the value of the
lastErrorrecord component. - latencyMillis() - Method in record class dev.despical.portbridge.tunnel.TunnelSnapshot
-
Returns the value of the
latencyMillisrecord component. - load() - Method in class dev.despical.portbridge.config.SettingsLoader
- local() - Method in record class dev.despical.portbridge.config.BridgeSettings
-
Returns the value of the
localrecord component. - Local(boolean, String, int) - Constructor for record class dev.despical.portbridge.config.BridgeSettings.Local
-
Creates an instance of a
Localrecord class. - localAddress() - Method in record class dev.despical.portbridge.tunnel.TunnelSnapshot
-
Returns the value of the
localAddressrecord component.
M
- maxAttempts() - Method in record class dev.despical.portbridge.config.BridgeSettings.Reconnect
-
Returns the value of the
maxAttemptsrecord component. - maxDelaySeconds() - Method in record class dev.despical.portbridge.config.BridgeSettings.Reconnect
-
Returns the value of the
maxDelaySecondsrecord component. - message(String) - Method in record class dev.despical.portbridge.config.Messages.Appearance
- messages() - Method in record class dev.despical.portbridge.config.Messages.Appearance
-
Returns the value of the
messagesrecord component. - Messages - Class in dev.despical.portbridge.config
-
Loads and validates configurable command, tunnel and framework messages.
- Messages(JavaPlugin) - Constructor for class dev.despical.portbridge.config.Messages
- Messages.Appearance - Record Class in dev.despical.portbridge.config
-
Retains validated literal messages and theme colors for one render snapshot.
- MinecraftStatusProbe - Class in dev.despical.portbridge.bore
-
Checks a Minecraft Java listener using the status handshake and ping exchange.
N
- nextRetryAt() - Method in record class dev.despical.portbridge.tunnel.TunnelSnapshot
-
Returns the value of the
nextRetryAtrecord component. - notice(CommandSender, String) - Method in class dev.despical.portbridge.command.ChatUI
- noticeKey(CommandSender, String) - Method in class dev.despical.portbridge.command.ChatUI
- notifyOnJoin() - Method in record class dev.despical.portbridge.config.BridgeSettings
-
Returns the value of the
notifyOnJoinrecord component.
O
- onDisable() - Method in class dev.despical.portbridge.PortBridgePlugin
- onEnable() - Method in class dev.despical.portbridge.PortBridgePlugin
- onJoin(PlayerJoinEvent) - Method in class dev.despical.portbridge.listener.PlayerJoinListener
- ONLINE - Enum constant in enum class dev.despical.portbridge.tunnel.TunnelState
P
- ping(String, int, int) - Static method in class dev.despical.portbridge.bore.MinecraftStatusProbe
- PlayerJoinListener - Class in dev.despical.portbridge.listener
-
Shows the current connection address to authorized joining players.
- PlayerJoinListener(PortBridgePlugin) - Constructor for class dev.despical.portbridge.listener.PlayerJoinListener
- port() - Method in record class dev.despical.portbridge.config.BridgeSettings.Local
-
Returns the value of the
portrecord component. - port() - Method in record class dev.despical.portbridge.config.BridgeSettings.Relay
-
Returns the value of the
portrecord component. - PortBridgePlugin - Class in dev.despical.portbridge
-
Coordinates the lifecycle of PortBridge and its shared tunnel services.
- PortBridgePlugin() - Constructor for class dev.despical.portbridge.PortBridgePlugin
- PREPARING - Enum constant in enum class dev.despical.portbridge.tunnel.TunnelState
- publicHost() - Method in record class dev.despical.portbridge.config.BridgeSettings.Relay
-
Returns the value of the
publicHostrecord component.
R
- reconfigure(BridgeSettings) - Method in class dev.despical.portbridge.tunnel.TunnelService
-
Reload preserves an explicit stop; auto-start applies only to server startup.
- reconnect() - Method in record class dev.despical.portbridge.config.BridgeSettings
-
Returns the value of the
reconnectrecord component. - Reconnect(boolean, int, int, int) - Constructor for record class dev.despical.portbridge.config.BridgeSettings.Reconnect
-
Creates an instance of a
Reconnectrecord class. - reconnectAttempt() - Method in record class dev.despical.portbridge.tunnel.TunnelSnapshot
-
Returns the value of the
reconnectAttemptrecord component. - RECONNECTING - Enum constant in enum class dev.despical.portbridge.tunnel.TunnelState
- relay() - Method in record class dev.despical.portbridge.config.BridgeSettings
-
Returns the value of the
relayrecord component. - Relay(String, String, int, boolean, String) - Constructor for record class dev.despical.portbridge.config.BridgeSettings.Relay
-
Creates an instance of a
Relayrecord class. - reload() - Method in class dev.despical.portbridge.command.ChatUI
- reload() - Method in class dev.despical.portbridge.config.Messages
- reload(CommandSender) - Method in class dev.despical.portbridge.command.BridgeCommands
- reloadBridge() - Method in class dev.despical.portbridge.PortBridgePlugin
- remotePort(String) - Static method in class dev.despical.portbridge.bore.BoreOutput
- resolve(BridgeSettings.Binary) - Method in class dev.despical.portbridge.bore.BoreInstaller
- restart() - Method in class dev.despical.portbridge.tunnel.TunnelService
- restart(CommandSender) - Method in class dev.despical.portbridge.command.BridgeCommands
- restartTunnel() - Method in class dev.despical.portbridge.PortBridgePlugin
- RetryPolicy - Class in dev.despical.portbridge.tunnel
-
Calculates bounded exponential reconnect delays and retry eligibility.
S
- secret() - Method in record class dev.despical.portbridge.config.BridgeSettings.Relay
-
Returns the value of the
secretrecord component. - settings() - Method in class dev.despical.portbridge.PortBridgePlugin
- SettingsLoader - Class in dev.despical.portbridge.config
-
Validates configuration before publishing an immutable bridge settings value.
- SettingsLoader(JavaPlugin) - Constructor for class dev.despical.portbridge.config.SettingsLoader
- snapshot() - Method in class dev.despical.portbridge.PortBridgePlugin
- snapshot() - Method in class dev.despical.portbridge.tunnel.TunnelService
- start() - Method in class dev.despical.portbridge.tunnel.TunnelService
- start(CommandSender) - Method in class dev.despical.portbridge.command.BridgeCommands
- startTunnel() - Method in class dev.despical.portbridge.PortBridgePlugin
- startup() - Method in record class dev.despical.portbridge.config.BridgeSettings
-
Returns the value of the
startuprecord component. - Startup(boolean, int) - Constructor for record class dev.despical.portbridge.config.BridgeSettings.Startup
-
Creates an instance of a
Startuprecord class. - state() - Method in record class dev.despical.portbridge.tunnel.TunnelSnapshot
-
Returns the value of the
staterecord component. - status(CommandSender) - Method in class dev.despical.portbridge.command.BridgeCommands
- status(CommandSender, TunnelSnapshot, BridgeSettings) - Method in class dev.despical.portbridge.command.ChatUI
- stop() - Method in class dev.despical.portbridge.tunnel.TunnelService
- stop(CommandSender) - Method in class dev.despical.portbridge.command.BridgeCommands
- stopped() - Static method in record class dev.despical.portbridge.tunnel.TunnelSnapshot
- STOPPED - Enum constant in enum class dev.despical.portbridge.tunnel.TunnelState
- stopTunnel() - Method in class dev.despical.portbridge.PortBridgePlugin
T
- timeoutSeconds() - Method in record class dev.despical.portbridge.config.BridgeSettings.Health
-
Returns the value of the
timeoutSecondsrecord component. - toString() - Method in record class dev.despical.portbridge.config.BridgeSettings.Binary
-
Returns a string representation of this record class.
- toString() - Method in record class dev.despical.portbridge.config.BridgeSettings.Health
-
Returns a string representation of this record class.
- toString() - Method in record class dev.despical.portbridge.config.BridgeSettings.Local
-
Returns a string representation of this record class.
- toString() - Method in record class dev.despical.portbridge.config.BridgeSettings.Reconnect
-
Returns a string representation of this record class.
- toString() - Method in record class dev.despical.portbridge.config.BridgeSettings.Relay
-
Returns a string representation of this record class.
- toString() - Method in record class dev.despical.portbridge.config.BridgeSettings.Startup
-
Returns a string representation of this record class.
- toString() - Method in record class dev.despical.portbridge.config.BridgeSettings
-
Returns a string representation of this record class.
- toString() - Method in record class dev.despical.portbridge.config.Messages.Appearance
-
Returns a string representation of this record class.
- toString() - Method in record class dev.despical.portbridge.tunnel.TunnelSnapshot
-
Returns a string representation of this record class.
- TunnelService - Class in dev.despical.portbridge.tunnel
-
Owns one native Bore client and serializes its asynchronous lifecycle.
- TunnelService(BoreInstaller, BridgeSettings, Logger, Consumer, BiFunction) - Constructor for class dev.despical.portbridge.tunnel.TunnelService
- TunnelSnapshot - Record Class in dev.despical.portbridge.tunnel
-
Provides an immutable view of the current tunnel for commands and notifications.
- TunnelSnapshot(TunnelState, String, String, Instant, int, Instant, long, String, String) - Constructor for record class dev.despical.portbridge.tunnel.TunnelSnapshot
-
Creates an instance of a
TunnelSnapshotrecord class. - TunnelState - Enum Class in dev.despical.portbridge.tunnel
-
Describes preparation, connection, route health and terminal tunnel states.
V
- valueOf(String) - Static method in enum class dev.despical.portbridge.tunnel.TunnelState
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class dev.despical.portbridge.tunnel.TunnelState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VERSION - Static variable in class dev.despical.portbridge.bore.BoreInstaller
- view() - Method in class dev.despical.portbridge.config.Messages
All Classes and Interfaces|All Packages|Constant Field Values