Package org.miaixz.bus.http

Class Stomp

java.lang.Object

org.miaixz.bus.http.Stomp

public class Stomp
extends Object

Websockt 的 Stomp 客户端

Since:

Java 17+

Author:

Kimi Liu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Stomp.Header
static class	Stomp.Message

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTO_ACK
static final String	CLIENT_ACK
static final String	SUPPORTED_VERSIONS

Method Summary

Modifier and Type	Method	Description
void	ack(Stomp.Message message)	确认收到某条消息
Stomp	connect()	连接 Stomp 服务器
Stomp	connect(List<Stomp.Header> headers)	连接 Stomp 服务器
void	disconnect()
static Stomp	over(CoverCall.Client task)	构建 Stomp 客户端（自动确定消息）
static Stomp	over(CoverCall.Client task, boolean autoAck)	构建 Stomp 客户端
Stomp	queue(String destination, List<Stomp.Header> headers, Callback<Stomp.Message> callback)	监听队列消息
Stomp	queue(String destination, Callback<Stomp.Message> callback)	监听队列消息
void	send(Stomp.Message message)	发送消息给服务器
void	sendTo(String destination, String data)	发送消息到指定目的地
void	setLegacyWhitespace(boolean legacyWhitespace)
Stomp	setOnConnected(Callback<Stomp> onConnected)	连接成功回调
Stomp	setOnDisconnected(Callback<CoverCall.Close> onDisconnected)	连接断开回调
Stomp	setOnError(Callback<Stomp.Message> onError)	错误回调（服务器返回的错误信息）
Stomp	subscribe(String destination, List<Stomp.Header> headers, Callback<Stomp.Message> callback)	订阅消息
Stomp	topic(String destination, List<Stomp.Header> headers, Callback<Stomp.Message> callback)	监听主题消息
Stomp	topic(String destination, Callback<Stomp.Message> callback)	监听主题消息
void	unqueue(String destination)	取消队列监听
void	unsubscribe(String destination)	取消订阅
void	untopic(String destination)	取消主题监听

Methods inherited from class java.lang.Object

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

Field Details

SUPPORTED_VERSIONS

public static final String SUPPORTED_VERSIONS

See Also:

• Constant Field Values

AUTO_ACK

public static final String AUTO_ACK

See Also:

• Constant Field Values

CLIENT_ACK

public static final String CLIENT_ACK

See Also:

• Constant Field Values

Method Details

over

public static Stomp over(CoverCall.Client task)

构建 Stomp 客户端（自动确定消息）

Parameters:

task - 底层的 WebSocket 连接

Returns:

Stomp

over

public static Stomp over(CoverCall.Client task,
 boolean autoAck)

构建 Stomp 客户端

Parameters:

task - 底层的 WebSocket 连接

autoAck - 是否自动确定消息

Returns:

Stomp

connect

public Stomp connect()

连接 Stomp 服务器

Returns:

Stomp

connect

public Stomp connect(List<Stomp.Header> headers)

连接 Stomp 服务器

Parameters:

headers - Stomp 头信息

Returns:

Stomp

disconnect

public void disconnect()

setOnConnected

public Stomp setOnConnected(Callback<Stomp> onConnected)

连接成功回调

Parameters:

onConnected - 连接成功回调

Returns:

Stomp

setOnDisconnected

public Stomp setOnDisconnected(Callback<CoverCall.Close> onDisconnected)

连接断开回调

Parameters:

onDisconnected - 断开连接回调

Returns:

Stomp

setOnError

public Stomp setOnError(Callback<Stomp.Message> onError)

错误回调（服务器返回的错误信息）

Parameters:

onError - 错误回调

Returns:

Stomp

sendTo

public void sendTo(String destination,
 String data)

发送消息到指定目的地

Parameters:

destination - 目的地

data - 消息

send

public void send(Stomp.Message message)

发送消息给服务器

Parameters:

message - 消息

topic

public Stomp topic(String destination,
 Callback<Stomp.Message> callback)

监听主题消息

Parameters:

destination - 监听地址

callback - 消息回调

Returns:

Stomp

topic

public Stomp topic(String destination,
 List<Stomp.Header> headers,
 Callback<Stomp.Message> callback)

监听主题消息

Parameters:

destination - 监听地址

headers - 附加头信息

callback - 消息回调

Returns:

Stomp

queue

public Stomp queue(String destination,
 Callback<Stomp.Message> callback)

监听队列消息

Parameters:

destination - 监听地址

callback - 消息回调

Returns:

Stomp

queue

public Stomp queue(String destination,
 List<Stomp.Header> headers,
 Callback<Stomp.Message> callback)

监听队列消息

Parameters:

destination - 监听地址

headers - 附加头信息

callback - 消息回调

Returns:

Stomp

subscribe

public Stomp subscribe(String destination,
 List<Stomp.Header> headers,
 Callback<Stomp.Message> callback)

订阅消息

Parameters:

destination - 订阅地址

headers - 附加头信息

callback - 消息回调

Returns:

Stomp

ack

public void ack(Stomp.Message message)

确认收到某条消息

Parameters:

message - 服务器发过来的消息

untopic

public void untopic(String destination)

取消主题监听

Parameters:

destination - 监听地址

unqueue

public void unqueue(String destination)

取消队列监听

Parameters:

destination - 监听地址

unsubscribe

public void unsubscribe(String destination)

取消订阅

Parameters:

destination - 订阅地址

setLegacyWhitespace

public void setLegacyWhitespace(boolean legacyWhitespace)