程序包 ohos.rpc

类 MessageOption

java.lang.Object

ohos.rpc.MessageOption

public class MessageOption
extends Object

Defines options for sending messages together with sendRequest.

从以下版本开始:

1

字段概要

字段

限定符和类型	字段	说明
static int	TF_ACCEPT_FDS	Indicates that file descriptors can be returned for the sendRequest interface.
static int	TF_ASYNC	Indicates that the sendRequest interface is called in asynchronous mode.
static int	TF_SYNC	Indicates that the sendRequest interface is called in synchronous mode.
static int	TF_WAIT_TIME	Indicates that wait seconds of sync call.

构造器概要

构造器

构造器	说明
MessageOption()	Constructs a default MessageOption object.
MessageOption(int flags)	Constructs a specified MessageOption object using the flag specified in flags.
MessageOption(int flags, int waitTime)	Constructs a specified MessageOption object using the flag specified in flags.

方法概要

限定符和类型	方法	说明
int	getFlags()	Obtains a synchronous or asynchronous messaging flag of a MessageOption object.
int	getWaitTime()	Obtains the wait time.
void	setFlags(int flag)	Sets a synchronous or asynchronous messaging flag for a MessageOption object.
void	setWaitTime(int waitTime)	Sets the time to wait before determining a request timeout.

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

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

字段详细资料

TF_ACCEPT_FDS

public static final int TF_ACCEPT_FDS

Indicates that file descriptors can be returned for the sendRequest interface.

另请参阅:

常量字段值

TF_ASYNC

public static final int TF_ASYNC

Indicates that the sendRequest interface is called in asynchronous mode.

另请参阅:

常量字段值

TF_SYNC

public static final int TF_SYNC

Indicates that the sendRequest interface is called in synchronous mode.

另请参阅:

常量字段值

TF_WAIT_TIME

public static final int TF_WAIT_TIME

Indicates that wait seconds of sync call.

另请参阅:

常量字段值

构造器详细资料

MessageOption

public MessageOption()

Constructs a default MessageOption object.

The default MessageOption object uses synchronous messaging.

从以下版本开始:

1

MessageOption

public MessageOption(int flags)

Constructs a specified MessageOption object using the flag specified in flags.

参数:

flags - Indicates the flag to use for creating the object, TF_SYNC for synchronous call and TF_ASYNC for asynchronous call.

从以下版本开始:

1

MessageOption

public MessageOption(int flags,
                     int waitTime)

Constructs a specified MessageOption object using the flag specified in flags.

参数:

flags - Indicates the flag to use for creating the object, TF_SYNC for synchronous call and TF_ASYNC for asynchronous call.

waitTime - Indicates TF_WAIT_TIME for synchronous call wait seconds to use for creating the object.

从以下版本开始:

4

方法详细资料

setFlags

public void setFlags(int flag)

Sets a synchronous or asynchronous messaging flag for a MessageOption object.

参数:

flag - Indicates the flag to set, TF_SYNC for synchronous messaging and TF_ASYNC for asynchronous messaging.

从以下版本开始:

1

getFlags

public int getFlags()

Obtains a synchronous or asynchronous messaging flag of a MessageOption object.

返回:

Returns the synchronous or asynchronous messaging flag of the MessageOption object.

从以下版本开始:

1

setWaitTime

public void setWaitTime(int waitTime)

Sets the time to wait before determining a request timeout.

This method is usually used to set a long wait time when the writeRawData method is called to send a large volume of data in cross-device communications. After the wait time expires, the sender deems that the request has timed out. The default wait time is TF_WAIT_TIME.

When setting the wait time, you should consider the time consumed when the receiver returns a large volume of data by calling the writeRawData method.

Permissions: ohos.permission.DISTRIBUTED_DATASYNC

参数:

waitTime - Indicates the wait time to set.

从以下版本开始:

4

getWaitTime

public int getWaitTime()

Obtains the wait time.

After the wait time expires, the sender deems that the request has timed out.

Permissions: ohos.permission.DISTRIBUTED_DATASYNC

返回:

Returns the wait time.

从以下版本开始:

4