OneToOneConcurrentArrayQueue (Agrona)

java.lang.Object
- org.agrona.concurrent.AbstractConcurrentArrayQueue<E>
- - org.agrona.concurrent.OneToOneConcurrentArrayQueue<E>

Type Parameters:

E - type of the elements stored in the Queue.

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.Queue<E>, Pipe<E>, QueuedPipe<E>
```
public class OneToOneConcurrentArrayQueue<E>
extends AbstractConcurrentArrayQueue<E>
```
One producer to one consumer concurrent queue that is array backed. The algorithm is a variation of Fast Flow adapted to work with the Java Memory Model on arrays by using Unsafe.

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`head`
`protected long`	`headCache`
`protected long`	`p1`
`protected long`	`p10`
`protected long`	`p11`
`protected long`	`p12`
`protected long`	`p13`
`protected long`	`p14`
`protected long`	`p15`
`protected long`	`p16`
`protected long`	`p17`
`protected long`	`p18`
`protected long`	`p19`
`protected long`	`p2`
`protected long`	`p20`
`protected long`	`p21`
`protected long`	`p22`
`protected long`	`p23`
`protected long`	`p24`
`protected long`	`p25`
`protected long`	`p26`
`protected long`	`p27`
`protected long`	`p28`
`protected long`	`p29`
`protected long`	`p3`
`protected long`	`p30`
`protected long`	`p31`
`protected long`	`p32`
`protected long`	`p33`
`protected long`	`p34`
`protected long`	`p35`
`protected long`	`p36`
`protected long`	`p37`
`protected long`	`p38`
`protected long`	`p39`
`protected long`	`p4`
`protected long`	`p40`
`protected long`	`p41`
`protected long`	`p42`
`protected long`	`p43`
`protected long`	`p44`
`protected long`	`p45`
`protected long`	`p5`
`protected long`	`p6`
`protected long`	`p7`
`protected long`	`p8`
`protected long`	`p9`
`protected long`	`sharedHeadCache`
`protected long`	`tail`

Fields inherited from class org.agrona.concurrent.AbstractConcurrentArrayQueue
buffer, BUFFER_ARRAY_BASE, capacity, HEAD_OFFSET, SHARED_HEAD_CACHE_OFFSET, SHIFT_FOR_SCALE, TAIL_OFFSET

Constructor Summary

Constructors
Constructor and Description

OneToOneConcurrentArrayQueue(int requestedCapacity)

Constructors
Constructor and Description
`OneToOneConcurrentArrayQueue(int requestedCapacity)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`drain(java.util.function.Consumer<E> elementHandler)` Invoke a `Consumer` callback on each elements to drain the collection of elements until it is empty.
`int`	`drainTo(java.util.Collection<? super E> target, int limit)` Drain available elements into the provided `Collection` up to a provided maximum limit of elements.
`boolean`	`offer(E e)`
`E`	`poll()`

Methods inherited from class org.agrona.concurrent.AbstractConcurrentArrayQueue
add, addAll, addedCount, capacity, clear, contains, containsAll, element, isEmpty, iterator, peek, remainingCapacity, remove, remove, removeAll, removedCount, retainAll, sequenceToBufferOffset, size, toArray, toArray

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Collection
equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable
forEach

Field Detail

p31
```
protected long p31
```

p32
```
protected long p32
```

p33
```
protected long p33
```

p34
```
protected long p34
```

p35
```
protected long p35
```

p36
```
protected long p36
```

p37
```
protected long p37
```

p38
```
protected long p38
```

p39
```
protected long p39
```

p40
```
protected long p40
```

p41
```
protected long p41
```

p42
```
protected long p42
```

p43
```
protected long p43
```

p44
```
protected long p44
```

p45
```
protected long p45
```

head
```
protected volatile long head
```

p16
```
protected long p16
```

p17
```
protected long p17
```

p18
```
protected long p18
```

p19
```
protected long p19
```

p20
```
protected long p20
```

p21
```
protected long p21
```

p22
```
protected long p22
```

p23
```
protected long p23
```

p24
```
protected long p24
```

p25
```
protected long p25
```

p26
```
protected long p26
```

p27
```
protected long p27
```

p28
```
protected long p28
```

p29
```
protected long p29
```

p30
```
protected long p30
```

tail
```
protected volatile long tail
```

headCache
```
protected long headCache
```

sharedHeadCache

protected volatile long sharedHeadCache

p1
```
protected long p1
```

p2
```
protected long p2
```

p3
```
protected long p3
```

p4
```
protected long p4
```

p5
```
protected long p5
```

p6
```
protected long p6
```

p7
```
protected long p7
```

p8
```
protected long p8
```

p9
```
protected long p9
```

p10
```
protected long p10
```

p11
```
protected long p11
```

p12
```
protected long p12
```

p13
```
protected long p13
```

p14
```
protected long p14
```

p15
```
protected long p15
```

Constructor Detail

OneToOneConcurrentArrayQueue

public OneToOneConcurrentArrayQueue(int requestedCapacity)

Method Detail
- offer
```
public boolean offer(E e)
```
- poll
```
public E poll()
```
- drain
```
public int drain(java.util.function.Consumer<E> elementHandler)
```
  Description copied from interface: Pipe
  
  Invoke a Consumer callback on each elements to drain the collection of elements until it is empty. If possible, implementations should use smart batching to best handle burst traffic.
  
  Parameters:
  
  elementHandler - to callback for processing elements
  
  Returns:
  
  the number of elements drained
- drainTo
```
public int drainTo(java.util.Collection<? super E> target,
                   int limit)
```
  Description copied from interface: Pipe
  
  Drain available elements into the provided Collection up to a provided maximum limit of elements. If possible, implementations should use smart batching to best handle burst traffic.
  
  Parameters:
  
  target - in to which elements are drained.
  
  limit - of the maximum number of elements to drain.
  
  Returns:
  
  the number of elements actually drained.

Class OneToOneConcurrentArrayQueue<E>

Field Summary

Fields inherited from class org.agrona.concurrent.AbstractConcurrentArrayQueue

Constructor Summary

Method Summary

Methods inherited from class org.agrona.concurrent.AbstractConcurrentArrayQueue

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

p31

p32

p33

p34

p35

p36

p37

p38

p39

p40

p41

p42

p43

p44

p45

head

p16

p17

p18

p19

p20

p21

p22

p23

p24

p25

p26

p27

p28

p29

p30

tail

headCache

sharedHeadCache

p1

p2

p3

p4

p5

p6

p7

p8

p9

p10

p11

p12

p13

p14

p15

Constructor Detail

OneToOneConcurrentArrayQueue

Method Detail

offer

poll

drain

drainTo