org.joyqueue.store

接口 PartitionGroupStore

public interface PartitionGroupStore

Partition group存储，每个Partition group属于唯一的一个Topic，在Topic范围内拥有唯一的序号，包含多个Partition。

方法概要

限定符和类型	方法和说明
void	asyncWrite(EventListener<WriteResult> eventListener, WriteRequest... writeRequests) 异步写入消息，线程安全，保证ACI，D的保证取决于WriteQosLevel
Future<WriteResult>	asyncWrite(WriteRequest... writeRequests) 异步写入消息，线程安全，保证ACI，D的保证取决于WriteQosLevel
long	clean(long time, Map<Short,Long> partitionAckMap, boolean keepUnconsumed)
long	getIndex(short partition, long timestamp) 根据消息存储时间获取索引。
long	getLeftIndex(short partition) 获取分区当前的最小索引，用于初始化消费
int	getPartitionGroup() 获取Partition Group 序号
long	getRightIndex(short partition) 获取分区当前的最大索引，用于初始化消费
String	getTopic() 获取Topic
long	getTotalPhysicalStorageSize() 获取当前PartitionGroup占用的磁盘空间大小
Short[]	listPartitions() 列出Partition group下所有的Partition
ReadResult	read(short partition, long index, int count, long maxSize) 非阻塞批量读取消息，从指定位置读取消息，如果没有消息立即返回。

方法详细资料

getTopic

String getTopic()

获取Topic

返回:

Topic

getPartitionGroup

int getPartitionGroup()

获取Partition Group 序号

返回:

Partition Group 序号

listPartitions

Short[] listPartitions()

列出Partition group下所有的Partition

返回:

Partition数组

getTotalPhysicalStorageSize

long getTotalPhysicalStorageSize()

获取当前PartitionGroup占用的磁盘空间大小

返回:

当前PartitionGroup占用的磁盘空间大小，单位Byte

clean

long clean(long time,
           Map<Short,Long> partitionAckMap,
           boolean keepUnconsumed)
    throws IOException

参数:

time - delete oldest index file of partition if exist at least two consumed index file and it's oldest message time < time, force clean oldest consumed index file when time < 0

partitionAckMap - partition consume ack offsets

keepUnconsumed - do not delete unconsumed

返回:

release storage size

抛出:

IOException

getLeftIndex

long getLeftIndex(short partition)

获取分区当前的最小索引，用于初始化消费

参数:

partition - 分区

返回:

返回值小于0时表示分区不存在，否则返回分区最大索引

getRightIndex

long getRightIndex(short partition)

获取分区当前的最大索引，用于初始化消费

参数:

partition - 分区

返回:

返回值小于0时表示分区不存在，否则返回分区最大索引

getIndex

long getIndex(short partition,
              long timestamp)

根据消息存储时间获取索引。 如果找到，返回最后一条 “存储时间 不大于 timestamp” 消息的索引。 如果找不到，返回负值。

参数:

partition - 分区

timestamp - 时间戳

asyncWrite

Future<WriteResult> asyncWrite(WriteRequest... writeRequests)

异步写入消息，线程安全，保证ACI，D的保证取决于WriteQosLevel

参数:

writeRequests - partition序号和消息

返回:

以Future形式返回结果

抛出:

NullPointerException - eventListener或writeRequests为空时抛出

另请参阅:

WriteResult, WriteRequest

asyncWrite

void asyncWrite(EventListener<WriteResult> eventListener,
                WriteRequest... writeRequests)

异步写入消息，线程安全，保证ACI，D的保证取决于WriteQosLevel

参数:

eventListener - 回调方法，可以为null，表示不需要回调。

writeRequests - partition序号和消息

抛出:

NullPointerException - writeRequests为空时抛出

另请参阅:

WriteResult, WriteRequest

read

ReadResult read(short partition,
                long index,
                int count,
                long maxSize)
         throws IOException

非阻塞批量读取消息，从指定位置读取消息，如果没有消息立即返回。

参数:

partition - partition序号

index - partition内的全局消息序号

count - 要求读取的消息数量，当count < 1 时，按count ==1处理。

maxSize - 返回所有消息的长度之和最大值。参数不大于0时，不限制最大长度。 当第一条消息长度大于maxSize时，返回1条消息。 否则返回尽可能多的消息，保证这些消息长度之不超过maxSize。

返回:

消息数组，不保证返回消息数量一定等于要求数量count。

抛出:

IOException

另请参阅:

ReadResult