Throttle

Table of Contents

Usage
Properties

Controls the rate at which messages are passed to the next node in the route

Usage

The Throttle pattern controls the flow of messages from one step in the route to the next.

The Throttle pattern can appear anywhere in the body of a route.

Properties

Table 71, “Throttle Properties” describes the properties you can specify using the properties editor.

Table 71. Throttle Properties

NameDescription

Language

Specifies the language to use to process the expression.

Async Delayed

Specifies whether processing tasks will be scheduled for processing at a later time. The default is Disabled.

Caller Runs When Rejected

Specifies whether tasks rejected by the thread pool are executed by the calling thread. The default is Disabled.

Description

Specifies a text description for the node. This description is included in the generated XML file, but it is informational only. It is not used by Apache Camel.

Executor Service Ref

Specifies a reference for looking up the executorService to use for thread pool management.

Id

Specifies a unique identifier for the endpoint.

The tooling automatically generates an id for a node when it is created, but you can remove that id or replace it with your own. The Camel debugger requires all nodes with a breakpoint set to have a unique id.

You can use the id to refer to endpoints in your Camel XML file.

Reject Execution

Specifies whether the throttler throws a ThrottlerRejectExecutionException when the request rate exceeds the limit.

Time Period Millis

Specifies the time period, in milliseconds, used by the throttler. The default is 1000 milliseconds.