extra_doc/API.md in onstomp-1.0.5 vs extra_doc/API.md in onstomp-1.0.6
- old
+ new
@@ -13,18 +13,42 @@
</thead>
<tfoot>
</tfoot>
<tbody>
<tr>
+ <td>{OnStomp::Interfaces::ClientEvents#:begin :begin}</td>
+ <td>
+ <code>:begin</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
+ <td>{OnStomp::Interfaces::ClientEvents#abort abort}</td>
+ <td>
+ <code>abort</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
<td>{OnStomp::Interfaces::FrameMethods#abort abort}</td>
<td>
<code>abort(tx_id, headers=<optional hash>)</code>
</td>
<td style="background-color: #bfb;">true</td>
<td style="background-color: #bfb;">true</td>
</tr>
<tr>
+ <td>{OnStomp::Interfaces::ClientEvents#ack ack}</td>
+ <td>
+ <code>ack</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
<td>{OnStomp::Interfaces::FrameMethods#ack ack}</td>
<td>
<code>ack(message_frame, headers=<optional hash>)</code>
</td>
<td style="background-color: #bfb;">true</td>
@@ -205,26 +229,74 @@
</td>
<td style="background-color: #bfb;">true</td>
<td style="background-color: #bfb;">true</td>
</tr>
<tr>
+ <td>{OnStomp::Interfaces::ConnectionEvents#blocked blocked}</td>
+ <td>
+ <code>blocked</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
+ <td>{OnStomp::Interfaces::ClientEvents#broker_beat broker_beat}</td>
+ <td>
+ <code>broker_beat</code>
+ </td>
+ <td style="background-color: #fbb;">false</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
+ <td>{OnStomp::Interfaces::ClientEvents#client_beat client_beat}</td>
+ <td>
+ <code>client_beat</code>
+ </td>
+ <td style="background-color: #fbb;">false</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
<td>{OnStomp::Client#close! close!}</td>
<td>
<code>close!( )</code>
</td>
<td style="background-color: #bfb;">true</td>
<td style="background-color: #bfb;">true</td>
</tr>
<tr>
+ <td>{OnStomp::Interfaces::ConnectionEvents#closed closed}</td>
+ <td>
+ <code>closed</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
+ <td>{OnStomp::Interfaces::ClientEvents#commit commit}</td>
+ <td>
+ <code>commit</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
<td>{OnStomp::Interfaces::FrameMethods#commit commit}</td>
<td>
<code>commit(tx_id, headers=<optional hash>)</code>
</td>
<td style="background-color: #bfb;">true</td>
<td style="background-color: #bfb;">true</td>
</tr>
<tr>
+ <td>{OnStomp::Interfaces::ClientEvents#connect connect}</td>
+ <td>
+ <code>connect</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
<td>{OnStomp::Client#connect connect}</td>
<td>
<code>connect(headers=<optional hash>)</code>
</td>
<td style="background-color: #bfb;">true</td>
@@ -237,10 +309,26 @@
</td>
<td style="background-color: #bfb;">true</td>
<td style="background-color: #bfb;">true</td>
</tr>
<tr>
+ <td>{OnStomp::Interfaces::ConnectionEvents#died died}</td>
+ <td>
+ <code>died</code>
+ </td>
+ <td style="background-color: #fbb;">false</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
+ <td>{OnStomp::Interfaces::ClientEvents#disconnect disconnect}</td>
+ <td>
+ <code>disconnect</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
<td>{OnStomp::Client#disconnect disconnect}</td>
<td>
<code>disconnect_with_flush(headers=<optional hash>)</code>
</td>
<td style="background-color: #bfb;">true</td>
@@ -261,29 +349,61 @@
</td>
<td style="background-color: #bfb;">true</td>
<td style="background-color: #bfb;">true</td>
</tr>
<tr>
+ <td>{OnStomp::Interfaces::ClientEvents#error error}</td>
+ <td>
+ <code>error</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
+ <td>{OnStomp::Interfaces::ConnectionEvents#established established}</td>
+ <td>
+ <code>established</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
<td>{OnStomp::Client#initialize initialize}</td>
<td>
<code>initialize(uri, options=<optional hash>)</code>
</td>
<td style="background-color: #bfb;">true</td>
<td style="background-color: #bfb;">true</td>
</tr>
<tr>
+ <td>{OnStomp::Interfaces::ClientEvents#message message}</td>
+ <td>
+ <code>message</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
<td>{OnStomp::Interfaces::FrameMethods#nack nack}</td>
<td>
- <code>nack(message_id, subscription_id, heders=<optional hash>)</code>
+ <code>nack(message_frame, headers=<optional hash>)</code>
</td>
<td style="background-color: #fbb;">false</td>
<td style="background-color: #bfb;">true</td>
</tr>
<tr>
+ <td>{OnStomp::Interfaces::ClientEvents#nack nack}</td>
+ <td>
+ <code>nack</code>
+ </td>
+ <td style="background-color: #fbb;">false</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
<td>{OnStomp::Interfaces::FrameMethods#nack nack}</td>
<td>
- <code>nack(message_frame, headers=<optional hash>)</code>
+ <code>nack(message_id, subscription_id, heders=<optional hash>)</code>
</td>
<td style="background-color: #fbb;">false</td>
<td style="background-color: #bfb;">true</td>
</tr>
<tr>
@@ -461,26 +581,74 @@
</td>
<td style="background-color: #bfb;">true</td>
<td style="background-color: #bfb;">true</td>
</tr>
<tr>
+ <td>{OnStomp::Interfaces::ClientEvents#receipt receipt}</td>
+ <td>
+ <code>receipt</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
+ <td>{OnStomp::Interfaces::ClientEvents#receiving receiving}</td>
+ <td>
+ <code>receiving</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
<td>{OnStomp::Interfaces::FrameMethods#send send}</td>
<td>
<code>send(dest, body, headers=<optional hash>, &cb)</code>
</td>
<td style="background-color: #bfb;">true</td>
<td style="background-color: #bfb;">true</td>
</tr>
<tr>
+ <td>{OnStomp::Interfaces::ClientEvents#send send}</td>
+ <td>
+ <code>send</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
+ <td>{OnStomp::Interfaces::ClientEvents#subscribe subscribe}</td>
+ <td>
+ <code>subscribe</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
<td>{OnStomp::Interfaces::FrameMethods#subscribe subscribe}</td>
<td>
<code>subscribe(dest, headers=<optional hash>, &cb)</code>
</td>
<td style="background-color: #bfb;">true</td>
<td style="background-color: #bfb;">true</td>
</tr>
<tr>
+ <td>{OnStomp::Interfaces::ConnectionEvents#terminated terminated}</td>
+ <td>
+ <code>terminated</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
+ <td>{OnStomp::Interfaces::ClientEvents#transmitting transmitting}</td>
+ <td>
+ <code>transmitting</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
<td>{OnStomp::Interfaces::FrameMethods#unsubscribe unsubscribe}</td>
<td>
<code>unsubscribe(subscribe_frame, headers=<optional hash>)</code>
</td>
<td style="background-color: #bfb;">true</td>
@@ -488,9 +656,17 @@
</tr>
<tr>
<td>{OnStomp::Interfaces::FrameMethods#unsubscribe unsubscribe}</td>
<td>
<code>unsubscribe(id, headers=<optional hash>)</code>
+ </td>
+ <td style="background-color: #bfb;">true</td>
+ <td style="background-color: #bfb;">true</td>
+ </tr>
+ <tr>
+ <td>{OnStomp::Interfaces::ClientEvents#unsubscribe unsubscribe}</td>
+ <td>
+ <code>unsubscribe</code>
</td>
<td style="background-color: #bfb;">true</td>
<td style="background-color: #bfb;">true</td>
</tr>
</tbody>