RingBuffer (Bigbird Framework 1.0.0-SNAPSHOT API)

字段概要

字段
限定符和类型字段和说明

static int DEFAULT_PADDING_PERCENT

字段
限定符和类型	字段和说明
`static int`	`DEFAULT_PADDING_PERCENT`

构造器概要

构造器
构造器和说明
`RingBuffer(int bufferSize)` Constructor with buffer size, paddingFactor default as 50
`RingBuffer(int bufferSize, int paddingFactor)` Constructor with buffer size & padding factor

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`protected int`	`calSlotIndex(long sequence)` Calculate slot index with the slot sequence (sequence % bufferSize)
`protected void`	`discardPutBuffer(RingBuffer ringBuffer, long uid)` Discard policy for `RejectedPutBufferHandler`, we just do logging
`protected void`	`exceptionRejectedTakeBuffer(RingBuffer ringBuffer)` Policy for `RejectedTakeBufferHandler`, throws `RuntimeException` after logging
`int`	`getBufferSize()`
`long`	`getCursor()`
`long`	`getTail()` Getters
`boolean`	`put(long uid)` Put an UID in the ring & tail moved We use 'synchronized' to guarantee the UID fill in slot & publish new tail sequence as atomic operations Note that: It is recommended to put UID in a serialize way, cause we once batch generate a series UIDs and put the one by one into the buffer, so it is unnecessary put in multi-threads
`void`	`setBufferPaddingExecutor(BufferPaddingExecutor bufferPaddingExecutor)` Setters
`void`	`setRejectedPutHandler(RejectedPutBufferHandler rejectedPutHandler)`
`void`	`setRejectedTakeHandler(RejectedTakeBufferHandler rejectedTakeHandler)`
`long`	`take()` Take an UID of the ring at the next cursor, this is a lock free operation by using atomic cursor Before getting the UID, we also check whether reach the padding threshold, the padding buffer operation will be triggered in another thread If there is no more available UID to be taken, the specified `RejectedTakeBufferHandler` will be applied
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - DEFAULT_PADDING_PERCENT
```
public static final int DEFAULT_PADDING_PERCENT
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - RingBuffer
```
public RingBuffer(int bufferSize)
```
    Constructor with buffer size, paddingFactor default as 50
    
    参数:
    
    bufferSize - must be positive & a power of 2
  - RingBuffer
```
public RingBuffer(int bufferSize,
                  int paddingFactor)
```
    Constructor with buffer size & padding factor
    
    参数:
    
    bufferSize - must be positive & a power of 2
    
    paddingFactor - percent in (0 - 100). When the count of rest available UIDs reach the threshold, it will trigger padding buffer
    Sample: paddingFactor=20, bufferSize=1000 -> threshold=1000 * 20 /100, padding buffer will be triggered when tail-cursor
- 方法详细资料
  - put
```
public boolean put(long uid)
```
    Put an UID in the ring & tail moved
    We use 'synchronized' to guarantee the UID fill in slot & publish new tail sequence as atomic operations
    Note that: It is recommended to put UID in a serialize way, cause we once batch generate a series UIDs and put the one by one into the buffer, so it is unnecessary put in multi-threads
    
    参数:
    
    uid -
    
    返回:
    
    false means that the buffer is full, apply RejectedPutBufferHandler
  - take
```
public long take()
```
    Take an UID of the ring at the next cursor, this is a lock free operation by using atomic cursor
    
    Before getting the UID, we also check whether reach the padding threshold, the padding buffer operation will be triggered in another thread
    If there is no more available UID to be taken, the specified RejectedTakeBufferHandler will be applied
    
    返回:
    
    UID
    
    抛出:
    
    IllegalStateException - if the cursor moved back
  - calSlotIndex
```
protected int calSlotIndex(long sequence)
```
    Calculate slot index with the slot sequence (sequence % bufferSize)
  - discardPutBuffer
```
protected void discardPutBuffer(RingBuffer ringBuffer,
                                long uid)
```
    Discard policy for RejectedPutBufferHandler, we just do logging
  - exceptionRejectedTakeBuffer
```
protected void exceptionRejectedTakeBuffer(RingBuffer ringBuffer)
```
    Policy for RejectedTakeBufferHandler, throws RuntimeException after logging
  - getTail
```
public long getTail()
```
    Getters
  - getCursor
```
public long getCursor()
```
  - getBufferSize
```
public int getBufferSize()
```
  - setBufferPaddingExecutor
```
public void setBufferPaddingExecutor(BufferPaddingExecutor bufferPaddingExecutor)
```
    Setters
  - setRejectedPutHandler
```
public void setRejectedPutHandler(RejectedPutBufferHandler rejectedPutHandler)
```
  - setRejectedTakeHandler
```
public void setRejectedTakeHandler(RejectedTakeBufferHandler rejectedTakeHandler)
```
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 RingBuffer

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

DEFAULT_PADDING_PERCENT

构造器详细资料

RingBuffer

RingBuffer

方法详细资料

put

take

calSlotIndex

discardPutBuffer

exceptionRejectedTakeBuffer

getTail

getCursor

getBufferSize

setBufferPaddingExecutor

setRejectedPutHandler

setRejectedTakeHandler

toString