Package reactor.blockhound

Class BlockHound

java.lang.Object

reactor.blockhound.BlockHound

public class BlockHound
extends Object

BlockHound is a tool to detect blocking calls from non-blocking threads. To use it, you need to "install" it first with either install(BlockHoundIntegration...) or builder(). On installation, it will run the instrumentation and add the check to the blocking methods. Note that the installation can (and should) only be done once, subsequent install calls will be ignored. Hence, the best place to put the install call is before all tests or in the beginning of your "public static void main" method. If you have it automatically installed (e.g. via a testing framework integration), you can apply the customizations by using the SPI mechanism (see BlockHoundIntegration).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BlockHound.Builder

Method Summary

Modifier and Type	Method	Description
static BlockHound.Builder	builder()	Creates a completely new BlockHound.Builder that *does not* have any integration applied.
static void	install(BlockHoundIntegration... integrations)	Loads integrations with ServiceLoader, adds provided integrations, and installs the BlockHound instrumentation.
static void	premain(String agentArgs, Instrumentation inst)	Entrypoint for installation via the -javaagent= command-line option.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static BlockHound.Builder builder()

Creates a completely new BlockHound.Builder that *does not* have any integration applied. Use it only if you want to ignore the built-in SPI mechanism (see install(BlockHoundIntegration...)).

Returns:

a fresh BlockHound.Builder

See Also:

• install(BlockHoundIntegration...)

install

public static void install(BlockHoundIntegration... integrations)

Loads integrations with ServiceLoader, adds provided integrations, and installs the BlockHound instrumentation. If you don't want to load the integrations, use builder() method.

Parameters:

integrations - an array of integrations to automatically apply on the intermediate builder

See Also:

• builder()

premain

public static void premain(String agentArgs,
 Instrumentation inst)

Entrypoint for installation via the -javaagent= command-line option.

Parameters:

agentArgs - Options for the agent.

inst - Instrumentation API.

See Also:

• java.lang.instrument