README.md

   1 # stompngo - A STOMP 1.0, 1.1 and 1.2 Client Package #
   2
   3 ## Features ##
   4
   5 * Full support of STOMP protocols:
   6
   7     1. [Protocol Level 1.0](http://stomp.github.com/stomp-specification-1.0.html)
   8     2. [Protocol Level 1.1](http://stomp.github.com/stomp-specification-1.1.html)
   9     3. [Protocol Level 1.2](http://stomp.github.com/stomp-specification-1.2.html)
  10
  11 ## References ##
  12
  13 * [STOMP 1.0 Protocol](http://stomp.github.com/stomp-specification-1.0.html)
  14 * [STOMP 1.1 Protocol](http://stomp.github.com/stomp-specification-1.1.html)
  15 * [STOMP 1.2 Protocol](http://stomp.github.com/stomp-specification-1.2.html)
  16
  17 ## Installation ##
  18
  19 Installation requires a working go environment. For current versions of go
  20 issue:
  21
  22 * go get github.com/gmallard/stompngo
  23
  24 The GOPATH environment variable must be set properly.
  25
  26 It is also possible to just clone the stompngo repository to any location of
  27 choice, and use go modules to locate it.
  28
  29 ## Examples ##
  30
  31 The examples in the included unit tests can be used as a good starting point.
  32
  33 Also see the examples project:
  34
  35 * [stompngo_examples at github](https://github.com/gmallard/stompngo_examples)
  36
  37 ## QA ##
  38
  39 The tests for this STOMP client package run against recent releases of:
  40
  41 * [ActiveMQ](http://activemq.apache.org/)
  42 * [stompserver_ng](https://github.com/gmallard/stompserver_ng)
  43 * [Apache Apollo](http://activemq.apache.org/apollo/)
  44 * [RabbitMQ](http://www.rabbitmq.com/)
  45 * [Artemis](https://activemq.apache.org/artemis/)
  46
  47 See the tests for **relevant environment variables**.
  48
  49 **NOTE:** For testing with rabbitmq, you also need `export STOMP_RMQ="/"` due to the default vhost of rabbitmq is "/" instead of "localhost".
  50
  51 ## Contributions ##
  52
  53 Any and all are welcome by pull request or e-mail patch.
  54
  55 ## Wiki ##
  56
  57 News and notes will be posted from time to time at the stompngo wiki:
  58
  59 * [stompngo wiki](https://github.com/gmallard/stompngo/wiki)
  60
  61 Please review and update that on occaision.
  62
  63 ## Canonical Repository ##
  64
  65 For the record, the canonical repository for this project is at:
  66
  67 * [stompngo at github](https://github.com/gmallard/stompngo)
  68
  69 ## Issues ##
  70
  71 Please review issues at the canonical repository.  File any new issues there as
  72 well:
  73
  74 * [issues](https://github.com/gmallard/stompngo/issues?sort=comments&state=open)
  75
  76 ## Contributors (by first author date) ##
  77
  78 Contribution information (maintained semiautomatically, best efforts basis):
  79
  80 <table border="1" style="width:100%;border: 1px solid black;">
  81 <tr>
  82 <th style="border: 1px solid black;padding-left: 10px;" >
  83 First Author Date
  84 </th>
  85 <th style="border: 1px solid black;padding-left: 10px;" >
  86 (Commit Count)
  87 </th>
  88 <th style="border: 1px solid black;padding-left: 10px;" >
  89 Name / E-mail
  90 </th>
  91 </tr>
  92 <tr>
  93 <td style="border: 1px solid black;padding-left: 10px;" >
  94 2011-10-10
  95 </td>
  96 <td style="border: 1px solid black;padding-left: 10px;" >
  97 (0240)
  98 </td>
  99 <td style="border: 1px solid black;padding-left: 10px;" >
 100 <span style="font-weight: bold;" >
 101 gmallard
 102 </span>
 103  / &lt;allard.guy.m@gmail.com&gt;
 104 </td>
 105 </tr>
 106 <tr>
 107 <td style="border: 1px solid black;padding-left: 10px;" >
 108 2014-02-02
 109 </td>
 110 <td style="border: 1px solid black;padding-left: 10px;" >
 111 (0001)
 112 </td>
 113 <td style="border: 1px solid black;padding-left: 10px;" >
 114 <span style="font-weight: bold;" >
 115 Kelsey Hightower
 116 </span>
 117  / &lt;kelsey.hightower@gmail.com&gt;
 118 </td>
 119 </tr>
 120 <tr>
 121 <td style="border: 1px solid black;padding-left: 10px;" >
 122 2014-12-12
 123 </td>
 124 <td style="border: 1px solid black;padding-left: 10px;" >
 125 (0001)
 126 </td>
 127 <td style="border: 1px solid black;padding-left: 10px;" >
 128 <span style="font-weight: bold;" >
 129 Logan Attwood
 130 </span>
 131  / &lt;logan@therounds.ca&gt;
 132 </td>
 133 </tr>
 134 <tr>
 135 <td style="border: 1px solid black;padding-left: 10px;" >
 136 2015-04-16
 137 </td>
 138 <td style="border: 1px solid black;padding-left: 10px;" >
 139 (0002)
 140 </td>
 141 <td style="border: 1px solid black;padding-left: 10px;" >
 142 <span style="font-weight: bold;" >
 143 Max Garvey
 144 </span>
 145  / &lt;mgarvey@monsooncommerce.com&gt;
 146 </td>
 147 </tr>
 148 <tr>
 149 <td style="border: 1px solid black;padding-left: 10px;" >
 150 2016-04-11
 151 </td>
 152 <td style="border: 1px solid black;padding-left: 10px;" >
 153 (0001)
 154 </td>
 155 <td style="border: 1px solid black;padding-left: 10px;" >
 156 <span style="font-weight: bold;" >
 157 Joakim Sernbrant
 158 </span>
 159  / &lt;joakim.sernbrant@trioptima.com&gt;
 160 </td>
 161 </tr>
 162 <tr>
 163 <td style="border: 1px solid black;padding-left: 10px;" >
 164 2016-07-30
 165 </td>
 166 <td style="border: 1px solid black;padding-left: 10px;" >
 167 (0120)
 168 </td>
 169 <td style="border: 1px solid black;padding-left: 10px;" >
 170 <span style="font-weight: bold;" >
 171 Guy M. Allard
 172 </span>
 173  / &lt;allard.guy.m@gmail.com&gt;
 174 </td>
 175 </tr>
 176 <tr>
 177 <td style="border: 1px solid black;padding-left: 10px;" >
 178 2017-03-01
 179 </td>
 180 <td style="border: 1px solid black;padding-left: 10px;" >
 181 (0001)
 182 </td>
 183 <td style="border: 1px solid black;padding-left: 10px;" >
 184 <span style="font-weight: bold;" >
 185 Dan Corin
 186 </span>
 187  / &lt;danielcorin@users.noreply.github.com&gt;
 188 </td>
 189 </tr>
 190 <tr>
 191 <td style="border: 1px solid black;padding-left: 10px;" >
 192 2017-05-05
 193 </td>
 194 <td style="border: 1px solid black;padding-left: 10px;" >
 195 (0001)
 196 </td>
 197 <td style="border: 1px solid black;padding-left: 10px;" >
 198 <span style="font-weight: bold;" >
 199 Jason Libbey
 200 </span>
 201  / &lt;jlibbey@uber.com&gt;
 202 </td>
 203 </tr>
 204 <tr>
 205 <td style="border: 1px solid black;padding-left: 10px;" >
 206 2017-06-05
 207 </td>
 208 <td style="border: 1px solid black;padding-left: 10px;" >
 209 (0001)
 210 </td>
 211 <td style="border: 1px solid black;padding-left: 10px;" >
 212 <span style="font-weight: bold;" >
 213 Dan Corin
 214 </span>
 215  / &lt;dancorin@uber.com&gt;
 216 </td>
 217 </tr>
 218 <tr>
 219 <td style="border: 1px solid black;padding-left: 10px;" >
 220 2017-11-06
 221 </td>
 222 <td style="border: 1px solid black;padding-left: 10px;" >
 223 (0006)
 224 </td>
 225 <td style="border: 1px solid black;padding-left: 10px;" >
 226 <span style="font-weight: bold;" >
 227 tomsawyer
 228 </span>
 229  / &lt;tomsawyer126@gmail.com&gt;
 230 </td>
 231 </tr>
 232 <tr>
 233 <td style="border: 1px solid black;padding-left: 10px;" >
 234 2017-11-20
 235 </td>
 236 <td style="border: 1px solid black;padding-left: 10px;" >
 237 (0001)
 238 </td>
 239 <td style="border: 1px solid black;padding-left: 10px;" >
 240 <span style="font-weight: bold;" >
 241 itomsawyer
 242 </span>
 243  / &lt;tomsawyer126@gmail.com&gt;
 244 </td>
 245 </tr>
 246 <tr>
 247 <td style="border: 1px solid black;padding-left: 10px;" >
 248 2018-03-12
 249 </td>
 250 <td style="border: 1px solid black;padding-left: 10px;" >
 251 (0001)
 252 </td>
 253 <td style="border: 1px solid black;padding-left: 10px;" >
 254 <span style="font-weight: bold;" >
 255 GAOXIANG4
 256 </span>
 257  / &lt;gaoxiang4@kingsoft.com&gt;
 258 </td>
 259 </tr>
 260 </table>