co.paralleluniverse.strands.channels

Enum Channels.OverflowPolicy

java.lang.Object

java.lang.Enum<Channels.OverflowPolicy>

co.paralleluniverse.strands.channels.Channels.OverflowPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Channels.OverflowPolicy>

Enclosing class:

Channels

public static enum Channels.OverflowPolicy
extends java.lang.Enum<Channels.OverflowPolicy>

Determines how a channel behaves when its internal buffer (if it has one) overflows.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACKOFF The sender will block for some time, and retry.
BLOCK The sender will block until there's a vacancy in the channel.
DISPLACE The oldest message in the queue will be removed to make room for the new message.
DROP The message will be silently dropped.
THROW The sender will get an exception (except if the channel is an actor's mailbox)

Method Summary

Modifier and Type	Method and Description
static Channels.OverflowPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Channels.OverflowPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

THROW

public static final Channels.OverflowPolicy THROW

The sender will get an exception (except if the channel is an actor's mailbox)

DROP

public static final Channels.OverflowPolicy DROP

The message will be silently dropped.

BLOCK

public static final Channels.OverflowPolicy BLOCK

The sender will block until there's a vacancy in the channel.

BACKOFF

public static final Channels.OverflowPolicy BACKOFF

The sender will block for some time, and retry.

DISPLACE

public static final Channels.OverflowPolicy DISPLACE

The oldest message in the queue will be removed to make room for the new message.

Method Detail

values

public static Channels.OverflowPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Channels.OverflowPolicy c : Channels.OverflowPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Channels.OverflowPolicy valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null