鸿蒙OS开发文档 鸿蒙OS MessageOption

2024-02-25 开发教程 鸿蒙OS开发文档 匿名 1

MessageOption

java.lang.Object
|---ohos.rpc.MessageOption

public class MessageOption
extends Object

定义与 sendRequest 一起发送消息的选项。

字段摘要

修饰符和类型字段描述
static intTF_ACCEPT_FDS表示可以为 sendRequest 接口返回文件描述符。
static intTF_ASYNC表示以异步方式调用 sendRequest 接口。
static intTF_SYNC表示以同步方式调用 sendRequest 接口。
static intTF_WAIT_TIME表示等待同步调用的秒数。

构造函数摘要

构造函数描述
MessageOption()构造一个默认的 MessageOption 对象。
MessageOption(int flags)使用 flags 中指定的标志构造指定的 MessageOption 对象。
MessageOption(int flags, int waitTime)使用 flags 中指定的标志构造指定的 MessageOption 对象。

方法总结

修饰符和类型方法描述
intgetFlags()获取 MessageOption 对象的同步或异步消息标志。
intgetWaitTime()获取等待时间。
voidsetFlags(int flag)为 MessageOption 对象设置同步或异步消息传递标志。
voidsetWaitTime(int waitTime)设置在确定请求超时之前等待的时间。
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细信息

TF_ACCEPT_FDS

public static final int TF_ACCEPT_FDS

表示可以为 sendRequest 接口返回文件描述符。

TF_ASYNC

public static final int TF_ASYNC

表示以异步方式调用 sendRequest 接口。

TF_SYNC

public static final int TF_SYNC

表示以同步方式调用 sendRequest 接口。

TF_WAIT_TIME

public static final int TF_WAIT_TIME

表示等待同步调用的秒数。

构造函数详细信息

MessageOption

public MessageOption()

构造一个默认的 MessageOption 对象。

默认 MessageOption 对象使用同步消息传递。

MessageOption

public MessageOption(int flags)

使用 flags 中指定的标志构造指定的 MessageOption 对象。

参数:

参数名称参数描述
flags指示用于创建对象的标志,TF_SYNC 用于同步调用,TF_ASYNC 用于异步调用。

MessageOption

public MessageOption(int flags, int waitTime)

使用 flags 中指定的标志构造指定的 MessageOption 对象。

参数:

参数名称参数描述
flags指示用于创建对象的标志,TF_SYNC 用于同步调用,TF_ASYNC 用于异步调用。
waitTime指示用于创建对象的同步调用等待秒数的 TF_WAIT_TIME。

方法详情

setFlags

public void setFlags(int flag)

为 MessageOption 对象设置同步或异步消息传递标志。

参数:

参数名称参数描述
flag指示要设置的标志,TF_SYNC 用于同步消息传递,TF_ASYNC 用于异步消息传递。

getFlags

public int getFlags()

获取 MessageOption 对象的同步或异步消息标志。

返回:

返回 MessageOption 对象的同步或异步消息传递标志。

setWaitTime

public void setWaitTime(int waitTime)

设置在确定请求超时之前等待的时间。

该方法通常用于在跨设备通信中调用 writeRawData 方法发送大量数据时设置较长的等待时间。 等待时间到期后,发送方认为请求超时。 默认等待时间为 TF_WAIT_TIME。

设置等待时间时,应考虑接收方调用 writeRawData 方法返回大量数据所消耗的时间。

权限:ohos.permission.DISTRIBUTED_DATASYNC

参数:

参数名称参数描述
waitTime表示要设置的等待时间。

getWaitTime

public int getWaitTime()

获取等待时间。

等待时间到期后,发送方认为请求超时。

权限:ohos.permission.DISTRIBUTED_DATASYNC

返回:

返回等待时间。