Package com.btcvelocity.api.bridge

Interface BridgeChannel

public interface BridgeChannel
Service for sending and receiving btc:bridge messages between the proxy and its backend servers.

The bridge channel uses the btc:bridge plugin-messaging identifier. Outgoing messages are encoded by BridgeCodec and forwarded to the target RegisteredServer. Incoming messages from a backend are decoded and dispatched to every registered BridgeMessageListener.

  • Field Details

  • Method Details

    • sendToServer

      void sendToServer(String serverName, BridgeMessage message)
      Sends a bridge message to the named backend server.

      If no server with the given name is registered, the message is silently dropped.

      Parameters:
      serverName - the name of the target server
      message - the message to send

    • sendToServer

      void sendToServer(RegisteredServer server, BridgeMessage message)
      Sends a bridge message to the given backend server.
      Parameters:
      server - the target server
      message - the message to send

    • registerListener

      void registerListener(BridgeMessageListener listener)
      Registers a listener that will be notified of every incoming bridge message.
      Parameters:
      listener - the listener to register

    • unregisterListener

      void unregisterListener(BridgeMessageListener listener)
      Removes a previously registered listener. Has no effect if the listener was not registered.
      Parameters:
      listener - the listener to remove