pro.fessional.mirana.id

Class LightIdBufferedProvider

java.lang.Object

pro.fessional.mirana.id.LightIdBufferedProvider

All Implemented Interfaces:

LightIdProvider

@ThreadSafe
public class LightIdBufferedProvider
extends Object
implements LightIdProvider

 Lightweight lock, high performance, double-buffered light-id provider.

 The following 3 types of threads exist in total, and read threads are promoted to write threads and even load threads.
 At the same time, there are multiple read threads, but only unique write threads, and unique load threads.

 - Read thread, normal light-id consumer
 - Write thread, upgraded read thread or load thread to append fragment to buffer (segment)
 - Load thread, async thread or upgraded read thread to load segment via loader.

 Double buffer works as the following mechanism, it will track the id usage and auto control the count of preloading, but not exceed maxCount.

 - When the Id balance is less than 20%, the only async preload is `maxUsage in 60s` or `maxCount`.
 - When Id balance is exhausted, read threads upgrade to write threads, other read threads wait until woken up or timeout.
 - When read thread upgrades to write thread, loader exists, this read thread switches buffer after spinning busy and so on.

 

Since:

2019-05-26

Author:

trydofor

Nested Class Summary

Nested classes/interfaces inherited from interface pro.fessional.mirana.id.LightIdProvider

LightIdProvider.Generator, LightIdProvider.Loader, LightIdProvider.Segment

Field Summary

Fields

Modifier and Type	Field and Description
static long	ERR_ALIVE
static int	FIX_COUNT
static LightIdProvider.Generator	GENERATOR
static int	MAX_COUNT
static int	MAX_ERROR
static int	MIN_COUNT
static long	TIME_OUT

Constructor Summary

Constructors

Constructor and Description
LightIdBufferedProvider(@NotNull LightIdProvider.Loader loader) default thread pool is core-size=3, max-size=64, keep-alive 60S
LightIdBufferedProvider(@NotNull LightIdProvider.Loader loader, @NotNull ExecutorService executor) Buffered Multiple Thread Provider

Method Summary

Modifier and Type	Method and Description
void	cleanError(@NotNull String name, int block) clean the error, and reset the counter.
long	getErrAlive()
int	getFixCount()
LightIdProvider.Generator	getGenerator()
int	getMaxCount()
int	getMaxError()
int	getMinCount()
long	getTimeout()
long	next(@NotNull String name, int block) get the next LightId by its block and name, default timeout is 1 second.
long	next(@NotNull String name, int block, long timeout) get the next LightId by its block and name ,within the specify timeout(ms)
void	preload(int block) Preload all LightId's in the block, doing this once at startup is enough.
void	setErrAlive(long t) set the error status alive time, which will be cleared when it expires, default 2 minutes.
boolean	setFixCount(int n) Whether to preload a fixed count of ids.
void	setGenerator(@NotNull LightIdProvider.Generator generator) set Sequence Handler to edit the sequence before the LightId
boolean	setMaxCount(int n) set the max count of preload, default is 10000
boolean	setMaxError(int n) set the max tolerated errors in the loading, default 5.
boolean	setMinCount(int n) set the min count of preload, default is 100.
boolean	setTimeout(long t) set request timeout in mills, default 1 second.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_COUNT

public static final int MAX_COUNT

See Also:

Constant Field Values

MIN_COUNT

public static final int MIN_COUNT

See Also:

Constant Field Values

FIX_COUNT

public static final int FIX_COUNT

See Also:

Constant Field Values

MAX_ERROR

public static final int MAX_ERROR

See Also:

Constant Field Values

ERR_ALIVE

public static final long ERR_ALIVE

See Also:

Constant Field Values

TIME_OUT

public static final long TIME_OUT

See Also:

Constant Field Values

GENERATOR

public static final LightIdProvider.Generator GENERATOR

Constructor Detail

LightIdBufferedProvider

public LightIdBufferedProvider(@NotNull
                               @NotNull LightIdProvider.Loader loader)

default thread pool is core-size=3, max-size=64, keep-alive 60S

Parameters:

loader - the loader

LightIdBufferedProvider

public LightIdBufferedProvider(@NotNull
                               @NotNull LightIdProvider.Loader loader,
                               @NotNull
                               @NotNull ExecutorService executor)

Buffered Multiple Thread Provider

Parameters:

loader - the loader

executor - the executor

Method Detail

getErrAlive

public long getErrAlive()

getTimeout

public long getTimeout()

getMaxError

public int getMaxError()

getMaxCount

public int getMaxCount()

getMinCount

public int getMinCount()

getFixCount

public int getFixCount()

getGenerator

public LightIdProvider.Generator getGenerator()

setErrAlive

public void setErrAlive(long t)

set the error status alive time, which will be cleared when it expires, default 2 minutes. Less than 0 means it will not be cleared

Parameters:

t - time in mills

See Also:

ERR_ALIVE

setTimeout

public boolean setTimeout(long t)

set request timeout in mills, default 1 second.

Parameters:

t - time in mills

Returns:

ture if the count is greater than 0

See Also:

TIME_OUT

setMaxError

public boolean setMaxError(int n)

set the max tolerated errors in the loading, default 5.

Parameters:

n - count

Returns:

ture if the count is greater than 0

See Also:

MAX_ERROR

setMaxCount

public boolean setMaxCount(int n)

set the max count of preload, default is 10000

Parameters:

n - count

Returns:

ture if the count is greater than 0

See Also:

MAX_COUNT

setMinCount

public boolean setMinCount(int n)

set the min count of preload, default is 100.

Parameters:

n - count

Returns:

ture if the count is greater than 0

See Also:

MIN_COUNT

setFixCount

public boolean setFixCount(int n)

Whether to preload a fixed count of ids. fixed if ge FIX_COUNT, dynamic otherwise

Parameters:

n - count, Fixed count if ge FIX_COUNT

Returns:

success or not

See Also:

FIX_COUNT

setGenerator

public void setGenerator(@NotNull
                         @NotNull LightIdProvider.Generator generator)

set Sequence Handler to edit the sequence before the LightId

See Also:

LightIdUtil.toId(int, long), GENERATOR

preload

public void preload(int block)

Preload all LightId's in the block, doing this once at startup is enough.

Parameters:

block - Id's block

cleanError

public void cleanError(@NotNull
                       @NotNull String name,
                       int block)

clean the error, and reset the counter.

Parameters:

name - Id's name

block - Id's block

next

public long next(@NotNull
                 @NotNull String name,
                 int block)

Description copied from interface: LightIdProvider

get the next LightId by its block and name, default timeout is 1 second.

Specified by:

next in interface LightIdProvider

Parameters:

name - Id name

block - block aka. data center in db cluster

Returns:

LightId

next

public long next(@NotNull
                 @NotNull String name,
                 int block,
                 long timeout)

Description copied from interface: LightIdProvider

get the next LightId by its block and name ,within the specify timeout(ms)

Specified by:

next in interface LightIdProvider

Parameters:

name - Id name

block - block aka. data center in db cluster

timeout - timeout in ms, 0(unlimited) is NOT recommended, as much as possible to meet the business performance requirements.

Returns:

LightId