Throttle

Name:	Throttle
Description:	Throttles requests to allow a configured number to be passed concurrently
Id:	layer1.Concurrency.Throttle
Category:	transparent overlay

Throttle is a transparent overlay. You must instantiate an instance of the overlay from its prototype, this will create a new instance within your application space.

Parameters

The layer1.Concurrency.Throttle prototype has the following initialisation parameters:

Name	Rules	Typing	Default	Description
config	Optional	Identifier or XML	(none)	Configuration for the throttle
space	Mandatory	Space	(none)	A nested space definition which the overlay will delegate all requests in to.

Here is an auto-generated example of how to instantiate an instance of Throttle:

<overlay>
  <prototype>layer1.Concurrency.Throttle</prototype>
  <space>
    <!--wrapped space...-->
  </space>
</overlay>

Import Requirements

To use Throttle transparent overlay you must import the module urn:org:netkernel:ext:layer1:

<import>
  <uri>urn:org:netkernel:ext:layer1</uri>
</import>

Requests pass through the throttle to the wrapped space as long as there are no more than concurrency requests active simultaneously. If a request arrives and there are already concurrency active requests in the wrapped space then the request will be placed in the request queue. When an active request completes then the next waiting request in the queue is allowed to progress to the wrapped space. If a request arrives at the throttle and there are already queue requests in the request queue then the request is reject and will be given a NKFException with "Throttle Overload".

Configuration

Example

An application uses a commercial RDBMS server with strict licensing requirements to not exceed two active requests. To ensure license compliance a throttle overlay is place around the database module.