模块 okhttps.stomp
程序包 com.ejlchina.stomp

类 Stomp

  • public class Stomp
extends Object
    基于 OkHttps websockt 的 Stomp 客户端

    • 方法详细资料

      • over

        public static Stomp over​(WHttpTask task)
        构建 Stomp 客户端（自动确定消息）
        参数:
        task - 底层的 WebSocket 连接
        返回:
        Stomp

      • over

        public static Stomp over​(WHttpTask task,
                         boolean autoAck)
        构建 Stomp 客户端
        参数:
        task - 底层的 WebSocket 连接
        autoAck - 是否自动确定消息
        返回:
        Stomp

      • isAutoAck

        public boolean isAutoAck()
        返回:
        是否自动确认消息
        从以下版本开始:
        2.5.0

      • connect

        public Stomp connect()
        连接 Stomp 服务器
        返回:
        Stomp

      • connect

        public Stomp connect​(List<Header> headers)
        连接 Stomp 服务器
        参数:
        headers - Stomp 头信息
        返回:
        Stomp

      • isConnected

        public boolean isConnected()
        返回:
        是否已连接
        从以下版本开始:
        2.5.0

      • isConnecting

        public boolean isConnecting()
        返回:
        是否正在连接
        从以下版本开始:
        3.1.0

      • isDisconnecting

        public boolean isDisconnecting()
        返回:
        是否正在断开连接
        从以下版本开始:
        3.1.0

      • disconnect

        public void disconnect()
        断开连接，将先发送 DISCONNECT 消息给服务器，服务器回复后断开连接 默认等待服务器为 10 秒，10秒后自动关闭

      • disconnect

        public void disconnect​(int maxWaitSeconds)
        参数:
        maxWaitSeconds - 最大等待服务器回复时间，超出后自动关闭
        从以下版本开始:
        v3.1.0 断开连接，将先发送 DISCONNECT 消息给服务器，服务器回复后断开连接

      • disconnect

        public void disconnect​(boolean immediate)
        断开连接
        参数:
        immediate - 是否立即断开
        从以下版本开始:
        v3.1.0

      • setOnConnected

        public Stomp setOnConnected​(Consumer<Stomp> onConnected)
        连接成功回调
        参数:
        onConnected - 连接成功回调
        返回:
        Stomp

      • setOnDisconnected

        public Stomp setOnDisconnected​(Consumer<WebSocket.Close> onDisconnected)
        连接断开回调
        参数:
        onDisconnected - 断开连接回调
        返回:
        Stomp

      • setOnException

        public Stomp setOnException​(Consumer<Throwable> onException)
        错误回调（底层连接异常）
        参数:
        onException - 异常回调
        返回:
        Stomp
        从以下版本开始:
        v3.1.1

      • setOnError

        public Stomp setOnError​(Consumer<Message> onError)
        错误回调（服务器返回的错误信息）
        参数:
        onError - 错误回调
        返回:
        Stomp

      • sendToTopic

        public void sendToTopic​(String destination,
                        String data)
        参数:
        destination - 目的地
        data - 消息
        从以下版本开始:
        2.5.0 发送消息到主题

      • sendToQueue

        public void sendToQueue​(String destination,
                        String data)
        参数:
        destination - 目的地
        data - 消息
        从以下版本开始:
        2.5.0 发送消息到队列

      • sendTo

        public void sendTo​(String destination,
                   String data)
        发送消息到指定目的地
        参数:
        destination - 目的地
        data - 消息

      • send

        public void send​(Message message)
        发送消息给服务器
        参数:
        message - 消息

      • topic

        public Stomp topic​(String destination,
                   Consumer<Message> callback)
        监听主题消息
        参数:
        destination - 监听地址
        callback - 消息回调
        返回:
        Stomp

      • topic

        public Stomp topic​(String destination,
                   List<Header> headers,
                   Consumer<Message> callback)
        监听主题消息
        参数:
        destination - 监听地址
        headers - 附加头信息
        callback - 消息回调
        返回:
        Stomp

      • queue

        public Stomp queue​(String destination,
                   Consumer<Message> callback)
        监听队列消息
        参数:
        destination - 监听地址
        callback - 消息回调
        返回:
        Stomp

      • queue

        public Stomp queue​(String destination,
                   List<Header> headers,
                   Consumer<Message> callback)
        监听队列消息
        参数:
        destination - 监听地址
        headers - 附加头信息
        callback - 消息回调
        返回:
        Stomp

      • subscribe

        public Stomp subscribe​(String destination,
                       List<Header> headers,
                       Consumer<Message> callback)
        订阅消息
        参数:
        destination - 订阅地址
        headers - 附加头信息
        callback - 消息回调
        返回:
        Stomp

      • ack

        public void ack​(Message message)
        确认收到某条消息
        参数:
        message - 服务器发过来的消息

      • untopic

        public void untopic​(String destination)
        取消主题监听
        参数:
        destination - 监听地址

      • unqueue

        public void unqueue​(String destination)
        取消队列监听
        参数:
        destination - 监听地址

      • unsubscribe

        public void unsubscribe​(String destination)
        取消订阅
        参数:
        destination - 订阅地址

      • getMsgCodec

        public MsgCodec getMsgCodec()

      • setMsgCodec

        public void setMsgCodec​(MsgCodec msgCodec)