WebSocket - Stomp API - 《Java 技术知识》

一、概述
二、实例方法总结
三、构造函数详细信息
Stomp~client、Stomp~over 或 {overTCP} 方法之一。
See also:">(void) constructor(ws_fn) Private
请不要直接创建该类的实例，使用 Stomp 中的Stomp~client、Stomp~over 或 {overTCP} 方法之一。
See also:
- 四、实例方法详细信息
- 参考资料

一、概述

STOMP 客户端类
所有 STOMP 协议都公开为此类的方法（connect(), send()等）

二、实例方法总结

# (void)debug(message)
- 默认情况下，调试消息会记录在窗口的控制台中（如果已定义）。
~ (void)connect(headers, connectCallback)
- 该connect方法接受不同数量的参数和类型。
# (void)disconnect(disconnectCallback, headers = {})
- 断开与 STOMP 代理的连接。
# (void)send(destination, headers = {}, body = ‘’)
- 向指定目的地发送消息。
# (Object)subscribe(destination, callback, headers = {})
- 订阅 STOMP Broker位置。
# (void)unsubscribe(id, headers = {})
- 最好通过直接对客户端client.subscribe()返回的对象调用unsubscribe()来取消订阅。
# (Object)begin(transaction_id)
- 开始一个事务，返回的Object对象有commit和abort方法
# (void)commit(transaction_id)
- 提交事务。
# (void)abort(transaction_id)
- 中止事务。
# (void)ack(messageID, subscription, headers = {})
- 告知收到消息。（ACK是acknowledge的前三个字母。）
# (void)nack(messageID, subscription, headers = {})
- 告知没有收到消息。（NACK表示Non-ACK）
  三、构造函数详细信息
  (void) constructor(ws_fn) Private
  请不要直接创建该类的实例，使用 Stomp 中的Stomp~client、Stomp~over 或 {overTCP} 方法之一。
  See also:
Stomp

四、实例方法详细信息

1.debug()
```
# (void) debug(message)
```
注意： 默认可以在控制台生成大量日志。将其设置为空功能以禁用
默认情况下，调试消息会记录在窗口的控制台中（如果已定义）。每次通过 WebSocket 实际传输 STOMP 帧时都会调用此方法。
可以在客户端实例上设置一个方法debug(message)来以不同的方式处理调试消息：
Examples:
```
client.debug = function(str) {
    // append the debug log to a #debug div
    $("#debug").append(str + "\n");
};
```
禁用日志记录
```
client.debug = function(str) {};
```
参数：
message ( String )

2.connect()

~ (void) connect(headers, connectCallback)
~ (void) connect(headers, connectCallback, errorCallback)
~ (void) connect(login, passcode, connectCallback)
~ (void) connect(login, passcode, connectCallback, errorCallback)
~ (void) connect(login, passcode, connectCallback, errorCallback, closeEventCallback)
~ (void) connect(login, passcode, connectCallback, errorCallback, closeEventCallback, host)

注意： 当自动重新连接处于活动状态时，connectCallback将errorCallback在每次连接或错误时调用
该connect方法接受不同数量的参数和类型。请参阅重载列表。使用带有标头的版本来传递您的代理特定选项。
例子：

client.connect('guest, 'guest', function(frame) {
  client.debug("connected to Stomp");
  client.subscribe(destination, function(message) {
    $("#messages").append("<p>" + message.body + "</p>\n");
  });
});

参数：

headers ( Object )
connectCallback ( function(Frame) ) — Called upon a successful connect or reconnect
errorCallback ( function(any) ) — Optional, called upon an error. The passed paramer may be a Frame or a message
closeEventCallback ( function(CloseEvent) ) — Optional, called when the websocket is closed.
login ( String )
passcode ( String )
host ( String ) — Optional, virtual host to connect to. STOMP 1.2 makes it mandatory, however the broker may not mandate it

Options Hash: (headers):

login ( String )
passcode ( String )
host ( String ) — virtual host to connect to. STOMP 1.2 makes it mandatory, however the broker may not mandate it

See also:

CONNECT Frame

Overloads:

~ (void) connect(headers, connectCallback)
~ (void) connect(headers, connectCallback, errorCallback)
~ (void) connect(login, passcode, connectCallback)
~ (void) connect(login, passcode, connectCallback, errorCallback)
~ (void) connect(login, passcode, connectCallback, errorCallback, closeEventCallback)
~ (void) connect(login, passcode, connectCallback, errorCallback, closeEventCallback, host)

3.disconnect()

# (void) disconnect(disconnectCallback, headers = {})

断开与 STOMP 代理的连接。为了确保正常关闭，它会发送一个 DISCONNECT 帧并等待代理确认。
disconnectCallback 仅在代理实际连接时才会被调用。
参数：

disconnectCallback ( function() )
headers ( Object ) — optional

See also:

DISCONNECT Frame

4.send()

# (void) send(destination, headers = {}, body = '')

注意： 正文必须是字符串。您需要将有效负载转换为字符串，以防它不是字符串（例如 JSON）
向指定目的地发送消息。有关目的地的类型和命名，请参阅您的 STOMP 代理文档。标头通常对订阅者可用。但是，可能有与您的 STOMP 代理相对应的特殊用途标头。
Examples:

client.send("/queue/test", {priority: 9}, "Hello, STOMP");

payload without headers

 # If you want to send a message with a body, you must also pass the headers argument.
 client.send("/queue/test", {}, "Hello, STOMP");

Parameters:

destination ( String ) — mandatory
headers ( Object ) — Optional
body ( String ) — Optional

See also:

SEND Frame

5.subscribe()

# (Object) subscribe(destination, callback, headers = {})

注意： 如果标题中没有提供任何 ID，则库将生成唯一 ID。要使用您自己的 ID，请使用 headers 参数传递它
订阅 STOMP 经纪人位置。返回值是一个带有取消订阅方法的对象。
var subscription = client.subscribe(“/queue/test”, callback);
Examples:

 callback = function(message) {
   // called when the client receives a STOMP message from the server
   if (message.body) {
     alert("got message with body " + message.body)
   } else
   {
     alert("got empty message");
   }
 });

Explicit subscription id

var mysubid = 'my-subscription-id-001';
var subscription = client.subscribe(destination, callback, { id: mysubid });

Parameters:

destination ( String )
callback ( function(message) )
headers ( Object ) — optional

Returns:

( Object ) — this object has a method to unsubscribe

See also:

SUBSCRIBE Frame

6.unsubscribe()

# (void) unsubscribe(id, headers = {})

最好通过直接对客户端client.subscribe()返回的对象调用unsubscribe()来取消订阅。
Examples:

  var subscription = client.subscribe(destination, onmessage);
  ...
  subscription.unsubscribe();

Parameters:

id ( String )
headers ( Object ) — optional

See also:

UNSUBSCRIBE Frame

7.begin()

# (Object) begin(transaction_id)

注意： 如果没有传递交易ID，则会自动创建一个
开始一个事务，返回的Object对象有commit和abort方法
Parameters:

transaction_id ( String ) — optional

Returns:

( Object ) — member, id - transaction id, methods commit and abort

See also:

BEGIN Frame

8.commit()

# (void) commit(transaction_id)

提交事务。最好通过直接对客户端client.begin()返回的对象调用commit()来提交事务。
Examples:
var tx = client.begin(txid); … tx.commit();
Parameters:

transaction_id ( String )

See also:

COMMIT Frame

9.abort()

# (void) abort(transaction_id)

中止事务。最好通过直接对客户端client.begin()返回的对象调用abort()来中止事务。
Examples:
var tx = client.begin(txid); … tx.abort();
Parameters:

transaction_id ( String )

See also:

ABORT Frame

10.ack()

# (void) ack(messageID, subscription, headers = {})

告知收到消息。最好通过直接对订阅回调处理的消息调用ack()来告知收到消息
Examples:

  client.subscribe(destination,
    function(message) {
      // process the message
      // acknowledge it
      message.ack();
    },
    {'ack': 'client'}
  );

Parameters:

messageID ( String )
subscription ( String )
headers ( Object ) — optional

See also:

ACK Frame

11.nack()

# (void) nack(messageID, subscription, headers = {})

告知没有收到消息。最好通过直接对订阅回调处理的消息调用nack()来告知没有收到消息
Examples:

  client.subscribe(destination,
    function(message) {
      // process the message
      // an error occurs, nack it
      message.nack();
    },
    {'ack': 'client'}
  );

Parameters:

messageID ( String )
subscription ( String )
headers ( Object ) — optional

See also:

NACK Frame
参考资料
https://stomp-js.github.io/stomp-websocket/codo/class/Client.html

Stomp API

一、概述

二、实例方法总结

三、构造函数详细信息

(void) constructor(ws_fn) Private请不要直接创建该类的实例，使用 Stomp 中的Stomp~client、Stomp~over 或 {overTCP} 方法之一。See also:

四、实例方法详细信息

1.debug()

2.connect()

3.disconnect()

4.send()

5.subscribe()

6.unsubscribe()

7.begin()

8.commit()

9.abort()

10.ack()

11.nack()

参考资料

(void) constructor(ws_fn) Private
请不要直接创建该类的实例，使用 Stomp 中的Stomp~client、Stomp~over 或 {overTCP} 方法之一。
See also: