Package org.apache.camel.builder.endpoint.dsl

Interface DisruptorEndpointBuilderFactory.DisruptorEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    DisruptorEndpointBuilderFactory.DisruptorEndpointBuilder
    Enclosing interface:
    DisruptorEndpointBuilderFactory
    public static interface DisruptorEndpointBuilderFactory.DisruptorEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the Disruptor component.

    • Method Detail

      • size

        default DisruptorEndpointBuilderFactory.DisruptorEndpointProducerBuilder size​(int size)
        The maximum capacity of the Disruptors ringbuffer Will be effectively increased to the nearest power of two. Notice: Mind if you use this option, then its the first endpoint being created with the queue name, that determines the size. To make sure all endpoints use same size, then configure the size option on all of them, or the first endpoint being created. The option is a: <code>int</code> type. Default: 1024 Group: common
        Parameters:
        size - the value to set
        Returns:
        the dsl builder

      • size

        default DisruptorEndpointBuilderFactory.DisruptorEndpointProducerBuilder size​(String size)
        The maximum capacity of the Disruptors ringbuffer Will be effectively increased to the nearest power of two. Notice: Mind if you use this option, then its the first endpoint being created with the queue name, that determines the size. To make sure all endpoints use same size, then configure the size option on all of them, or the first endpoint being created. The option will be converted to a <code>int</code> type. Default: 1024 Group: common
        Parameters:
        size - the value to set
        Returns:
        the dsl builder

      • blockWhenFull

        default DisruptorEndpointBuilderFactory.DisruptorEndpointProducerBuilder blockWhenFull​(boolean blockWhenFull)
        Whether a thread that sends messages to a full Disruptor will block until the ringbuffer's capacity is no longer exhausted. By default, the calling thread will block and wait until the message can be accepted. By disabling this option, an exception will be thrown stating that the queue is full. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        blockWhenFull - the value to set
        Returns:
        the dsl builder

      • blockWhenFull

        default DisruptorEndpointBuilderFactory.DisruptorEndpointProducerBuilder blockWhenFull​(String blockWhenFull)
        Whether a thread that sends messages to a full Disruptor will block until the ringbuffer's capacity is no longer exhausted. By default, the calling thread will block and wait until the message can be accepted. By disabling this option, an exception will be thrown stating that the queue is full. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        blockWhenFull - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default DisruptorEndpointBuilderFactory.DisruptorEndpointProducerBuilder lazyStartProducer​(boolean lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default DisruptorEndpointBuilderFactory.DisruptorEndpointProducerBuilder lazyStartProducer​(String lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • producerType

        default DisruptorEndpointBuilderFactory.DisruptorEndpointProducerBuilder producerType​(DisruptorEndpointBuilderFactory.DisruptorProducerType producerType)
        Defines the producers allowed on the Disruptor. The options allowed are: Multi to allow multiple producers and Single to enable certain optimizations only allowed when one concurrent producer (on one thread or otherwise synchronized) is active. The option is a: <code>org.apache.camel.component.disruptor.DisruptorProducerType</code> type. Default: Multi Group: producer
        Parameters:
        producerType - the value to set
        Returns:
        the dsl builder

      • producerType

        default DisruptorEndpointBuilderFactory.DisruptorEndpointProducerBuilder producerType​(String producerType)
        Defines the producers allowed on the Disruptor. The options allowed are: Multi to allow multiple producers and Single to enable certain optimizations only allowed when one concurrent producer (on one thread or otherwise synchronized) is active. The option will be converted to a <code>org.apache.camel.component.disruptor.DisruptorProducerType</code> type. Default: Multi Group: producer
        Parameters:
        producerType - the value to set
        Returns:
        the dsl builder

      • timeout

        default DisruptorEndpointBuilderFactory.DisruptorEndpointProducerBuilder timeout​(long timeout)
        Timeout (in milliseconds) before a producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value. The option is a: <code>long</code> type. Default: 30000 Group: producer
        Parameters:
        timeout - the value to set
        Returns:
        the dsl builder

      • timeout

        default DisruptorEndpointBuilderFactory.DisruptorEndpointProducerBuilder timeout​(String timeout)
        Timeout (in milliseconds) before a producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value. The option will be converted to a <code>long</code> type. Default: 30000 Group: producer
        Parameters:
        timeout - the value to set
        Returns:
        the dsl builder

      • waitForTaskToComplete

        default DisruptorEndpointBuilderFactory.DisruptorEndpointProducerBuilder waitForTaskToComplete​(org.apache.camel.WaitForTaskToComplete waitForTaskToComplete)
        Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always, Never or IfReplyExpected. The first two values are self-explanatory. The last value, IfReplyExpected, will only wait if the message is Request Reply based. The option is a: <code>org.apache.camel.WaitForTaskToComplete</code> type. Default: IfReplyExpected Group: producer
        Parameters:
        waitForTaskToComplete - the value to set
        Returns:
        the dsl builder

      • waitForTaskToComplete

        default DisruptorEndpointBuilderFactory.DisruptorEndpointProducerBuilder waitForTaskToComplete​(String waitForTaskToComplete)
        Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always, Never or IfReplyExpected. The first two values are self-explanatory. The last value, IfReplyExpected, will only wait if the message is Request Reply based. The option will be converted to a <code>org.apache.camel.WaitForTaskToComplete</code> type. Default: IfReplyExpected Group: producer
        Parameters:
        waitForTaskToComplete - the value to set
        Returns:
        the dsl builder