索引 (uid-generator-spring-boot-starter 1.0.1 API)

A B C D E F G I L M N P R S T U V W

A

addWorkerNode(WorkerNodeEntity) - 接口中的方法cn.amorou.uid.worker.dao.WorkerNodeDAO: Add WorkerNodeEntity
afterPropertiesSet() - 类中的方法cn.amorou.uid.impl.CachedUidGenerator
afterPropertiesSet() - 类中的方法cn.amorou.uid.impl.DefaultUidGenerator
allocate(long, long, long) - 类中的方法cn.amorou.uid.BitsAllocator: Allocate bits for UID according to delta seconds & workerId & sequence
Note that: The highest bit will always be 0 for sign
assignWorkerId() - 类中的方法cn.amorou.uid.worker.DisposableWorkerIdAssigner: Assign worker id base on database.
assignWorkerId() - 类中的方法cn.amorou.uid.worker.SimpleWorkerIdAssigner
assignWorkerId() - 接口中的方法cn.amorou.uid.worker.WorkerIdAssigner: Assign worker id for DefaultUidGenerator
asyncPadding() - 类中的方法cn.amorou.uid.buffer.BufferPaddingExecutor: Padding buffer in the thread pool

B

BitsAllocator - cn.amorou.uid中的类: Allocate 64 bits for the UID(long)
sign (fixed 1bit) -> deltaSecond -> workerId -> sequence(within the same second)
BitsAllocator(int, int, int) - 类的构造器cn.amorou.uid.BitsAllocator: Constructor with timestampBits, workerIdBits, sequenceBits
The highest bit used for sign, so 63 bits for timestampBits, workerIdBits, sequenceBits
bitsAllocator - 类中的变量cn.amorou.uid.impl.DefaultUidGenerator: Stable fields after spring bean initializing
BufferedUidProvider - cn.amorou.uid.buffer中的接口: Buffered UID provider(Lambda supported), which provides UID in the same one second
BufferPaddingExecutor - cn.amorou.uid.buffer中的类: Represents an executor for padding RingBuffer
There are two kinds of executors: one for scheduled padding, the other for padding immediately.
BufferPaddingExecutor(RingBuffer, BufferedUidProvider) - 类的构造器cn.amorou.uid.buffer.BufferPaddingExecutor: Constructor with RingBuffer and BufferedUidProvider, default use schedule
BufferPaddingExecutor(RingBuffer, BufferedUidProvider, boolean) - 类的构造器cn.amorou.uid.buffer.BufferPaddingExecutor: Constructor with RingBuffer, BufferedUidProvider, and whether use schedule padding

C

cachedUidGenerator(WorkerIdAssigner, UidGeneratorProperties, RejectedPutBufferHandler, RejectedTakeBufferHandler) - 类中的方法cn.amorou.uid.boot.UidGeneratorAutoConfiguration
CachedUidGenerator - cn.amorou.uid.impl中的类: Represents a cached implementation of UidGenerator extends from DefaultUidGenerator, based on a lock free RingBuffer The spring properties you can specified as below:
boostPower: RingBuffer size boost for a power of 2, Sample: boostPower is 3, it means the buffer size will be (BitsAllocator.getMaxSequence() + 1) << CachedUidGenerator.boostPower, Default as paddingFactor: Represents a percent value of (0 - 100).
CachedUidGenerator() - 类的构造器cn.amorou.uid.impl.CachedUidGenerator
calSlotIndex(long) - 类中的方法cn.amorou.uid.buffer.RingBuffer: Calculate slot index with the slot sequence (sequence % bufferSize)
cn.amorou.uid - 程序包 cn.amorou.uid
cn.amorou.uid.boot - 程序包 cn.amorou.uid.boot
cn.amorou.uid.buffer - 程序包 cn.amorou.uid.buffer
cn.amorou.uid.exception - 程序包 cn.amorou.uid.exception
cn.amorou.uid.impl - 程序包 cn.amorou.uid.impl
cn.amorou.uid.utils - 程序包 cn.amorou.uid.utils
cn.amorou.uid.worker - 程序包 cn.amorou.uid.worker
cn.amorou.uid.worker.dao - 程序包 cn.amorou.uid.worker.dao
cn.amorou.uid.worker.entity - 程序包 cn.amorou.uid.worker.entity

D

DATETIME_MS_PATTERN - 类中的静态变量cn.amorou.uid.utils.DateUtils
DATETIME_PATTERN - 类中的静态变量cn.amorou.uid.utils.DateUtils
DateUtils - cn.amorou.uid.utils中的类: DateUtils provides date formatting, parsing
DateUtils() - 类的构造器cn.amorou.uid.utils.DateUtils
DAY_PATTERN - 类中的静态变量cn.amorou.uid.utils.DateUtils: Patterns
DEFAULT_DATE - 类中的静态变量cn.amorou.uid.utils.DateUtils
DEFAULT_PADDING_PERCENT - 类中的静态变量cn.amorou.uid.buffer.RingBuffer
defaultUidGenerator(WorkerIdAssigner, UidGeneratorProperties) - 类中的方法cn.amorou.uid.boot.UidGeneratorAutoConfiguration
DefaultUidGenerator - cn.amorou.uid.impl中的类: Represents an implementation of UidGenerator The unique id has 64bits (long), default allocated as blow:
sign: The highest bit is 0 delta seconds: The next 28 bits, represents delta seconds since a customer epoch(2016-05-20 00:00:00.000).
DefaultUidGenerator() - 类的构造器cn.amorou.uid.impl.DefaultUidGenerator
destroy() - 类中的方法cn.amorou.uid.impl.CachedUidGenerator
discardPutBuffer(RingBuffer, long) - 类中的方法cn.amorou.uid.buffer.RingBuffer: Discard policy for RejectedPutBufferHandler, we just do logging
disposableWorkerIdAssigner() - 类中的方法cn.amorou.uid.boot.UidGeneratorAutoConfiguration
DisposableWorkerIdAssigner - cn.amorou.uid.worker中的类: Represents an implementation of WorkerIdAssigner, the worker id will be discarded after assigned to the UidGenerator
DisposableWorkerIdAssigner() - 类的构造器cn.amorou.uid.worker.DisposableWorkerIdAssigner
DockerUtils - cn.amorou.uid.utils中的类: DockerUtils
DockerUtils() - 类的构造器cn.amorou.uid.utils.DockerUtils

E

EnumUtils - cn.amorou.uid.utils中的类: EnumUtils provides the operations for ValuedEnum such as Parse, value of...
EnumUtils() - 类的构造器cn.amorou.uid.utils.EnumUtils
epochSeconds - 类中的变量cn.amorou.uid.impl.DefaultUidGenerator
epochStr - 类中的变量cn.amorou.uid.impl.DefaultUidGenerator: Customer epoch, unit as second.
exceptionRejectedTakeBuffer(RingBuffer) - 类中的方法cn.amorou.uid.buffer.RingBuffer: Policy for RejectedTakeBufferHandler, throws RuntimeException after logging

F

formatByDateTimePattern(Date) - 类中的静态方法cn.amorou.uid.utils.DateUtils: Format date by 'yyyy-MM-dd HH:mm:ss' pattern
formatByDayPattern(Date) - 类中的静态方法cn.amorou.uid.utils.DateUtils: Format date by 'yyyy-MM-dd' pattern
formatDate(Date, String) - 类中的静态方法cn.amorou.uid.utils.DateUtils: Format date into string

G

getBoostPower() - 类中的方法cn.amorou.uid.boot.UidGeneratorProperties
getBufferSize() - 类中的方法cn.amorou.uid.buffer.RingBuffer
getCreated() - 类中的方法cn.amorou.uid.worker.entity.WorkerNodeEntity
getCurrentDayByDayPattern() - 类中的静态方法cn.amorou.uid.utils.DateUtils: Get current day using format date by 'yyyy-MM-dd HH:mm:ss' pattern
getCursor() - 类中的方法cn.amorou.uid.buffer.RingBuffer
getDockerHost() - 类中的静态方法cn.amorou.uid.utils.DockerUtils: Retrieve docker host
getDockerPort() - 类中的静态方法cn.amorou.uid.utils.DockerUtils: Retrieve docker port
getEpochStr() - 类中的方法cn.amorou.uid.boot.UidGeneratorProperties
getHostName() - 类中的方法cn.amorou.uid.worker.entity.WorkerNodeEntity
getId() - 类中的方法cn.amorou.uid.worker.entity.WorkerNodeEntity: Getters & Setters
getLaunchDate() - 类中的方法cn.amorou.uid.worker.entity.WorkerNodeEntity
getLocalAddress() - 类中的静态方法cn.amorou.uid.utils.NetUtils: Retrieve local address
getLocalInetAddress() - 类中的静态方法cn.amorou.uid.utils.NetUtils: Retrieve the first validated local ip address(the Public and LAN ip addresses are validated).
getMaxDeltaSeconds() - 类中的方法cn.amorou.uid.BitsAllocator
getMaxSequence() - 类中的方法cn.amorou.uid.BitsAllocator
getMaxWorkerId() - 类中的方法cn.amorou.uid.BitsAllocator
getModified() - 类中的方法cn.amorou.uid.worker.entity.WorkerNodeEntity
getName() - 类中的方法cn.amorou.uid.utils.NamingThreadFactory: Getters & Setters
getPort() - 类中的方法cn.amorou.uid.worker.entity.WorkerNodeEntity
getScheduleInterval() - 类中的方法cn.amorou.uid.boot.UidGeneratorProperties
getSeqBits() - 类中的方法cn.amorou.uid.boot.UidGeneratorProperties
getSequenceBits() - 类中的方法cn.amorou.uid.BitsAllocator
getSignBits() - 类中的方法cn.amorou.uid.BitsAllocator: Getters
getTail() - 类中的方法cn.amorou.uid.buffer.RingBuffer: Getters
getTimeBits() - 类中的方法cn.amorou.uid.boot.UidGeneratorProperties
getTimestampBits() - 类中的方法cn.amorou.uid.BitsAllocator
getTimestampShift() - 类中的方法cn.amorou.uid.BitsAllocator
getType() - 类中的方法cn.amorou.uid.worker.entity.WorkerNodeEntity
getUID() - 类中的方法cn.amorou.uid.impl.CachedUidGenerator
getUID() - 类中的方法cn.amorou.uid.impl.DefaultUidGenerator
getUID() - 接口中的方法cn.amorou.uid.UidGenerator: Get a unique ID
getUncaughtExceptionHandler() - 类中的方法cn.amorou.uid.utils.NamingThreadFactory
getWorkerBits() - 类中的方法cn.amorou.uid.boot.UidGeneratorProperties
getWorkerIdBits() - 类中的方法cn.amorou.uid.BitsAllocator
getWorkerIdShift() - 类中的方法cn.amorou.uid.BitsAllocator
getWorkerNodeByHostPort(String, String) - 接口中的方法cn.amorou.uid.worker.dao.WorkerNodeDAO: Get WorkerNodeEntity by node host

I

isDaemon() - 类中的方法cn.amorou.uid.utils.NamingThreadFactory
isDocker() - 类中的静态方法cn.amorou.uid.utils.DockerUtils: Whether a docker
isRunning() - 类中的方法cn.amorou.uid.buffer.BufferPaddingExecutor: Whether is padding

L

lastSecond - 类中的变量cn.amorou.uid.impl.DefaultUidGenerator
localAddress - 类中的静态变量cn.amorou.uid.utils.NetUtils: Pre-loaded local address

M

MAPPER_BASE_PACKAGE - 类中的静态变量cn.amorou.uid.boot.UidGeneratorProperties
MYBATIS_MAPPER_LOCATIONS - 类中的静态变量cn.amorou.uid.boot.UidGeneratorProperties

N

NamingThreadFactory - cn.amorou.uid.utils中的类: Named thread in ThreadFactory.
NamingThreadFactory() - 类的构造器cn.amorou.uid.utils.NamingThreadFactory: Constructors
NamingThreadFactory(String) - 类的构造器cn.amorou.uid.utils.NamingThreadFactory
NamingThreadFactory(String, boolean) - 类的构造器cn.amorou.uid.utils.NamingThreadFactory
NamingThreadFactory(String, boolean, Thread.UncaughtExceptionHandler) - 类的构造器cn.amorou.uid.utils.NamingThreadFactory
NetUtils - cn.amorou.uid.utils中的类: NetUtils
NetUtils() - 类的构造器cn.amorou.uid.utils.NetUtils
newThread(Runnable) - 类中的方法cn.amorou.uid.utils.NamingThreadFactory
nextId() - 类中的方法cn.amorou.uid.impl.DefaultUidGenerator: Get UID
nextIdsForOneSecond(long) - 类中的方法cn.amorou.uid.impl.CachedUidGenerator: Get the UIDs in the same specified second under the max sequence

P

p1 - 类中的变量cn.amorou.uid.utils.PaddedAtomicLong: Padded 6 long (48 bytes)
p2 - 类中的变量cn.amorou.uid.utils.PaddedAtomicLong: Padded 6 long (48 bytes)
p3 - 类中的变量cn.amorou.uid.utils.PaddedAtomicLong: Padded 6 long (48 bytes)
p4 - 类中的变量cn.amorou.uid.utils.PaddedAtomicLong: Padded 6 long (48 bytes)
p5 - 类中的变量cn.amorou.uid.utils.PaddedAtomicLong: Padded 6 long (48 bytes)
p6 - 类中的变量cn.amorou.uid.utils.PaddedAtomicLong: Padded 6 long (48 bytes)
PaddedAtomicLong - cn.amorou.uid.utils中的类: Represents a padded AtomicLong to prevent the FalseSharing problem The CPU cache line commonly be 64 bytes, here is a sample of cache line after padding:
64 bytes = 8 bytes (object reference) + 6 * 8 bytes (padded long) + 8 bytes (a long value)
PaddedAtomicLong() - 类的构造器cn.amorou.uid.utils.PaddedAtomicLong: Constructors from AtomicLong
PaddedAtomicLong(long) - 类的构造器cn.amorou.uid.utils.PaddedAtomicLong
paddingBuffer() - 类中的方法cn.amorou.uid.buffer.BufferPaddingExecutor: Padding buffer fill the slots until to catch the cursor
parse(Class<T>, V) - 类中的静态方法cn.amorou.uid.utils.EnumUtils: Parse the bounded value into ValuedEnum
parseByDateTimePattern(String) - 类中的静态方法cn.amorou.uid.utils.DateUtils: Parse date by 'yyyy-MM-dd HH:mm:ss' pattern
parseByDayPattern(String) - 类中的静态方法cn.amorou.uid.utils.DateUtils: Parse date by 'yyyy-MM-dd' pattern
parseDate(String, String) - 类中的静态方法cn.amorou.uid.utils.DateUtils: Parse date without Checked exception
parseUID(long) - 类中的方法cn.amorou.uid.impl.CachedUidGenerator
parseUID(long) - 类中的方法cn.amorou.uid.impl.DefaultUidGenerator
parseUID(long) - 接口中的方法cn.amorou.uid.UidGenerator: Parse the UID into elements which are used to generate the UID.
provide(long) - 接口中的方法cn.amorou.uid.buffer.BufferedUidProvider: Provides UID in one second
put(long) - 类中的方法cn.amorou.uid.buffer.RingBuffer: 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

R

RejectedPutBufferHandler - cn.amorou.uid.buffer中的接口: If tail catches the cursor it means that the ring buffer is full, any more buffer put request will be rejected.
RejectedTakeBufferHandler - cn.amorou.uid.buffer中的接口: If cursor catches the tail it means that the ring buffer is empty, any more buffer take request will be rejected.
rejectPutBuffer(RingBuffer, long) - 接口中的方法cn.amorou.uid.buffer.RejectedPutBufferHandler: Reject put buffer request
rejectTakeBuffer(RingBuffer) - 接口中的方法cn.amorou.uid.buffer.RejectedTakeBufferHandler: Reject take buffer request
RingBuffer - cn.amorou.uid.buffer中的类: Represents a ring buffer based on array.
RingBuffer(int) - 类的构造器cn.amorou.uid.buffer.RingBuffer: Constructor with buffer size, paddingFactor default as 50
RingBuffer(int, int) - 类的构造器cn.amorou.uid.buffer.RingBuffer: Constructor with buffer size & padding factor

S

seqBits - 类中的变量cn.amorou.uid.impl.DefaultUidGenerator
sequence - 类中的变量cn.amorou.uid.impl.DefaultUidGenerator: Volatile fields caused by nextId()
setBoostPower(int) - 类中的方法cn.amorou.uid.boot.UidGeneratorProperties
setBoostPower(int) - 类中的方法cn.amorou.uid.impl.CachedUidGenerator: Setters for spring property
setBufferPaddingExecutor(BufferPaddingExecutor) - 类中的方法cn.amorou.uid.buffer.RingBuffer: Setters
setCreated(Date) - 类中的方法cn.amorou.uid.worker.entity.WorkerNodeEntity
setDaemon(boolean) - 类中的方法cn.amorou.uid.utils.NamingThreadFactory
setEpochStr(String) - 类中的方法cn.amorou.uid.boot.UidGeneratorProperties
setEpochStr(String) - 类中的方法cn.amorou.uid.impl.DefaultUidGenerator
setHostName(String) - 类中的方法cn.amorou.uid.worker.entity.WorkerNodeEntity
setId(long) - 类中的方法cn.amorou.uid.worker.entity.WorkerNodeEntity
setLaunchDateDate(Date) - 类中的方法cn.amorou.uid.worker.entity.WorkerNodeEntity
setModified(Date) - 类中的方法cn.amorou.uid.worker.entity.WorkerNodeEntity
setName(String) - 类中的方法cn.amorou.uid.utils.NamingThreadFactory
setPort(String) - 类中的方法cn.amorou.uid.worker.entity.WorkerNodeEntity
setRejectedPutBufferHandler(RejectedPutBufferHandler) - 类中的方法cn.amorou.uid.impl.CachedUidGenerator
setRejectedPutHandler(RejectedPutBufferHandler) - 类中的方法cn.amorou.uid.buffer.RingBuffer
setRejectedTakeBufferHandler(RejectedTakeBufferHandler) - 类中的方法cn.amorou.uid.impl.CachedUidGenerator
setRejectedTakeHandler(RejectedTakeBufferHandler) - 类中的方法cn.amorou.uid.buffer.RingBuffer
setScheduleInterval(int) - 类中的方法cn.amorou.uid.boot.UidGeneratorProperties
setScheduleInterval(long) - 类中的方法cn.amorou.uid.buffer.BufferPaddingExecutor: Setters
setScheduleInterval(long) - 类中的方法cn.amorou.uid.impl.CachedUidGenerator
setSeqBits(int) - 类中的方法cn.amorou.uid.boot.UidGeneratorProperties
setSeqBits(int) - 类中的方法cn.amorou.uid.impl.DefaultUidGenerator
setTimeBits(int) - 类中的方法cn.amorou.uid.boot.UidGeneratorProperties
setTimeBits(int) - 类中的方法cn.amorou.uid.impl.DefaultUidGenerator
setType(int) - 类中的方法cn.amorou.uid.worker.entity.WorkerNodeEntity
setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler) - 类中的方法cn.amorou.uid.utils.NamingThreadFactory
setWorkerBits(int) - 类中的方法cn.amorou.uid.boot.UidGeneratorProperties
setWorkerBits(int) - 类中的方法cn.amorou.uid.impl.DefaultUidGenerator
setWorkerIdAssigner(WorkerIdAssigner) - 类中的方法cn.amorou.uid.impl.DefaultUidGenerator: Setters for spring property
shutdown() - 类中的方法cn.amorou.uid.buffer.BufferPaddingExecutor: Shutdown executors
simpleWorkerIdAssigner() - 类中的方法cn.amorou.uid.boot.UidGeneratorAutoConfiguration
SimpleWorkerIdAssigner - cn.amorou.uid.worker中的类
SimpleWorkerIdAssigner() - 类的构造器cn.amorou.uid.worker.SimpleWorkerIdAssigner
start() - 类中的方法cn.amorou.uid.buffer.BufferPaddingExecutor: Start executors such as schedule
sumPaddingToPreventOptimization() - 类中的方法cn.amorou.uid.utils.PaddedAtomicLong: To prevent GC optimizations for cleaning unused padded references

T

take() - 类中的方法cn.amorou.uid.buffer.RingBuffer: 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
timeBits - 类中的变量cn.amorou.uid.impl.DefaultUidGenerator: Bits allocate
toString() - 类中的方法cn.amorou.uid.BitsAllocator
toString() - 类中的方法cn.amorou.uid.buffer.RingBuffer
toString() - 类中的方法cn.amorou.uid.worker.entity.WorkerNodeEntity
TOTAL_BITS - 类中的静态变量cn.amorou.uid.BitsAllocator: Total 64 bits

U

UID_PREFIX - 类中的静态变量cn.amorou.uid.boot.UidGeneratorProperties
UID_SQL_SESSION_FACTORY_NAME - 类中的静态变量cn.amorou.uid.boot.UidGeneratorProperties
UidGenerateException - cn.amorou.uid.exception中的异常错误: UidGenerateException
UidGenerateException() - 异常错误的构造器cn.amorou.uid.exception.UidGenerateException: Default constructor
UidGenerateException(String, Throwable) - 异常错误的构造器cn.amorou.uid.exception.UidGenerateException: Constructor with message & cause
UidGenerateException(String) - 异常错误的构造器cn.amorou.uid.exception.UidGenerateException: Constructor with message
UidGenerateException(String, Object...) - 异常错误的构造器cn.amorou.uid.exception.UidGenerateException: Constructor with message format
UidGenerateException(Throwable) - 异常错误的构造器cn.amorou.uid.exception.UidGenerateException: Constructor with cause
UidGenerator - cn.amorou.uid中的接口: Represents a unique id generator.
UidGeneratorAutoConfiguration - cn.amorou.uid.boot中的类
UidGeneratorAutoConfiguration() - 类的构造器cn.amorou.uid.boot.UidGeneratorAutoConfiguration
UidGeneratorProperties - cn.amorou.uid.boot中的类
UidGeneratorProperties() - 类的构造器cn.amorou.uid.boot.UidGeneratorProperties
uidSqlSessionFactory(DataSource) - 类中的方法cn.amorou.uid.boot.UidGeneratorAutoConfiguration

V

value() - 接口中的方法cn.amorou.uid.utils.ValuedEnum
value() - 枚举中的方法cn.amorou.uid.worker.WorkerNodeType
ValuedEnum<T> - cn.amorou.uid.utils中的接口: ValuedEnum defines an enumeration which is bounded to a value, you may implements this interface when you defines such kind of enumeration, that you can use EnumUtils to simplify parse and valueOf operation.
valueOf(Class<T>, String) - 类中的静态方法cn.amorou.uid.utils.EnumUtils: Null-safe valueOf function
valueOf(String) - 枚举中的静态方法cn.amorou.uid.worker.WorkerNodeType: 返回带有指定名称的该类型的枚举常量。
values() - 枚举中的静态方法cn.amorou.uid.worker.WorkerNodeType: 按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。

W

workerBits - 类中的变量cn.amorou.uid.impl.DefaultUidGenerator
workerId - 类中的变量cn.amorou.uid.impl.DefaultUidGenerator
workerIdAssigner - 类中的变量cn.amorou.uid.impl.DefaultUidGenerator: Spring property
WorkerIdAssigner - cn.amorou.uid.worker中的接口: Represents a worker id assigner for DefaultUidGenerator
WorkerNodeDAO - cn.amorou.uid.worker.dao中的接口: DAO for M_WORKER_NODE
WorkerNodeEntity - cn.amorou.uid.worker.entity中的类: Entity for M_WORKER_NODE
WorkerNodeEntity() - 类的构造器cn.amorou.uid.worker.entity.WorkerNodeEntity
WorkerNodeType - cn.amorou.uid.worker中的枚举: WorkerNodeType CONTAINER: Such as Docker ACTUAL: Actual machine

A B C D E F G I L M N P R S T U V W