Repository: camel Updated Branches: refs/heads/master e5bf8b72b -> fd256485d
Added VM component docs to Gitbook Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/49b843fd Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/49b843fd Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/49b843fd Branch: refs/heads/master Commit: 49b843fd77d913b93f7ea7dbdbf8a9bbfe817fb5 Parents: e5bf8b7 Author: Andrea Cosentino <[email protected]> Authored: Thu Jun 23 10:33:51 2016 +0200 Committer: Andrea Cosentino <[email protected]> Committed: Thu Jun 23 10:33:51 2016 +0200 ---------------------------------------------------------------------- camel-core/src/main/docs/vm.adoc | 147 ++++++++++++++++++++++++++++++++++ docs/user-manual/en/SUMMARY.md | 1 + 2 files changed, 148 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/49b843fd/camel-core/src/main/docs/vm.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/vm.adoc b/camel-core/src/main/docs/vm.adoc new file mode 100644 index 0000000..c53a717 --- /dev/null +++ b/camel-core/src/main/docs/vm.adoc @@ -0,0 +1,147 @@ +[[VM-VMComponent]] +VM Component +~~~~~~~~~~~~ + +The *vm:* component provides asynchronous +http://www.eecs.harvard.edu/~mdw/proj/seda/[SEDA] behavior, exchanging +messages on a +http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/BlockingQueue.html[BlockingQueue] +and invoking consumers in a separate thread pool. + +This component differs from the link:seda.html[Seda] component in that +VM supports communication across CamelContext instances - so you can use +this mechanism to communicate across web applications (provided that +`camel-core.jar` is on the `system/boot` classpath). + +VM is an extension to the link:seda.html[Seda] component. + +[[VM-URIformat]] +URI format +^^^^^^^^^^ + +[source,java] +---------------------- +vm:queueName[?options] +---------------------- + +Where *`queueName`* can be any string to uniquely identify the endpoint +within the JVM (or at least within the classloader that loaded +camel-core.jar) + +You can append query options to the URI in the following format: +`?option=value&option=value&...` + +*Before Camel 2.3 - Same URI must be used for both producer and +consumer* + +An exactly identical link:vm.html[VM] endpoint URI *must* be used for +both the producer and the consumer endpoint. Otherwise, Camel will +create a second link:vm.html[VM] endpoint despite that the `queueName` +portion of the URI is identical. For example: + +[source,java] +--------------------------------------------------------- +from("direct:foo").to("vm:bar?concurrentConsumers=5"); + +from("vm:bar?concurrentConsumers=5").to("file://output"); +--------------------------------------------------------- + +Notice that we have to use the full URI, including options in both the +producer and consumer. + +In Camel 2.4 this has been fixed so that only the queue name must match. +Using the queue name `bar`, we could rewrite the previous exmple as +follows: + +[source,java] +--------------------------------------------------------- +from("direct:foo").to("vm:bar"); + +from("vm:bar?concurrentConsumers=5").to("file://output"); +--------------------------------------------------------- + +[[VM-Options]] +Options +^^^^^^^ + + +// component options: START +The VM component supports 3 options which are listed below. + + + +{% raw %} +[width="100%",cols="2s,1m,8",options="header"] +|======================================================================= +| Name | Java Type | Description +| queueSize | int | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold). +| concurrentConsumers | int | Sets the default number of concurrent threads processing exchanges. +| defaultQueueFactory | Exchange> | Sets the default queue factory. +|======================================================================= +{% endraw %} +// component options: END + + + +// endpoint options: START +The VM component supports 17 endpoint options which are listed below: + +{% raw %} +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| name | common | | String | *Required* Name of queue +| size | common | 2147483647 | int | The maximum capacity of the SEDA queue (i.e. the number of messages it can hold). +| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. +| concurrentConsumers | consumer | 1 | int | Number of concurrent threads processing exchanges. +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. +| limitConcurrentConsumers | consumer (advanced) | true | boolean | Whether to limit the number of concurrentConsumers to the maximum of 500. By default an exception will be thrown if an endpoint is configured with a greater number. You can disable that check by turning this option off. +| multipleConsumers | consumer (advanced) | false | boolean | Specifies whether multiple consumers are allowed. If enabled you can use SEDA for Publish-Subscribe messaging. That is you can send a message to the SEDA queue and have each consumer receive a copy of the message. When enabled this option should be specified on every consumer endpoint. +| pollTimeout | consumer (advanced) | 1000 | int | The timeout used when polling. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. +| purgeWhenStopping | consumer (advanced) | false | boolean | Whether to purge the task queue when stopping the consumer/route. This allows to stop faster as any pending messages on the queue is discarded. +| blockWhenFull | producer | false | boolean | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default an exception will be thrown stating that the queue is full. By enabling this option the calling thread will instead block and wait until the message can be accepted. +| discardIfNoConsumers | producer | false | boolean | Whether the producer should discard the message (do not add the message to the queue) when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time. +| failIfNoConsumers | producer | false | boolean | Whether the producer should fail by throwing an exception when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time. +| timeout | producer | 30000 | long | Timeout (in milliseconds) before a SEDA producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value. +| waitForTaskToComplete | producer | IfReplyExpected | 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 default option is IfReplyExpected. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange. +| queue | advanced | | BlockingQueue | Define the queue instance which will be used by the endpoint. This option is only for rare use-cases where you want to use a custom queue instance. +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +|======================================================================= +{% endraw %} +// endpoint options: END + + +See the link:seda.html[Seda] component for options and other important +usage details as the same rules apply to the link:vm.html[Vm] component. + +[[VM-Samples]] +Samples +^^^^^^^ + +In the route below we send exchanges across CamelContext instances to a +VM queue named `order.email`: + +[source,java] +--------------------------------------------------------------- +from("direct:in").bean(MyOrderBean.class).to("vm:order.email"); +--------------------------------------------------------------- + +And then we receive exchanges in some other Camel context (such as +deployed in another `.war` application): + +[source,java] +------------------------------------------------------ +from("vm:order.email").bean(MyOrderEmailSender.class); +------------------------------------------------------ + +[[VM-SeeAlso]] +See Also +^^^^^^^^ + +* link:configuring-camel.html[Configuring Camel] +* link:component.html[Component] +* link:endpoint.html[Endpoint] +* link:getting-started.html[Getting Started] +* link:seda.html[Seda] + http://git-wip-us.apache.org/repos/asf/camel/blob/49b843fd/docs/user-manual/en/SUMMARY.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index 0359a65..b06a254 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -96,6 +96,7 @@ * [Test](test.adoc) * [Timer](timer.adoc) * [Validator](validator.adoc) + * [VM](vm.adoc) * Components * [Async Http Client (AHC)](ahc.adoc)
