Package org.apache.qpid.protonj2.engine.impl

Class ProtonEngineConfiguration

java.lang.Object
org.apache.qpid.protonj2.engine.impl.ProtonEngineConfiguration
All Implemented Interfaces:
EngineConfiguration
public class ProtonEngineConfiguration extends Object implements EngineConfiguration
Proton engine configuration API

  • Field Details

    • DEFAULT_MAX_TRANSFERS_PER_DELIVERY

      public static final int DEFAULT_MAX_TRANSFERS_PER_DELIVERY
      Engine defined default value for the limit on Transfer frames per Delivery

  • Method Details

    • getBufferAllocator

      public ProtonBufferAllocator getBufferAllocator()
      Description copied from interface: EngineConfiguration
      Returns the currently assigned ProtonBufferAllocator.
      Specified by:
      getBufferAllocator in interface EngineConfiguration
      Returns:
      the currently assigned ProtonBufferAllocator

    • setBufferAllocator

      public ProtonEngineConfiguration setBufferAllocator(ProtonBufferAllocator allocator)
      Description copied from interface: EngineConfiguration
      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.

      Specified by:
      setBufferAllocator in interface EngineConfiguration
      Parameters:
      allocator - The Allocator instance to use from this Engine.
      Returns:
      this EngineConfiguration for chaining.

    • setTraceFrames

      public EngineConfiguration setTraceFrames(boolean traceFrames)
      Description copied from interface: EngineConfiguration
      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 EngineConfiguration.isTraceFrames() will return false.
      Specified by:
      setTraceFrames in interface EngineConfiguration
      Parameters:
      traceFrames - true to enable engine frame tracing, false to disable it.
      Returns:
      this EngineConfiguration for chaining.

    • isTraceFrames

      public boolean isTraceFrames()
      Description copied from interface: EngineConfiguration
      Returns true if the engine will emit frames to system output.
      Specified by:
      isTraceFrames in interface EngineConfiguration
      Returns:
      true if the engine will emit frames to system output

    • setMaxTransfersPerDelivery

      public EngineConfiguration setMaxTransfersPerDelivery(int maxTransfers)
      Description copied from interface: EngineConfiguration
      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.
      Specified by:
      setMaxTransfersPerDelivery in interface EngineConfiguration
      Parameters:
      maxTransfers - The maximum number of Transfers allowed for a single inbound delivery.
      Returns:
      this EngineConfiguration for chaining.

    • getMaxTransfersPerDelivery

      public int getMaxTransfersPerDelivery()
      Description copied from interface: EngineConfiguration
      Returns the maximum number of Transfer frames allowed for a single Delivery.
      Specified by:
      getMaxTransfersPerDelivery in interface EngineConfiguration
      Returns:
      the maximum number of Transfer frames allowed for a single Delivery