asyncTTL
异步获取单行数据的TTL时间,即该数据还能存活多久,单位为秒。
- public static interface TTLListener extends GenericFutureListener<Future<Integer>> {
- /**
- * This function will be called when listened asyncTTL future is done.
- * @param future the listened future
- * @throws Exception
- *
- * Notice: User shouldn't do any operations that may block or time-consuming
- */
- @Override
- public void operationComplete(Future<Integer> future) throws Exception;
- }
- /**
- * get TTL value for a specific (hashKey, sortKey) pair, async version
- * @param hashKey used to decide which partition the key may exist
- * if null or empty, means hash key is "".
- * @param sortKey all keys under the same hashKey will be sorted by sortKey
- * if null or empty, means sort key is "".
- * @param timeout how long will the operation timeout in milliseconds.
- * if timeout > 0, it is a timeout value for current op,
- * else the timeout value in the configuration file will be used.
- *
- * @return the future for current op
- *
- * Future return:
- * On success: ttl time in seconds; -1 if no ttl set; -2 if not exist.
- * On failure: a throwable, which is an instance of PException
- *
- * Thread safety:
- * All the listeners for the same table are guaranteed to be dispatched in the same thread, so all the
- * listeners for the same future are guaranteed to be executed as the same order as the listeners added.
- * But listeners for different tables are not guaranteed to be dispatched in the same thread.
- */
- public Future<Integer> asyncTTL(byte[] hashKey, byte[] sortKey, int timeout/*ms*/);
注:
- 参数:需传入HashKey、SortKey、timeout。
- timeout单位为毫秒,如果<=0,表示使用配置文件中的默认超时。
- 返回值:Future
。 - 返回结果为TTL时间,单位为秒。如果该数据没有设置TTL,返回-1;如果该数据不存在,返回-2。