Interface IncomingChannel

All Superinterfaces:
AutoCloseable, ChannelConnection
public interface IncomingChannel extends ChannelConnection
Incoming connector for one configured binding.

The messaging runtime invokes run(IncomingConnectorContext) on an owned virtual thread. The connector establishes its transport resources, calls IncomingConnectorContext.awaitRunning(), and starts acquiring deliveries only when that method returns true.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    drain()
    Stop acquiring new transport deliveries while allowing already acquired deliveries to settle.
    void
    run(IncomingConnectorContext context)
    Run this connector until it is drained or closed.

    Methods inherited from interface ChannelConnection

    close, forceClose
    Modifier and Type
    Method
    Description
    void
    close()
    Close this binding after its delivery work has drained.
    void
    forceClose()
    Force prompt shutdown without waiting for normal delivery settlement.

  • Method Details

    • run

      void run(IncomingConnectorContext context)
      Run this connector until it is drained or closed.

      Before acquiring the first delivery, the connector must synchronously establish the transport resources needed to run and call IncomingConnectorContext.awaitRunning(). It must return without acquiring deliveries when that method returns false. Normal return after drain() must include final transport settlement and checkpointing.

      Parameters:
      context - incoming connector context

    • drain

      void drain()
      Stop acquiring new transport deliveries while allowing already acquired deliveries to settle. Once those delivery handoffs finish, run(IncomingConnectorContext) must finish its transport checkpoint and return.