Interface IWSAcceptorManager


public interface IWSAcceptorManager
Provides an optional JVM-wide registry of WebSocket acceptors by route name.

A server integration may use this registry to find an acceptor after a WebSocket upgrade. Other integrations can route through acceptors supplied directly to their upgrade handler, as the Jetty integration does. Registration through the manager rejects a second acceptor with the same name; container ownership remains with the container that activated each acceptor. The live registry is exposed for lookup and can also be mutated directly; direct mutation bypasses the manager's registration checks and lifecycle bookkeeping.

Author:
Eike Stepper
No Implement
This interface is not intended to be implemented by clients.
No Extend
This interface is not intended to be extended by clients.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final IWSAcceptorManager
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Looks up the acceptor registered under a route name.
    org.eclipse.net4j.util.registry.IRegistry<String, IWSAcceptor>
    Returns the live registry available to integrations that use shared route lookup.
  • Field Details

  • Method Details

    • getAcceptorRegistry

      org.eclipse.net4j.util.registry.IRegistry<String, IWSAcceptor> getAcceptorRegistry()
      Returns the live registry available to integrations that use shared route lookup. Its contents are not guaranteed to represent only active acceptors because direct mutations bypass the manager's duplicate-name check and lifecycle bookkeeping; callers should use this method for lookup and use acceptor activation to manage entries.
      Returns:
      the mutable name-to-acceptor registry
    • getAcceptor

      IWSAcceptor getAcceptor(String name)
      Looks up the acceptor registered under a route name. Direct registry mutations can make the result inactive.
      Parameters:
      name - acceptor route name
      Returns:
      the registered acceptor, or null if no acceptor is registered under that name