org.agrona.nio

Class NioSelectedKeySet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<SelectionKey>

org.agrona.nio.NioSelectedKeySet

All Implemented Interfaces:

Iterable<SelectionKey>, Collection<SelectionKey>, Set<SelectionKey>

public class NioSelectedKeySet
extends AbstractSet<SelectionKey>

Try to fix handling of HashSet for Selector to avoid excessive allocation. Assumes single threaded usage.

Constructor Summary

Constructors

Constructor and Description
NioSelectedKeySet() Construct a key set with default capacity
NioSelectedKeySet(int initialCapacity) Construct a key set with the given capacity.

Method Summary

Modifier and Type	Method and Description
boolean	add(SelectionKey selectionKey)
int	capacity() Capacity of the current set.
void	clear() Null out the keys and set size to 0.
boolean	contains(Object o)
int	forEach(ToIntFunction<SelectionKey> function) Iterate over the key set and apply a given function.
boolean	isEmpty()
Iterator<SelectionKey>	iterator()
SelectionKey[]	keys() Return selected keys for direct processing which is valid up to size() index.
boolean	remove(Object o)
void	reset() Reset for next iteration.
void	reset(int skipCount) Reset for next iteration, having only processed a subset of the selection keys.
int	size()

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

addAll, containsAll, retainAll, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

NioSelectedKeySet

public NioSelectedKeySet()

Construct a key set with default capacity

NioSelectedKeySet

public NioSelectedKeySet(int initialCapacity)

Construct a key set with the given capacity.

Parameters:

initialCapacity - for the key set

Method Detail

size

public int size()

Specified by:

size in interface Collection<SelectionKey>

Specified by:

size in interface Set<SelectionKey>

Specified by:

size in class AbstractCollection<SelectionKey>

capacity

public int capacity()

Capacity of the current set.

Returns:

capacity of the set.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<SelectionKey>

Specified by:

isEmpty in interface Set<SelectionKey>

Overrides:

isEmpty in class AbstractCollection<SelectionKey>

add

public boolean add(SelectionKey selectionKey)

Specified by:

add in interface Collection<SelectionKey>

Specified by:

add in interface Set<SelectionKey>

Overrides:

add in class AbstractCollection<SelectionKey>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<SelectionKey>

Specified by:

remove in interface Set<SelectionKey>

Overrides:

remove in class AbstractCollection<SelectionKey>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<SelectionKey>

Specified by:

contains in interface Set<SelectionKey>

Overrides:

contains in class AbstractCollection<SelectionKey>

keys

public SelectionKey[] keys()

Return selected keys for direct processing which is valid up to size() index.

Returns:

selected keys for direct processing which is valid up to size() index.

reset

public void reset()

Reset for next iteration.

clear

public void clear()

Null out the keys and set size to 0.

Specified by:

clear in interface Collection<SelectionKey>

Specified by:

clear in interface Set<SelectionKey>

Overrides:

clear in class AbstractCollection<SelectionKey>

reset

public void reset(int skipCount)

Reset for next iteration, having only processed a subset of the selection keys.

The NioSelectedKeySet will still contain the keys representing IO events after the skip Count have been removed, the remaining events can be processed in a future iteration.

Parameters:

skipCount - the number of keys to be skipped over that have already been processed.

forEach

public int forEach(ToIntFunction<SelectionKey> function)

Iterate over the key set and apply a given function.

Parameters:

function - to apply to each SelectionKey

Returns:

number of handled frames.

iterator

public Iterator<SelectionKey> iterator()

Specified by:

iterator in interface Iterable<SelectionKey>

Specified by:

iterator in interface Collection<SelectionKey>

Specified by:

iterator in interface Set<SelectionKey>

Specified by:

iterator in class AbstractCollection<SelectionKey>