BlockGuard (RoboVM Runtime Library 2.3.18 API)

java.lang.Object

dalvik.system.BlockGuard

public final class BlockGuard
extends Object

Mechanism to let threads set restrictions on what code is allowed to do in their thread.

This is meant for applications to prevent certain blocking operations from running on their main event loop (or "UI") threads.

Note that this is all best-effort to catch most accidental mistakes and isn't intended to be a perfect mechanism, nor provide any sort of security.

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class BlockGuard.BlockGuardPolicyException

static interface BlockGuard.Policy

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`DISALLOW_DISK_READ`
`static int`	`DISALLOW_DISK_WRITE`
`static int`	`DISALLOW_NETWORK`
`static BlockGuard.Policy`	`LAX_POLICY`	The default, permissive policy that doesn't prevent any operations.
`static int`	`PASS_RESTRICTIONS_VIA_RPC`
`static int`	`PENALTY_DEATH`
`static int`	`PENALTY_DIALOG`
`static int`	`PENALTY_LOG`

Method Summary

Modifier and Type	Method	Description
`static BlockGuard.Policy`	`getThreadPolicy()`	Get the current thread's policy.
`static void`	`setThreadPolicy(BlockGuard.Policy policy)`	Sets the current thread's block guard policy.

Methods inherited from class java.lang.Object

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

Field Details
- DISALLOW_DISK_WRITE
  
  public static final int DISALLOW_DISK_WRITE
  
  See Also:
  
  Constant Field Values
- DISALLOW_DISK_READ
  
  public static final int DISALLOW_DISK_READ
  
  See Also:
  
  Constant Field Values
- DISALLOW_NETWORK
  
  public static final int DISALLOW_NETWORK
  
  See Also:
  
  Constant Field Values
- PASS_RESTRICTIONS_VIA_RPC
  
  public static final int PASS_RESTRICTIONS_VIA_RPC
  
  See Also:
  
  Constant Field Values
- PENALTY_LOG
  
  public static final int PENALTY_LOG
  
  See Also:
  
  Constant Field Values
- PENALTY_DIALOG
  
  public static final int PENALTY_DIALOG
  
  See Also:
  
  Constant Field Values
- PENALTY_DEATH
  
  public static final int PENALTY_DEATH
  
  See Also:
  
  Constant Field Values
- LAX_POLICY
  
  public static final BlockGuard.Policy LAX_POLICY
  
  The default, permissive policy that doesn't prevent any operations.
Method Details
- getThreadPolicy
  
  public static BlockGuard.Policy getThreadPolicy()
  
  Get the current thread's policy.
  
  Returns:
  
  the current thread's policy. Never returns null. Will return the LAX_POLICY instance if nothing else is set.
- setThreadPolicy
  
  public static void setThreadPolicy(BlockGuard.Policy policy)
  
  Sets the current thread's block guard policy.
  
  Parameters:
  
  policy - policy to set. May not be null. Use the public LAX_POLICY if you want to unset the active policy.