Package org.apache.qpid.protonj2.engine

Interface EngineConfiguration

All Known Implementing Classes:
ProtonEngineConfiguration
public interface EngineConfiguration
Configuration options for the Engine

  • Method Details

    • setBufferAllocator

      EngineConfiguration setBufferAllocator(ProtonBufferAllocator allocator)
      Sets the ProtonBufferAllocator used by this Engine.

      When copying data, encoding types or otherwise needing to allocate memory storage the Engine will use the assigned ProtonBufferAllocator. If no allocator is assigned the Engine will use the default allocator.

      Parameters:
      allocator - The Allocator instance to use from this Engine.
      Returns:
      this EngineConfiguration for chaining.

    • getBufferAllocator

      ProtonBufferAllocator getBufferAllocator()
      Returns the currently assigned ProtonBufferAllocator.
      Returns:
      the currently assigned ProtonBufferAllocator

    • setTraceFrames

      EngineConfiguration setTraceFrames(boolean traceFrames)
      Enables AMQP frame tracing from engine to the system output. Depending on the underlying engine composition frame tracing may not be possible in which case this method will have no effect and the access method isTraceFrames() will return false.
      Parameters:
      traceFrames - true to enable engine frame tracing, false to disable it.
      Returns:
      this EngineConfiguration for chaining.

    • isTraceFrames

      boolean isTraceFrames()
      Returns true if the engine will emit frames to system output.
      Returns:
      true if the engine will emit frames to system output

    • setMaxTransfersPerDelivery

      default EngineConfiguration setMaxTransfersPerDelivery(int maxTransfers)
      Sets the configured maximum number of Transfer frames that can make up a single completed delivery. If the delivery is not completed within this number of transfer frames the engine may either close the associated link or the connection in its entirety. An engine implementation may opt not to implement this feature in which case the value should be fixed at zero and any assignment should be ignored. If the value is configured as zero then the behavior should be to treat that as no limit was assigned.
      Parameters:
      maxTransfers - The maximum number of Transfers allowed for a single inbound delivery.
      Returns:
      this EngineConfiguration for chaining.

    • getMaxTransfersPerDelivery

      default int getMaxTransfersPerDelivery()
      Returns the maximum number of Transfer frames allowed for a single Delivery.
      Returns:
      the maximum number of Transfer frames allowed for a single Delivery