EXAMPLES.md

   1 # stompngo_examples - Details #
   2
   3 ## Introduction  ##
   4
   5 This repository is a set of STOMP client examples using go.
   6
   7 These examples use the stomp client package here:
   8
   9 [stompngo STOMP client library](https://github.com/gmallard/stompngo)
  10
  11 The reader is urged to become familiar with the go documentaion
  12 for the *stompngo* package:
  13
  14 [stompngo documentation](http://godoc.org/github.com/gmallard/stompngo)<br />
  15 [stompngo wiki](https://github.com/gmallard/stompngo/wiki)
  16
  17 ## List of Individual Examples  ##
  18
  19 A brief explanation of the individual examples follows. The list of consistes
  20 of example go, Java, and properties files:
  21
  22 <table border="1" style="width:80%;border: 1px solid black;">
  23 <tr>
  24 <th style="width:20%;border: 1px solid black;padding-left: 10px;" >
  25 Example Name
  26 </th>
  27 <th style="width:60%border: 1px solid black;padding-left: 10px;" >
  28 Explanation
  29 </th>
  30 </tr>
  31
  32 <tr>
  33 <td style="border: 1px solid black;padding-left: 10px;" >
  34 ack/ack.go
  35 </td>
  36 <td style="border: 1px solid black;padding-left: 10px;" >
  37 Example of using ACK to acknowledge received messages.  The STOMP
  38 destination should have been previously loaded with message(s).
  39 </td>
  40 </tr>
  41
  42 <tr>
  43 <td style="border: 1px solid black;padding-left: 10px;" >
  44 conndisc/conndisc.go
  45 </td>
  46 <td style="border: 1px solid black;padding-left: 10px;" >
  47 A very basic demonstration of a 'CONNECT' / 'DISCONNECT' sequence.
  48 </td>
  49 </tr>
  50
  51 <tr>
  52 <td style="border: 1px solid black;padding-left: 10px;" >
  53 conndisc_tls/conndisc_tls.go
  54 </td>
  55 <td style="border: 1px solid black;padding-left: 10px;" >
  56 A very basic demonstration of a 'CONNECT' / 'DISCONNECT' sequence with
  57 ssl (tls).  You must connect to a broker port that is 'ssl/tls' enabled.
  58 </td>
  59 </tr>
  60
  61 <tr>
  62 <td style="border: 1px solid black;padding-left: 10px;" >
  63 jinterop
  64 </td>
  65 <td style="border: 1px solid black;padding-left: 10px;" >
  66 A subdirectory which contains go and Java examples of a producer and consumer.<br />
  67 This demonstrates interoperability between go and Java, and between STOMP and JMS.<br />
  68 See individual files for details.<br />
  69 This example is ActiveMQ specific, but can be easily adapted for other brokers.<br />
  70 It is assumed that the reader is familiar with Java, JMS, and JNDI.<br />
  71 A number of helper shell scripts are provided.  See the script descriptions below.<br />
  72 These interoperability examples have some hard coded port numbers and path names.<br />
  73 </td>
  74 </tr>
  75
  76 <tr>
  77 <td style="border: 1px solid black;padding-left: 10px;" >
  78 jinterop/Constants.java
  79 </td>
  80 <td style="border: 1px solid black;padding-left: 10px;" >
  81 Static constants used in the other Java programs in this directory.
  82 </td>
  83 </tr>
  84
  85 <tr>
  86 <td style="border: 1px solid black;padding-left: 10px;" >
  87 jinterop/jndi.properties
  88 </td>
  89 <td style="border: 1px solid black;padding-left: 10px;" >
  90 The JNDI properties file definition.
  91 </td>
  92 </tr>
  93
  94
  95 <tr>
  96 <td style="border: 1px solid black;padding-left: 10px;" >
  97 jinterop/log4j.properties
  98 </td>
  99 <td style="border: 1px solid black;padding-left: 10px;" >
 100 The log4j properties file used by the Java code.
 101 </td>
 102 </tr>
 103
 104 <tr>
 105 <td style="border: 1px solid black;padding-left: 10px;" >
 106 jinterop/gorecv/gorecv.go
 107 </td>
 108 <td style="border: 1px solid black;padding-left: 10px;" >
 109 A message consumer written in go.
 110 </td>
 111 </tr>
 112
 113 <tr>
 114 <td style="border: 1px solid black;padding-left: 10px;" >
 115 jinterop/gosend/gosend.go
 116 </td>
 117 <td style="border: 1px solid black;padding-left: 10px;" >
 118 A message producer written in go.
 119 </td>
 120 </tr>
 121
 122 <tr>
 123 <td style="border: 1px solid black;padding-left: 10px;" >
 124 jinterop/Receiver.java
 125 </td>
 126 <td style="border: 1px solid black;padding-left: 10px;" >
 127 A message consumer written in Java using JMS.
 128 </td>
 129 </tr>
 130
 131 <tr>
 132 <td style="border: 1px solid black;padding-left: 10px;" >
 133 jinterop/Sender.java
 134 </td>
 135 <td style="border: 1px solid black;padding-left: 10px;" >
 136 A message producer written in Java using JMS.
 137 </td>
 138 </tr>
 139
 140 <tr>
 141 <td style="border: 1px solid black;padding-left: 10px;" >
 142 publish/publish.go
 143 </td>
 144 <td style="border: 1px solid black;padding-left: 10px;" >
 145 A classic 'putter'.  Used to send an arbitrary number of messages to
 146 a given destination.
 147 </td>
 148 </tr>
 149
 150 <tr>
 151 <td style="border: 1px solid black;padding-left: 10px;" >
 152 receipts/onack/onack.go
 153 </td>
 154 <td style="border: 1px solid black;padding-left: 10px;" >
 155 Demonstrate obtaining a RECEIPT for an ACK request.
 156 </td>
 157 </tr>
 158
 159 <tr>
 160 <td style="border: 1px solid black;padding-left: 10px;" >
 161 receipts/onsend/onsend.go
 162 </td>
 163 <td style="border: 1px solid black;padding-left: 10px;" >
 164 Demonstrate obtaining a RECEIPT for a SEND request.
 165 </td>
 166 </tr>
 167
 168 <tr>
 169 <td style="border: 1px solid black;padding-left: 10px;" >
 170 recv_mds/recv_mds.go
 171 </td>
 172 <td style="border: 1px solid black;padding-left: 10px;" >
 173 An example intended to demonstrate how different brokers distribute output
 174 messages when a client subscribes multiple times to the same destination.
 175 </td>
 176 </tr>
 177
 178 <tr>
 179 <td style="border: 1px solid black;padding-left: 10px;" >
 180 sngecomm
 181 </td>
 182 <td style="border: 1px solid black;padding-left: 10px;" >
 183 A subdirectory which defines helper code for these examples.
 184 </td>
 185 </tr>
 186
 187 <tr>
 188 <td style="border: 1px solid black;padding-left: 10px;" >
 189 sngecomm/environment.go
 190 </td>
 191 <td style="border: 1px solid black;padding-left: 10px;" >
 192 Handle overrides from the environment for these examples.
 193 </td>
 194 </tr>
 195
 196 <tr>
 197 <td style="border: 1px solid black;padding-left: 10px;" >
 198 sngecomm/utilities.go
 199 </td>
 200 <td style="border: 1px solid black;padding-left: 10px;" >
 201 Utility routines used by these examples.
 202 </td>
 203 </tr>
 204
 205 <tr>
 206 <td style="border: 1px solid black;padding-left: 10px;" >
 207 srmgor_1conn/srmgor_1conn.go
 208 </td>
 209 <td style="border: 1px solid black;padding-left: 10px;" >
 210 Send and receive, many go routines, one *stompngo.Connection.<br />
 211 One sender go routine per destination.<br />
 212 One receiver go routine per destination.
 213 </td>
 214 </tr>
 215
 216 <tr>
 217 <td style="border: 1px solid black;padding-left: 10px;" >
 218 srmgor_1smrconn/srmgor_1smrconn.go
 219 </td>
 220 <td style="border: 1px solid black;padding-left: 10px;" >
 221 Send and receive, many go routines.<br />
 222 One sender connection, with one go routine per destination.<br />
 223 Many receiver connections:<br />
 224 one receiver connection per destination (one go routine per connection).<br />
 225 </td>
 226 </tr>
 227
 228 <tr>
 229 <td style="border: 1px solid black;padding-left: 10px;" >
 230 srmgor_2conn/srmgor_2conn.go
 231 </td>
 232 <td style="border: 1px solid black;padding-left: 10px;" >
 233 Send and receive, two connections.<br />
 234 Many go routines in the sender connection.<br />
 235 Many go routines in the receiver connection.<br />
 236 The receiver go routines illustrate a channel buffering technique that
 237 can be used with in bound message data.
 238 </td>
 239 </tr>
 240
 241 <tr>
 242 <td style="border: 1px solid black;padding-left: 10px;" >
 243 srmgor_manyconn/srmgor_manyconn.go
 244 </td>
 245 <td style="border: 1px solid black;padding-left: 10px;" >
 246 Send and receive.<br />
 247 Many sender connections.<br />
 248 Many receiver connections.
 249 </td>
 250 </tr>
 251
 252 <tr>
 253 <td style="border: 1px solid black;padding-left: 10px;" >
 254 subscribe/subscribe.go
 255 </td>
 256 <td style="border: 1px solid black;padding-left: 10px;" >
 257 A basic demonstration of subscribing and receiving messages.
 258 </td>
 259 </tr>
 260
 261 <tr>
 262 <td style="border: 1px solid black;padding-left: 10px;" >
 263 tlsexamps
 264 </td>
 265 <td style="border: 1px solid black;padding-left: 10px;" >
 266 A subdirectory demonstrating the use of TLS connections.<br />
 267 All four primary TLS use cases are demonstrated.<br />
 268 UseCase1) Client does not authenticate the broker and broker does not
 269 authenticate the client.<br />
 270 UseCase2) Client does authenticate the broker but broker does not
 271 authenticate the client.<br />
 272 UseCase3) Client does not authenticate the broker but broker does
 273 authenticate the client.<br />
 274 UseCase4) Client does authenticate the broker and broker does
 275 authenticate the client.<br />
 276 </td>
 277 </tr>
 278
 279 <tr>
 280 <td style="border: 1px solid black;padding-left: 10px;" >
 281 tlsexamps/tlsuc1/tlsuc1.go
 282 </td>
 283 <td style="border: 1px solid black;padding-left: 10px;" >
 284 UseCase1) Client does not authenticate the broker and broker does not
 285 authenticate the client.
 286 </td>
 287 </tr>
 288
 289 <tr>
 290 <td style="border: 1px solid black;padding-left: 10px;" >
 291 tlsexamps/tlsuc2/tlsuc2.go
 292 </td>
 293 <td style="border: 1px solid black;padding-left: 10px;" >
 294 UseCase2) Client does authenticate the broker but broker does not
 295 authenticate the client.
 296 </td>
 297 </tr>
 298
 299 <tr>
 300 <td style="border: 1px solid black;padding-left: 10px;" >
 301 tlsexamps/tlsuc3/tlsuc3.go
 302 </td>
 303 <td style="border: 1px solid black;padding-left: 10px;" >
 304 UseCase3) Client does not authenticate the broker but broker does
 305 authenticate the client.
 306 </td>
 307 </tr>
 308
 309 <tr>
 310 <td style="border: 1px solid black;padding-left: 10px;" >
 311 tlsexamps/tlsuc4/tlsuc4.go
 312 </td>
 313 <td style="border: 1px solid black;padding-left: 10px;" >
 314 UseCase4) Client does authenticate the broker and broker does
 315 authenticate the client.
 316 </td>
 317 </tr>
 318
 319 </table>
 320
 321 ## Shell Scripts  ##
 322
 323 This is a list of script files used in the examples.  There are very short
 324 scripts and it should be trivial to convert them to Windows .bat / .cmd
 325 files if necessary.
 326
 327 <table border="1" style="width:80%;border: 1px solid black;">
 328 <tr>
 329 <th style="width:20%;border: 1px solid black;padding-left: 10px;" >
 330 Script Name
 331 </th>
 332 <th style="width:60%border: 1px solid black;padding-left: 10px;" >
 333 Description
 334 </th>
 335 </tr>
 336
 337 <tr>
 338 <td style="border: 1px solid black;padding-left: 10px;" >
 339 jinterop/clean.sh
 340 </td>
 341 <td style="border: 1px solid black;padding-left: 10px;" >
 342 This is the clean up script for the Java / JMS interoperability examples.<br />
 343 It removes all three .class files and the two go executables.
 344 </td>
 345 </tr>
 346
 347 <tr>
 348 <td style="border: 1px solid black;padding-left: 10px;" >
 349 jinterop/compile.sh
 350 </td>
 351 <td style="border: 1px solid black;padding-left: 10px;" >
 352 This is the compile script for the Java / JMS interoperability examples.<br />
 353 It compiles the Java and the go interoperability code.
 354 </td>
 355 </tr>
 356
 357 <tr>
 358 <td style="border: 1px solid black;padding-left: 10px;" >
 359 jinterop/cp.sh
 360 </td>
 361 <td style="border: 1px solid black;padding-left: 10px;" >
 362 An internal script, sourced by some of the other scripts.<br />
 363 It builds a list of jar files that will be included in the Java CLASSPATH.<br />
 364 This script should be modified to support your environment.
 365 </td>
 366 </tr>
 367
 368 <tr>
 369 <td style="border: 1px solid black;padding-left: 10px;" >
 370 jinterop/gorecv.sh
 371 </td>
 372 <td style="border: 1px solid black;padding-left: 10px;" >
 373 This script runs the go receiver/consumer/getter.
 374 </td>
 375 </tr>
 376
 377 <tr>
 378 <td style="border: 1px solid black;padding-left: 10px;" >
 379 jinterop/gosend.sh
 380 </td>
 381 <td style="border: 1px solid black;padding-left: 10px;" >
 382 This script runs the go sender/producer/putter.
 383 </td>
 384 </tr>
 385
 386 <tr>
 387 <td style="border: 1px solid black;padding-left: 10px;" >
 388 jinterop/jrecv.sh
 389 </td>
 390 <td style="border: 1px solid black;padding-left: 10px;" >
 391 This script runs the Java receiver/consumer/getter.
 392 </td>
 393 </tr>
 394
 395 <tr>
 396 <td style="border: 1px solid black;padding-left: 10px;" >
 397 jinterop/jsend.sh
 398 </td>
 399 <td style="border: 1px solid black;padding-left: 10px;" >
 400 This script runs the Java sender/producer/putter.
 401 </td>
 402 </tr>
 403
 404 <tr>
 405 <td style="border: 1px solid black;padding-left: 10px;" >
 406 srmgor_1conn/run.sh
 407 </td>
 408 <td style="border: 1px solid black;padding-left: 10px;" >
 409 Send and receive, many go routines, one *stompngo.Connection.<br />
 410 A logging helper script.
 411 </td>
 412 </tr>
 413
 414 <tr>
 415 <td style="border: 1px solid black;padding-left: 10px;" >
 416 srmgor_1smrconn/run.sh
 417 </td>
 418 <td style="border: 1px solid black;padding-left: 10px;" >
 419 Send and receive, one sender connection with many go routines,
 420 many receiver connections.<br />
 421 A logging helper script.
 422 </td>
 423 </tr>
 424
 425 <tr>
 426 <td style="border: 1px solid black;padding-left: 10px;" >
 427 srmgor_2conn/run.sh
 428 </td>
 429 <td style="border: 1px solid black;padding-left: 10px;" >
 430 Send and receive, one receiver connection with many go routines, one
 431 sender connection with many go routines.<br />
 432 A logging helper script.
 433 </td>
 434 </tr>
 435
 436 <tr>
 437 <td style="border: 1px solid black;padding-left: 10px;" >
 438 srmgor_manyconn/run.sh
 439 </td>
 440 <td style="border: 1px solid black;padding-left: 10px;" >
 441 Send and receive, many receiver connections, many sender connections.<br />
 442 A logging helper script.
 443 </td>
 444 </tr>
 445
 446 <tr>
 447 <td style="border: 1px solid black;padding-left: 10px;" >
 448 tlsexamps/tlsuc1/run.sh
 449 </td>
 450 <td style="border: 1px solid black;padding-left: 10px;" >
 451 TLS Use Case 1.<br />
 452 Example run script.
 453 </td>
 454 </tr>
 455
 456 <tr>
 457 <td style="border: 1px solid black;padding-left: 10px;" >
 458 tlsexamps/tlsuc2/runall.sh
 459 </td>
 460 <td style="border: 1px solid black;padding-left: 10px;" >
 461 TLS Use Case 2.<br />
 462 Example run script.<br />
 463 Three separate runs, using different ports.
 464 </td>
 465 </tr>
 466
 467 <tr>
 468 <td style="border: 1px solid black;padding-left: 10px;" >
 469 tlsexamps/tlsuc2/run.sh
 470 </td>
 471 <td style="border: 1px solid black;padding-left: 10px;" >
 472 TLS Use Case 2.<br />
 473 Example run script.
 474 </td>
 475 </tr>
 476
 477
 478 <tr>
 479 <td style="border: 1px solid black;padding-left: 10px;" >
 480 tlsexamps/tlsuc3/runall.sh
 481 </td>
 482 <td style="border: 1px solid black;padding-left: 10px;" >
 483 TLS Use Case 3.<br />
 484 Example run script.<br />
 485 Three separate runs, using different ports.
 486 </td>
 487 </tr>
 488
 489 <tr>
 490 <td style="border: 1px solid black;padding-left: 10px;" >
 491 tlsexamps/tlsuc3/run.sh
 492 </td>
 493 <td style="border: 1px solid black;padding-left: 10px;" >
 494 TLS Use Case 3.<br />
 495 Example run script.
 496 </td>
 497 </tr>
 498
 499 <tr>
 500 <td style="border: 1px solid black;padding-left: 10px;" >
 501 tlsexamps/tlsuc4/runall.sh
 502 </td>
 503 <td style="border: 1px solid black;padding-left: 10px;" >
 504 TLS Use Case 4.<br />
 505 Example run script.<br />
 506 Three separate runs, using different ports.
 507 </td>
 508 </tr>
 509
 510 <tr>
 511 <td style="border: 1px solid black;padding-left: 10px;" >
 512 tlsexamps/tlsuc4/run.sh
 513 </td>
 514 <td style="border: 1px solid black;padding-left: 10px;" >
 515 TLS Use Case 4.<br />
 516 Example run script.
 517 </td>
 518 </tr>
 519
 520 </table>
 521
 522 ## Variable Names in the Examples  ##
 523
 524 Note the author is accustomed to idiomatic go variable names (short if possible).
 525
 526 <table border="1" style="width:80%;border: 1px solid black;">
 527 <tr>
 528 <th style="width:20%;border: 1px solid black;padding-left: 10px;" >
 529 Variable Name
 530 </th>
 531 <th style="width:60%border: 1px solid black;padding-left: 10px;" >
 532 Common Use
 533 </th>
 534 </tr>
 535
 536 <tr>
 537 <td style="border: 1px solid black;padding-left: 10px;" >
 538 ah
 539 </td>
 540 <td style="border: 1px solid black;padding-left: 10px;" >
 541 Ack headers.  A stompngo.Headers instance.
 542 </td>
 543 </tr>
 544
 545 <tr>
 546 <td style="border: 1px solid black;padding-left: 10px;" >
 547 c
 548 </td>
 549 <td style="border: 1px solid black;padding-left: 10px;" >
 550 A loop couner.  Because in some situations it makes sense. And I enjoy
 551 writing 'c++' for the end of loop condition.
 552 </td>
 553 </tr>
 554
 555 <tr>
 556 <td style="border: 1px solid black;padding-left: 10px;" >
 557 ch
 558 </td>
 559 <td style="border: 1px solid black;padding-left: 10px;" >
 560 Connect headers.  A stompngo.Headers instance, used for the initial
 561 CONNECT frame sent to the broker.
 562 </td>
 563 </tr>
 564
 565 <tr>
 566 <td style="border: 1px solid black;padding-left: 10px;" >
 567 conn
 568 </td>
 569 <td style="border: 1px solid black;padding-left: 10px;" >
 570 A instance of a *stompngo.Connection.
 571 </td>
 572 </tr>
 573
 574 <tr>
 575 <td style="border: 1px solid black;padding-left: 10px;" >
 576 d
 577 </td>
 578 <td style="border: 1px solid black;padding-left: 10px;" >
 579 A stomp destination.
 580 </td>
 581 </tr>
 582
 583 <tr>
 584 <td style="border: 1px solid black;padding-left: 10px;" >
 585 dh
 586 </td>
 587 <td style="border: 1px solid black;padding-left: 10px;" >
 588 Disconnect headers.  A stompngo.Headers instance.
 589 </td>
 590 </tr>
 591
 592 <tr>
 593 <td style="border: 1px solid black;padding-left: 10px;" >
 594 dt
 595 </td>
 596 <td style="border: 1px solid black;padding-left: 10px;" >
 597 A time.Duration instance.
 598 </td>
 599 </tr>
 600
 601 <tr>
 602 <td style="border: 1px solid black;padding-left: 10px;" >
 603 e
 604 </td>
 605 <td style="border: 1px solid black;padding-left: 10px;" >
 606 A go 'error' instance.
 607 </td>
 608 </tr>
 609
 610 <tr>
 611 <td style="border: 1px solid black;padding-left: 10px;" >
 612 h
 613 </td>
 614 <td style="border: 1px solid black;padding-left: 10px;" >
 615 A broker's (DNS) host name.
 616 </td>
 617 </tr>
 618
 619 <tr>
 620 <td style="border: 1px solid black;padding-left: 10px;" >
 621 hap
 622 </td>
 623 <td style="border: 1px solid black;padding-left: 10px;" >
 624 A host and port name returned from net.JoinHostPort(h, p), type string.<br />
 625 Example: localhost:61613.
 626 </td>
 627 </tr>
 628
 629 <tr>
 630 <td style="border: 1px solid black;padding-left: 10px;" >
 631 i
 632 </td>
 633 <td style="border: 1px solid black;padding-left: 10px;" >
 634 A loop counter.
 635 </td>
 636 </tr>
 637
 638 <tr>
 639 <td style="border: 1px solid black;padding-left: 10px;" >
 640 id
 641 </td>
 642 <td style="border: 1px solid black;padding-left: 10px;" >
 643 A (type 4) UUID.
 644 </td>
 645 </tr>
 646
 647 <tr>
 648 <td style="border: 1px solid black;padding-left: 10px;" >
 649 jhp
 650 </td>
 651 <td style="border: 1px solid black;padding-left: 10px;" >
 652 A joined host and port pair, returned from net.JoinHostPort(h, p).
 653 </td>
 654 </tr>
 655
 656 <tr>
 657 <td style="border: 1px solid black;padding-left: 10px;" >
 658 ll
 659 </td>
 660 <td style="border: 1px solid black;padding-left: 10px;" >
 661 A go logger instance.
 662 </td>
 663 </tr>
 664
 665 <tr>
 666 <td style="border: 1px solid black;padding-left: 10px;" >
 667 mc
 668 </td>
 669 <td style="border: 1px solid black;padding-left: 10px;" >
 670 A message count.
 671 </td>
 672 </tr>
 673
 674 <tr>
 675 <td style="border: 1px solid black;padding-left: 10px;" >
 676 mcs
 677 </td>
 678 <td style="border: 1px solid black;padding-left: 10px;" >
 679 A message count, with type string.
 680 </td>
 681 </tr>
 682
 683 <tr>
 684 <td style="border: 1px solid black;padding-left: 10px;" >
 685 md
 686 </td>
 687 <td style="border: 1px solid black;padding-left: 10px;" >
 688 A stompngo.MessageData instance.  The instance is retrieved from r (i.e.
 689 md := &lt;-r)
 690 </td>
 691 </tr>
 692
 693 <tr>
 694 <td style="border: 1px solid black;padding-left: 10px;" >
 695 ms
 696 </td>
 697 <td style="border: 1px solid black;padding-left: 10px;" >
 698 A message body, with type string.
 699 </td>
 700 </tr>
 701
 702 <tr>
 703 <td style="border: 1px solid black;padding-left: 10px;" >
 704 mse
 705 </td>
 706 <td style="border: 1px solid black;padding-left: 10px;" >
 707 A message body, with addional data, type string.
 708 </td>
 709 </tr>
 710
 711 <tr>
 712 <td style="border: 1px solid black;padding-left: 10px;" >
 713 n
 714 </td>
 715 <td style="border: 1px solid black;padding-left: 10px;" >
 716 An instance of net.Conn.
 717 </td>
 718 </tr>
 719
 720 <tr>
 721 <td style="border: 1px solid black;padding-left: 10px;" >
 722 nmsgs
 723 </td>
 724 <td style="border: 1px solid black;padding-left: 10px;" >
 725 The number of messages to process (produce/consume).
 726 </td>
 727 </tr>
 728
 729 <tr>
 730 <td style="border: 1px solid black;padding-left: 10px;" >
 731 nqs
 732 </td>
 733 <td style="border: 1px solid black;padding-left: 10px;" >
 734 The number of destinations to use.
 735 </td>
 736 </tr>
 737
 738 <tr>
 739 <td style="border: 1px solid black;padding-left: 10px;" >
 740 nr
 741 </td>
 742 <td style="border: 1px solid black;padding-left: 10px;" >
 743 The number of receiver go routines.
 744 </td>
 745 </tr>
 746
 747 <tr>
 748 <td style="border: 1px solid black;padding-left: 10px;" >
 749 p
 750 </td>
 751 <td style="border: 1px solid black;padding-left: 10px;" >
 752 A broker's listener port.
 753 </td>
 754 </tr>
 755
 756 <tr>
 757 <td style="border: 1px solid black;padding-left: 10px;" >
 758 pbc
 759 </td>
 760 <td style="border: 1px solid black;padding-left: 10px;" >
 761 The print byte count.  When message bodies are printed, this is the
 762 maximum number of bytes to print.  Useful when message body sizes are
 763 large.  This is arbitrarily set to 64 unless overridden.  If this is
 764 set to 0, message bodies are (usually) not printed at all.
 765 </td>
 766 </tr>
 767
 768 <tr>
 769 <td style="border: 1px solid black;padding-left: 10px;" >
 770 qc
 771 </td>
 772 <td style="border: 1px solid black;padding-left: 10px;" >
 773 A channel of type bool, used for signaling event completion.
 774 </td>
 775 </tr>
 776
 777 <tr>
 778 <td style="border: 1px solid black;padding-left: 10px;" >
 779 qn
 780 </td>
 781 <td style="border: 1px solid black;padding-left: 10px;" >
 782 A queue number identifier.  Used in a looping control structure for a
 783 variable number of queues, or as a method parameter.
 784 </td>
 785 </tr>
 786
 787 <tr>
 788 <td style="border: 1px solid black;padding-left: 10px;" >
 789 qns
 790 </td>
 791 <td style="border: 1px solid black;padding-left: 10px;" >
 792 A queue number identifier, type string (from qn).
 793 </td>
 794 </tr>
 795
 796 <tr>
 797 <td style="border: 1px solid black;padding-left: 10px;" >
 798 r
 799 </td>
 800 <td style="border: 1px solid black;padding-left: 10px;" >
 801 A channel of type stompngo.MessageData.  Used in example code to
 802 receive messages and metadata from the broker.
 803 </td>
 804 </tr>
 805
 806 <tr>
 807 <td style="border: 1px solid black;padding-left: 10px;" >
 808 rd
 809 </td>
 810 <td style="border: 1px solid black;padding-left: 10px;" >
 811 A receipt message from the broker. An instance of type stompngo.MessageData.
 812 </td>
 813 </tr>
 814
 815 <tr>
 816 <td style="border: 1px solid black;padding-left: 10px;" >
 817 rf
 818 </td>
 819 <td style="border: 1px solid black;padding-left: 10px;" >
 820 A receive wait time multiplier.
 821 </td>
 822 </tr>
 823
 824 <tr>
 825 <td style="border: 1px solid black;padding-left: 10px;" >
 826 rid
 827 </td>
 828 <td style="border: 1px solid black;padding-left: 10px;" >
 829 A receipt id.
 830 </td>
 831 </tr>
 832
 833
 834 <tr>
 835 <td style="border: 1px solid black;padding-left: 10px;" >
 836 rw
 837 </td>
 838 <td style="border: 1px solid black;padding-left: 10px;" >
 839 A wait flag used by receivers. When set to true, receivers wait for a
 840 random amount of time after each message red.
 841 </td>
 842 </tr>
 843
 844 <tr>
 845 <td style="border: 1px solid black;padding-left: 10px;" >
 846 sbh
 847 </td>
 848 <td style="border: 1px solid black;padding-left: 10px;" >
 849 Subscribe headers.  A stompngo.Headers instance.
 850 </td>
 851 </tr>
 852
 853 <tr>
 854 <td style="border: 1px solid black;padding-left: 10px;" >
 855 sc
 856 </td>
 857 <td style="border: 1px solid black;padding-left: 10px;" >
 858 A channel of type stompngo.MessageData.  Used in example code to
 859 receive messages and metadata from the broker.
 860 </td>
 861 </tr>
 862
 863
 864 <tr>
 865 <td style="border: 1px solid black;padding-left: 10px;" >
 866 sf
 867 </td>
 868 <td style="border: 1px solid black;padding-left: 10px;" >
 869 A send wait time multiplier.
 870 </td>
 871 </tr>
 872
 873 <tr>
 874 <td style="border: 1px solid black;padding-left: 10px;" >
 875 sh
 876 </td>
 877 <td style="border: 1px solid black;padding-left: 10px;" >
 878 Send headers.  A stompngo.Headers instance.
 879 </td>
 880 </tr>
 881
 882 <tr>
 883 <td style="border: 1px solid black;padding-left: 10px;" >
 884 sw
 885 </td>
 886 <td style="border: 1px solid black;padding-left: 10px;" >
 887 A wait flag used by senders. When set to true, senders wait for a
 888 random amount of time after each send.
 889 </td>
 890 </tr>
 891
 892 <tr>
 893 <td style="border: 1px solid black;padding-left: 10px;" >
 894 si
 895 </td>
 896 <td style="border: 1px solid black;padding-left: 10px;" >
 897 A loop counter formatted as a string.
 898 </td>
 899 </tr>
 900
 901 <tr>
 902 <td style="border: 1px solid black;padding-left: 10px;" >
 903 tc
 904 </td>
 905 <td style="border: 1px solid black;padding-left: 10px;" >
 906 An instance of *tls.Config.
 907 </td>
 908 </tr>
 909
 910 <tr>
 911 <td style="border: 1px solid black;padding-left: 10px;" >
 912 tmr
 913 </td>
 914 <td style="border: 1px solid black;padding-left: 10px;" >
 915 A time.Timer.
 916 </td>
 917 </tr>
 918
 919 <tr>
 920 <td style="border: 1px solid black;padding-left: 10px;" >
 921 wga
 922 </td>
 923 <td style="border: 1px solid black;padding-left: 10px;" >
 924 Wait group for all sender and receiver go routines.
 925 </td>
 926 </tr>
 927
 928 <tr>
 929 <td style="border: 1px solid black;padding-left: 10px;" >
 930 wgr
 931 </td>
 932 <td style="border: 1px solid black;padding-left: 10px;" >
 933 Wait group for all receiver go routines.
 934 </td>
 935 </tr>
 936
 937
 938 <tr>
 939 <td style="border: 1px solid black;padding-left: 10px;" >
 940 wgs
 941 </td>
 942 <td style="border: 1px solid black;padding-left: 10px;" >
 943 Wait group for all sender go routines.
 944 </td>
 945 </tr>
 946
 947 <tr>
 948 <td style="border: 1px solid black;padding-left: 10px;" >
 949 wh
 950 </td>
 951 <td style="border: 1px solid black;padding-left: 10px;" >
 952 Work headers.  A stompngo.Headers instance.
 953 </td>
 954 </tr>
 955
 956 </table>
 957
 958 ## Variable Names Specific to the TLS Examples  ##
 959
 960 <table border="1" style="width:80%;border: 1px solid black;">
 961 <tr>
 962 <th style="width:20%;border: 1px solid black;padding-left: 10px;" >
 963 Variable Name
 964 </th>
 965 <th style="width:60%border: 1px solid black;padding-left: 10px;" >
 966 Common Use
 967 </th>
 968 </tr>
 969
 970 <tr>
 971 <td style="border: 1px solid black;padding-left: 10px;" >
 972 b
 973 </td>
 974 <td style="border: 1px solid black;padding-left: 10px;" >
 975 A buffer, type []byte.
 976 </td>
 977 </tr>
 978
 979 <tr>
 980 <td style="border: 1px solid black;padding-left: 10px;" >
 981 c
 982 </td>
 983 <td style="border: 1px solid black;padding-left: 10px;" >
 984 An instance of *x509.Certificate.
 985 </td>
 986 </tr>
 987
 988 <tr>
 989 <td style="border: 1px solid black;padding-left: 10px;" >
 990 cc
 991 </td>
 992 <td style="border: 1px solid black;padding-left: 10px;" >
 993 An instance of tls.Certificate.
 994 </td>
 995 </tr>
 996
 997 <tr>
 998 <td style="border: 1px solid black;padding-left: 10px;" >
 999 cliCertFile
1000 </td>
1001 <td style="border: 1px solid black;padding-left: 10px;" >
1002 The full file name of the client's public cert in PEM format.
1003 </td>
1004 </tr>
1005
1006
1007 <tr>
1008 <td style="border: 1px solid black;padding-left: 10px;" >
1009 cliKeyFile
1010 </td>
1011 <td style="border: 1px solid black;padding-left: 10px;" >
1012 The full file name of the client's private key in PEM format.
1013 </td>
1014 </tr>
1015
1016 <tr>
1017 <td style="border: 1px solid black;padding-left: 10px;" >
1018 e
1019 </td>
1020 <td style="border: 1px solid black;padding-left: 10px;" >
1021 An instance of error.
1022 </td>
1023 </tr>
1024
1025 <tr>
1026 <td style="border: 1px solid black;padding-left: 10px;" >
1027 k
1028 </td>
1029 <td style="border: 1px solid black;padding-left: 10px;" >
1030 An instance of *pem.Block.
1031 </td>
1032 </tr>
1033
1034 <tr>
1035 <td style="border: 1px solid black;padding-left: 10px;" >
1036 ll
1037 </td>
1038 <td style="border: 1px solid black;padding-left: 10px;" >
1039 A logger instance.
1040 </td>
1041 </tr>
1042
1043 <tr>
1044 <td style="border: 1px solid black;padding-left: 10px;" >
1045 nc
1046 </td>
1047 <td style="border: 1px solid black;padding-left: 10px;" >
1048 A pointer to a tls configuration, type *tls.Config, obtained from
1049 'tls.Client'.
1050 </td>
1051 </tr>
1052
1053 <tr>
1054 <td style="border: 1px solid black;padding-left: 10px;" >
1055 svrCAFile
1056 </td>
1057 <td style="border: 1px solid black;padding-left: 10px;" >
1058 The full file name of the server CA's public cert in PEM format.
1059 </td>
1060 </tr>
1061
1062 <tr>
1063 <td style="border: 1px solid black;padding-left: 10px;" >
1064 t
1065 </td>
1066 <td style="border: 1px solid black;padding-left: 10px;" >
1067 An instance of net.Conn obtained from net.Dial.
1068 </td>
1069 </tr>
1070
1071 <tr>
1072 <td style="border: 1px solid black;padding-left: 10px;" >
1073 tc
1074 </td>
1075 <td style="border: 1px solid black;padding-left: 10px;" >
1076 A pointer to a tls configuration, type *tls.Config obtained from 'new'.
1077 </td>
1078 </tr>
1079
1080 </table>
1081