org.apache.camel.component.disruptor

Class DisruptorEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.disruptor.DisruptorEndpoint

All Implemented Interfaces:

org.apache.camel.AsyncEndpoint, org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.MultipleConsumersSupport, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@ManagedResource(description="Managed Disruptor Endpoint")
 @UriEndpoint(firstVersion="2.12.0",
             scheme="disruptor,disruptor-vm",
             title="Disruptor,Disruptor VM",
             syntax="disruptor:name",
             consumerClass=DisruptorConsumer.class,
             label="endpoint")
public class DisruptorEndpoint
extends org.apache.camel.impl.DefaultEndpoint
implements org.apache.camel.AsyncEndpoint, org.apache.camel.MultipleConsumersSupport

The disruptor component provides asynchronous SEDA behavior using LMAX Disruptor. This component works much as the standard SEDA Component, but utilizes a Disruptor instead of a BlockingQueue utilized by the standard SEDA.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISRUPTOR_IGNORE_EXCHANGE

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
DisruptorEndpoint(String endpointUri, org.apache.camel.Component component, DisruptorReference disruptorReference, int concurrentConsumers, boolean multipleConsumers, boolean blockWhenFull)

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Producer	createProducer()
protected void	doShutdown()
protected void	doStart()
protected void	doStop()
boolean	equals(Object object)
int	getBufferSize()
DisruptorComponent	getComponent()
int	getConcurrentConsumers() Number of concurrent threads processing exchanges.
Set<DisruptorConsumer>	getConsumers() Returns the current active consumers on this endpoint
String	getName()
long	getPendingExchangeCount()
Set<DisruptorProducer>	getProducers() Returns the current active producers on this endpoint
DisruptorProducerType	getProducerType()
long	getRemainingCapacity()
int	getSize()
long	getTimeout()
org.apache.camel.WaitForTaskToComplete	getWaitForTaskToComplete()
DisruptorWaitStrategy	getWaitStrategy()
int	hashCode()
boolean	isBlockWhenFull()
boolean	isMultipleConsumers() Specifies whether multiple consumers are allowed.
boolean	isMultipleConsumersSupported()
boolean	isSingleton()
void	setBlockWhenFull(boolean blockWhenFull) Whether a thread that sends messages to a full Disruptor will block until the ringbuffer's capacity is no longer exhausted.
void	setProducerType(DisruptorProducerType producerType) Defines the producers allowed on the Disruptor.
void	setSize(int size) The maximum capacity of the Disruptors ringbuffer Will be effectively increased to the nearest power of two.
void	setTimeout(long timeout) Timeout (in milliseconds) before a producer will stop waiting for an asynchronous task to complete.
void	setWaitForTaskToComplete(org.apache.camel.WaitForTaskToComplete waitForTaskToComplete) Option to specify whether the caller should wait for the async task to complete or not before continuing.
void	setWaitStrategy(DisruptorWaitStrategy waitStrategy) Defines the strategy used by consumer threads to wait on new exchanges to be published.

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, getCamelContext, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Endpoint

configureProperties, createExchange, createExchange, createExchange, createPollingConsumer, getCamelContext, getEndpointConfiguration, getEndpointKey, getEndpointUri, isLenientProperties, setCamelContext

Methods inherited from interface org.apache.camel.Service

start, stop

Field Detail

DISRUPTOR_IGNORE_EXCHANGE

public static final String DISRUPTOR_IGNORE_EXCHANGE

See Also:

Constant Field Values

Constructor Detail

DisruptorEndpoint

public DisruptorEndpoint(String endpointUri,
                         org.apache.camel.Component component,
                         DisruptorReference disruptorReference,
                         int concurrentConsumers,
                         boolean multipleConsumers,
                         boolean blockWhenFull)
                  throws Exception

Throws:

Exception

Method Detail

getName

@ManagedAttribute(description="Queue name")
public String getName()

getBufferSize

@ManagedAttribute(description="Buffer max capacity")
public int getBufferSize()

getRemainingCapacity

@ManagedAttribute(description="Remaining capacity in ring buffer")
public long getRemainingCapacity()
                                                                                             throws DisruptorNotStartedException

Throws:

DisruptorNotStartedException

getPendingExchangeCount

@ManagedAttribute(description="Amount of pending exchanges waiting for consumption in ring buffer")
public long getPendingExchangeCount()
                                                                                                                                 throws DisruptorNotStartedException

Throws:

DisruptorNotStartedException

getConcurrentConsumers

@ManagedAttribute(description="Number of concurrent consumers")
public int getConcurrentConsumers()

Number of concurrent threads processing exchanges.

getWaitForTaskToComplete

@ManagedAttribute(description="Option to specify whether the caller should wait for the async task to complete or not before continuing")
public org.apache.camel.WaitForTaskToComplete getWaitForTaskToComplete()

setWaitForTaskToComplete

public void setWaitForTaskToComplete(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.

getTimeout

@ManagedAttribute(description="Timeout (in milliseconds) before a producer will stop waiting for an asynchronous task to complete")
public long getTimeout()

setTimeout

public void setTimeout(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.

getSize

@ManagedAttribute(description="The maximum capacity of the Disruptors ringbuffer")
public int getSize()

setSize

public void setSize(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.

isMultipleConsumersSupported

@ManagedAttribute(description="Specifies whether multiple consumers are allowed")
public boolean isMultipleConsumersSupported()

Specified by:

isMultipleConsumersSupported in interface org.apache.camel.MultipleConsumersSupport

isMultipleConsumers

public boolean isMultipleConsumers()

Specifies whether multiple consumers are allowed. If enabled, you can use Disruptor for Publish-Subscribe messaging. That is, you can send a message to the queue and have each consumer receive a copy of the message. When enabled, this option should be specified on every consumer endpoint.

getConsumers

public Set<DisruptorConsumer> getConsumers()

Returns the current active consumers on this endpoint

getProducers

public Set<DisruptorProducer> getProducers()

Returns the current active producers on this endpoint

isBlockWhenFull

@ManagedAttribute
public boolean isBlockWhenFull()

setBlockWhenFull

public void setBlockWhenFull(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.

getWaitStrategy

@ManagedAttribute(description="Defines the strategy used by consumer threads to wait on new exchanges to be published")
public DisruptorWaitStrategy getWaitStrategy()

setWaitStrategy

public void setWaitStrategy(DisruptorWaitStrategy waitStrategy)

Defines the strategy used by consumer threads to wait on new exchanges to be published. The options allowed are:Blocking, Sleeping, BusySpin and Yielding.

getProducerType

@ManagedAttribute(description=" Defines the producers allowed on the Disruptor")
public DisruptorProducerType getProducerType()

setProducerType

public void setProducerType(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.

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.apache.camel.IsSingleton

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Specified by:

createProducer in interface org.apache.camel.Endpoint

Throws:

Exception

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Specified by:

createConsumer in interface org.apache.camel.Endpoint

Throws:

Exception

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class org.apache.camel.impl.DefaultEndpoint

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class org.apache.camel.impl.DefaultEndpoint

Throws:

Exception

doShutdown

protected void doShutdown()
                   throws Exception

Overrides:

doShutdown in class org.apache.camel.support.ServiceSupport

Throws:

Exception

getComponent

public DisruptorComponent getComponent()

Overrides:

getComponent in class org.apache.camel.impl.DefaultEndpoint

equals

public boolean equals(Object object)

Overrides:

equals in class org.apache.camel.impl.DefaultEndpoint

hashCode

public int hashCode()

Overrides:

hashCode in class org.apache.camel.impl.DefaultEndpoint