程序包 ohos.hiviewdfx.xcollie

类 XCollie

java.lang.Object

ohos.hiviewdfx.xcollie.XCollie

public final class XCollie
extends Object

Provides methods for detecting application or service timeouts. This class defines a mechanism for detecting time-consuming service processing.

An application or a service uses this mechanism to check whether a key service procedure times out. For example, if a procedure is not completed within 5 seconds as expected, the application is notified of the timeout. Upon receiving the notification, the application will take proper measures.

    // Start timeout detection.
    int id = XCollie.getInstance().setTimeout("ServiceTimeout", 5, new Runnable(){
        @Override
        public void run () {
            // do something
        }
    }, XCollie.XCOLLIE_FLAG_NOOP);
    // Do something.
    // Cancel timeout detection.
    XCollie.getInstance().cancelTimeout(id);
 

从以下版本开始:

4

SystemCapability

SystemCapability.HiviewDFX.HiCollie

字段概要

字段

限定符和类型	字段	说明
static long	XCOLLIE_FLAG_LOG	Indicates that logs are printed after a timeout detected via setTimeout.
static long	XCOLLIE_FLAG_NOOP	Indicates that no operation is performed after a timeout detected via setTimeout.
static long	XCOLLIE_FLAG_RECOVERY	Indicates that the application or service exits for recovery after a timeout detected via setTimeout.
static int	XCOLLIE_INVALID_ID	Indicates an invalid value of the timeout detection handle to be returned when timeout detection fails to be started by setTimeout.

方法概要

限定符和类型	方法	说明
void	cancelTimeout(int id)	Cancels timeout detection.
static XCollie	getInstance()	Obtains an XCollie instance.
int	setTimeout(String timeoutName, int timeout, Runnable callback, long flag)	Starts timeout detection.
boolean	updateTimeout(int id, long timeout)	Updates the timeout length.

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

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

字段详细资料

XCOLLIE_FLAG_LOG

public static final long XCOLLIE_FLAG_LOG

Indicates that logs are printed after a timeout detected via setTimeout.

从以下版本开始:

4

另请参阅:

常量字段值

XCOLLIE_FLAG_NOOP

public static final long XCOLLIE_FLAG_NOOP

Indicates that no operation is performed after a timeout detected via setTimeout.

从以下版本开始:

4

另请参阅:

常量字段值

XCOLLIE_FLAG_RECOVERY

public static final long XCOLLIE_FLAG_RECOVERY

Indicates that the application or service exits for recovery after a timeout detected via setTimeout.

从以下版本开始:

4

另请参阅:

常量字段值

XCOLLIE_INVALID_ID

public static final int XCOLLIE_INVALID_ID

Indicates an invalid value of the timeout detection handle to be returned when timeout detection fails to be started by setTimeout.

从以下版本开始:

4

另请参阅:

常量字段值

方法详细资料

getInstance

public static XCollie getInstance()

Obtains an XCollie instance.

The XCollie class works in singleton pattern.

返回:

Returns the XCollie instance.

从以下版本开始:

4

setTimeout

public int setTimeout(String timeoutName,
                      int timeout,
                      Runnable callback,
                      long flag)

Starts timeout detection.

When handling a time-consuming procedure, an application or service calls this method to check whether the procedure times out.

参数:

timeoutName - Indicates the timeout name.

timeout - Indicates the timeout length, in seconds.

callback - Indicates the callback upon a timeout.

flag - Indicates the processing flag for a timeout. The value can be:

• XCOLLIE_FLAG_NOOP: No operation is performed except that the callback is invoked to notify the application of the timeout.
• XCOLLIE_FLAG_RECOVERY: The callback is invoked to notify the application of the timeout, and the application or service exits for recovery.
• XCOLLIE_FLAG_LOG: The callback is invoked to notify the application of the timeout, and logs are printed.

返回:

Returns a timeout detection handle if the detection is started successfully; returns XCOLLIE_INVALID_ID otherwise.

从以下版本开始:

4

另请参阅:

XCOLLIE_FLAG_NOOP, XCOLLIE_FLAG_RECOVERY, XCOLLIE_INVALID_ID

cancelTimeout

public void cancelTimeout(int id)

Cancels timeout detection.

参数:

id - Indicates the timeout detection handle.

从以下版本开始:

4

updateTimeout

public boolean updateTimeout(int id,
                             long timeout)

Updates the timeout length.

参数:

id - Indicates the timeout detection handle.

timeout - Indicates the updated timeout length, in seconds.

返回:

Returns true if the update is successful; returns false otherwise.

从以下版本开始:

4