Utils (jraft-core 1.3.8 1.3.8 API)

java.lang.Object
- com.alipay.sofa.jraft.util.Utils

```
public final class Utils
extends Object
```
Helper methods for jraft.

作者:

boyan (boyan@alibaba-inc.com) 2018-Apr-07 10:12:35 AM

字段概要

字段
限定符和类型	字段和说明
`static int`	`APPEND_ENTRIES_THREADS_SEND` Default jraft append-entries executor(send) pool size.
`static String`	`IP_ANY` ANY IP address 0.0.0.0
`static String`	`IPV6_END_MARK`
`static String`	`IPV6_START_MARK`
`static int`	`MAX_APPEND_ENTRIES_TASKS_PER_THREAD` Default jraft max pending tasks of append-entries per thread, 65536 by default.
`static int`	`MAX_CLOSURE_EXECUTOR_POOL_SIZE` Default jraft closure executor pool maximum size.
`static int`	`MAX_COLLECTOR_SIZE_PER_THREAD` Default max `ByteBufferCollector` size per thread for recycle, it can be set by -Djraft.max_collector_size_per_thread, default 256
`static int`	`MIN_CLOSURE_EXECUTOR_POOL_SIZE` Default jraft closure executor pool minimum size, CPUs by default.
`static int`	`RAFT_DATA_BUF_SIZE` Default init and expand buffer size, it can be set by -Djraft.byte_buf.size=n, default 1024.
`static boolean`	`USE_MPSC_SINGLE_THREAD_EXECUTOR` Whether use `MpscSingleThreadExecutor`, true by default.

构造器概要

构造器
构造器和说明

Utils()

构造器
构造器和说明
`Utils()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static ByteBuffer`	`allocate()` Allocate a byte buffer with `RAFT_DATA_BUF_SIZE`
`static ByteBuffer`	`allocate(int size)` Allocate a byte buffer with size.
`static boolean`	`atomicMoveFile(File source, File target, boolean sync)`
`static int`	`closeQuietly(Closeable closeable)` Close a closeable.
`static int`	`cpus()` Get system CPUs count.
`static ByteBuffer`	`expandByteBuffer(ByteBuffer buf)` Expand byte buffer for 1024 bytes.
`static ByteBuffer`	`expandByteBufferAtLeast(ByteBuffer buf, int minLength)` Expand byte buffer at least minLength.
`static ByteBuffer`	`expandByteBufferAtMost(ByteBuffer buf, int maxLength)` Expand byte buffer at most maxLength.
`static void`	`fsync(File file)` Calls fsync on a file or directory.
`static byte[]`	`getBytes(String s)` Get string bytes in UTF-8 charset.
`static long`	`getProcessId(long fallback)` Get java process id.
`static String`	`getString(byte[] bs, int off, int len)`
`static boolean`	`isIPv6(String addr)` check whether the ip address is IPv6.
`static long`	`monotonicMs()` Gets the current monotonic time in milliseconds.
`static long`	`monotonicUs()` Gets the current monotonic time in microseconds.
`static long`	`nowMs()` Returns the current time in milliseconds, it's not monotonic, would be forwarded/backward by clock synchronous.
`static String[]`	`parsePeerId(String s)` Parse peerId from string that generated by `Object.toString()` This method can support parameter string values are below: PeerId.parse("a:b") = new PeerId("a", "b", 0 , -1) PeerId.parse("a:b:c") = new PeerId("a", "b", "c", -1) PeerId.parse("a:b::d") = new PeerId("a", "b", 0, "d") PeerId.parse("a:b:c:d") = new PeerId("a", "b", "c", "d")
`static void`	`registerClosureExecutorMetrics(com.codahale.metrics.MetricRegistry registry)` Register CLOSURE_EXECUTOR into metric registry.
`static Future<?>`	`runClosureInThread(Closure done)` Run closure with OK status in thread pool.
`static Future<?>`	`runClosureInThread(Closure done, Status status)` Run closure with status in thread pool.
`static Future<?>`	`runInThread(Runnable runnable)` Run a task in thread pool,returns the future object.
`static void`	`unmap(MappedByteBuffer cb)` Unmap mappedByteBuffer See https://stackoverflow.com/questions/2972986/how-to-unmap-a-file-from-memory-mapped-using-filechannel-in-java
`static void`	`verifyGroupId(String groupId)`
`static <T> T`	`withLockObject(T obj)`

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

字段详细资料
- MIN_CLOSURE_EXECUTOR_POOL_SIZE
```
public static final int MIN_CLOSURE_EXECUTOR_POOL_SIZE
```
  Default jraft closure executor pool minimum size, CPUs by default.
- MAX_CLOSURE_EXECUTOR_POOL_SIZE
```
public static final int MAX_CLOSURE_EXECUTOR_POOL_SIZE
```
  Default jraft closure executor pool maximum size.
- APPEND_ENTRIES_THREADS_SEND
```
public static final int APPEND_ENTRIES_THREADS_SEND
```
  Default jraft append-entries executor(send) pool size.
- MAX_APPEND_ENTRIES_TASKS_PER_THREAD
```
public static final int MAX_APPEND_ENTRIES_TASKS_PER_THREAD
```
  Default jraft max pending tasks of append-entries per thread, 65536 by default.
- USE_MPSC_SINGLE_THREAD_EXECUTOR
```
public static final boolean USE_MPSC_SINGLE_THREAD_EXECUTOR
```
  Whether use MpscSingleThreadExecutor, true by default.
- RAFT_DATA_BUF_SIZE
```
public static final int RAFT_DATA_BUF_SIZE
```
  Default init and expand buffer size, it can be set by -Djraft.byte_buf.size=n, default 1024.
- MAX_COLLECTOR_SIZE_PER_THREAD
```
public static final int MAX_COLLECTOR_SIZE_PER_THREAD
```
  Default max ByteBufferCollector size per thread for recycle, it can be set by -Djraft.max_collector_size_per_thread, default 256
- IP_ANY
```
public static final String IP_ANY
```
  ANY IP address 0.0.0.0
  
  另请参阅:
  
  常量字段值
- IPV6_START_MARK
```
public static final String IPV6_START_MARK
```
  另请参阅:
  
  常量字段值
- IPV6_END_MARK
```
public static final String IPV6_END_MARK
```
  另请参阅:
  
  常量字段值

构造器详细资料
- Utils
```
public Utils()
```

方法详细资料

verifyGroupId

public static void verifyGroupId(String groupId)

registerClosureExecutorMetrics

public static void registerClosureExecutorMetrics(com.codahale.metrics.MetricRegistry registry)

runClosureInThread

public static Future<?> runClosureInThread(Closure done)

Run closure with OK status in thread pool.

runInThread
```
public static Future<?> runInThread(Runnable runnable)
```
Run a task in thread pool,returns the future object.

runClosureInThread

public static Future<?> runClosureInThread(Closure done,
                                           Status status)

Run closure with status in thread pool.

closeQuietly

public static int closeQuietly(Closeable closeable)

Close a closeable.

cpus
```
public static int cpus()
```
Get system CPUs count.

getProcessId

public static long getProcessId(long fallback)

Get java process id.

expandByteBuffer

public static ByteBuffer expandByteBuffer(ByteBuffer buf)

Expand byte buffer for 1024 bytes.

allocate

public static ByteBuffer allocate(int size)

Allocate a byte buffer with size.

allocate
```
public static ByteBuffer allocate()
```
Allocate a byte buffer with RAFT_DATA_BUF_SIZE

expandByteBufferAtLeast

public static ByteBuffer expandByteBufferAtLeast(ByteBuffer buf,
                                                 int minLength)

Expand byte buffer at least minLength.

expandByteBufferAtMost

public static ByteBuffer expandByteBufferAtMost(ByteBuffer buf,
                                                int maxLength)

Expand byte buffer at most maxLength.

monotonicMs
```
public static long monotonicMs()
```
Gets the current monotonic time in milliseconds.

nowMs
```
public static long nowMs()
```
Returns the current time in milliseconds, it's not monotonic, would be forwarded/backward by clock synchronous.

monotonicUs
```
public static long monotonicUs()
```
Gets the current monotonic time in microseconds.

getBytes

public static byte[] getBytes(String s)

Get string bytes in UTF-8 charset.

withLockObject

public static <T> T withLockObject(T obj)

atomicMoveFile

public static boolean atomicMoveFile(File source,
                                     File target,
                                     boolean sync)
                              throws IOException

抛出:: IOException

fsync
```
public static void fsync(File file)
                  throws IOException
```
Calls fsync on a file or directory.

参数:

file - file or directory

抛出:

IOException - if an I/O error occurs

unmap
```
public static void unmap(MappedByteBuffer cb)
```
Unmap mappedByteBuffer See https://stackoverflow.com/questions/2972986/how-to-unmap-a-file-from-memory-mapped-using-filechannel-in-java

getString

public static String getString(byte[] bs,
                               int off,
                               int len)

isIPv6
```
public static boolean isIPv6(String addr)
```
check whether the ip address is IPv6.

参数:

addr - ip address

返回:

boolean

parsePeerId

public static String[] parsePeerId(String s)

Parse peerId from string that generated by Object.toString() This method can support parameter string values are below:

 PeerId.parse("a:b")          = new PeerId("a", "b", 0 , -1)
 PeerId.parse("a:b:c")        = new PeerId("a", "b", "c", -1)
 PeerId.parse("a:b::d")       = new PeerId("a", "b", 0, "d")
 PeerId.parse("a:b:c:d")      = new PeerId("a", "b", "c", "d")

类 Utils

字段概要

构造器概要

方法概要

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

字段详细资料

MIN_CLOSURE_EXECUTOR_POOL_SIZE

MAX_CLOSURE_EXECUTOR_POOL_SIZE

APPEND_ENTRIES_THREADS_SEND

MAX_APPEND_ENTRIES_TASKS_PER_THREAD

USE_MPSC_SINGLE_THREAD_EXECUTOR

RAFT_DATA_BUF_SIZE

MAX_COLLECTOR_SIZE_PER_THREAD

IP_ANY

IPV6_START_MARK

IPV6_END_MARK

构造器详细资料

Utils

方法详细资料

verifyGroupId

registerClosureExecutorMetrics

runClosureInThread

runInThread

runClosureInThread

closeQuietly

cpus

getProcessId

expandByteBuffer

allocate

allocate

expandByteBufferAtLeast

expandByteBufferAtMost

monotonicMs

nowMs

monotonicUs

getBytes

withLockObject

atomicMoveFile

fsync

unmap

getString

isIPv6

parsePeerId