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 Examples are provided for ActiveMQ and Artemis.  Only the ActiveMQ artifacts are described here.<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/activemq/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/activemq/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/activemq/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/activemq/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/activemq/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/activemq/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/activemq/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 or destinations.
 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/activemq/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/activemq/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/activemq/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/activemq/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/activemq/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/activemq/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/activemq/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 jinterop/activemq/runall.sh
 407 </td>
 408 <td style="border: 1px solid black;padding-left: 10px;" >
 409 This script runs all possible combinations of producers / consumers.
 410 </td>
 411 </tr>
 412
 413 <tr>
 414 <td style="border: 1px solid black;padding-left: 10px;" >
 415 srmgor_1conn/run.sh
 416 </td>
 417 <td style="border: 1px solid black;padding-left: 10px;" >
 418 Send and receive, many go routines, one *stompngo.Connection.<br />
 419 A logging helper script.
 420 </td>
 421 </tr>
 422
 423 <tr>
 424 <td style="border: 1px solid black;padding-left: 10px;" >
 425 srmgor_1smrconn/run.sh
 426 </td>
 427 <td style="border: 1px solid black;padding-left: 10px;" >
 428 Send and receive, one sender connection with many go routines,
 429 many receiver connections.<br />
 430 A logging helper script.
 431 </td>
 432 </tr>
 433
 434 <tr>
 435 <td style="border: 1px solid black;padding-left: 10px;" >
 436 srmgor_2conn/run.sh
 437 </td>
 438 <td style="border: 1px solid black;padding-left: 10px;" >
 439 Send and receive, one receiver connection with many go routines, one
 440 sender connection with many go routines.<br />
 441 A logging helper script.
 442 </td>
 443 </tr>
 444
 445 <tr>
 446 <td style="border: 1px solid black;padding-left: 10px;" >
 447 srmgor_manyconn/run.sh
 448 </td>
 449 <td style="border: 1px solid black;padding-left: 10px;" >
 450 Send and receive, many receiver connections, many sender connections.<br />
 451 A logging helper script.
 452 </td>
 453 </tr>
 454
 455 <tr>
 456 <td style="border: 1px solid black;padding-left: 10px;" >
 457 tlsexamps/tlsuc1/run.sh
 458 </td>
 459 <td style="border: 1px solid black;padding-left: 10px;" >
 460 TLS Use Case 1.<br />
 461 Example run script.
 462 </td>
 463 </tr>
 464
 465 <tr>
 466 <td style="border: 1px solid black;padding-left: 10px;" >
 467 tlsexamps/tlsuc2/runall.sh
 468 </td>
 469 <td style="border: 1px solid black;padding-left: 10px;" >
 470 TLS Use Case 2.<br />
 471 Example run script.<br />
 472 Three separate runs, using different ports.
 473 </td>
 474 </tr>
 475
 476 <tr>
 477 <td style="border: 1px solid black;padding-left: 10px;" >
 478 tlsexamps/tlsuc2/run.sh
 479 </td>
 480 <td style="border: 1px solid black;padding-left: 10px;" >
 481 TLS Use Case 2.<br />
 482 Example run script.
 483 </td>
 484 </tr>
 485
 486
 487 <tr>
 488 <td style="border: 1px solid black;padding-left: 10px;" >
 489 tlsexamps/tlsuc3/runall.sh
 490 </td>
 491 <td style="border: 1px solid black;padding-left: 10px;" >
 492 TLS Use Case 3.<br />
 493 Example run script.<br />
 494 Three separate runs, using different ports.
 495 </td>
 496 </tr>
 497
 498 <tr>
 499 <td style="border: 1px solid black;padding-left: 10px;" >
 500 tlsexamps/tlsuc3/run.sh
 501 </td>
 502 <td style="border: 1px solid black;padding-left: 10px;" >
 503 TLS Use Case 3.<br />
 504 Example run script.
 505 </td>
 506 </tr>
 507
 508 <tr>
 509 <td style="border: 1px solid black;padding-left: 10px;" >
 510 tlsexamps/tlsuc4/runall.sh
 511 </td>
 512 <td style="border: 1px solid black;padding-left: 10px;" >
 513 TLS Use Case 4.<br />
 514 Example run script.<br />
 515 Three separate runs, using different ports.
 516 </td>
 517 </tr>
 518
 519 <tr>
 520 <td style="border: 1px solid black;padding-left: 10px;" >
 521 tlsexamps/tlsuc4/run.sh
 522 </td>
 523 <td style="border: 1px solid black;padding-left: 10px;" >
 524 TLS Use Case 4.<br />
 525 Example run script.
 526 </td>
 527 </tr>
 528
 529 </table>
 530
 531 ## Variable Names in the Examples  ##
 532
 533 Note the author is accustomed to idiomatic go variable names (short if possible).
 534
 535 <table border="1" style="width:80%;border: 1px solid black;">
 536 <tr>
 537 <th style="width:20%;border: 1px solid black;padding-left: 10px;" >
 538 Variable Name
 539 </th>
 540 <th style="width:60%border: 1px solid black;padding-left: 10px;" >
 541 Common Use
 542 </th>
 543 </tr>
 544
 545 <tr>
 546 <td style="border: 1px solid black;padding-left: 10px;" >
 547 ah
 548 </td>
 549 <td style="border: 1px solid black;padding-left: 10px;" >
 550 Ack headers.  A stompngo.Headers instance.
 551 </td>
 552 </tr>
 553
 554 <tr>
 555 <td style="border: 1px solid black;padding-left: 10px;" >
 556 c
 557 </td>
 558 <td style="border: 1px solid black;padding-left: 10px;" >
 559 A loop couner.  Because in some situations it makes sense. And because
 560 writing 'c++' for the end of loop action is amusing.
 561 </td>
 562 </tr>
 563
 564 <tr>
 565 <td style="border: 1px solid black;padding-left: 10px;" >
 566 ch
 567 </td>
 568 <td style="border: 1px solid black;padding-left: 10px;" >
 569 Connect headers.  A stompngo.Headers instance, used for the initial
 570 CONNECT frame sent to the broker.
 571 </td>
 572 </tr>
 573
 574 <tr>
 575 <td style="border: 1px solid black;padding-left: 10px;" >
 576 conn
 577 </td>
 578 <td style="border: 1px solid black;padding-left: 10px;" >
 579 A instance of a *stompngo.Connection, usually obtained from a call to
 580 stompngo.Connect(...).<br />
 581 Rename candidate: sc.
 582 </td>
 583 </tr>
 584
 585 <tr>
 586 <td style="border: 1px solid black;padding-left: 10px;" >
 587 d
 588 </td>
 589 <td style="border: 1px solid black;padding-left: 10px;" >
 590 A stomp destination, type string.  Format and semantics are broker specific.
 591 </td>
 592 </tr>
 593
 594 <tr>
 595 <td style="border: 1px solid black;padding-left: 10px;" >
 596 dh
 597 </td>
 598 <td style="border: 1px solid black;padding-left: 10px;" >
 599 Disconnect headers.  A stompngo.Headers instance.
 600 </td>
 601 </tr>
 602
 603 <tr>
 604 <td style="border: 1px solid black;padding-left: 10px;" >
 605 dt
 606 </td>
 607 <td style="border: 1px solid black;padding-left: 10px;" >
 608 A time.Duration instance.
 609 </td>
 610 </tr>
 611
 612 <tr>
 613 <td style="border: 1px solid black;padding-left: 10px;" >
 614 e
 615 </td>
 616 <td style="border: 1px solid black;padding-left: 10px;" >
 617 An instance of the go error type.
 618 </td>
 619 </tr>
 620
 621 <tr>
 622 <td style="border: 1px solid black;padding-left: 10px;" >
 623 h
 624 </td>
 625 <td style="border: 1px solid black;padding-left: 10px;" >
 626 A broker's (DNS) host name.
 627 </td>
 628 </tr>
 629
 630 <tr>
 631 <td style="border: 1px solid black;padding-left: 10px;" >
 632 hap
 633 </td>
 634 <td style="border: 1px solid black;padding-left: 10px;" >
 635 A host and port name returned from net.JoinHostPort(h, p), type string.<br />
 636 Example: localhost:61613.
 637 </td>
 638 </tr>
 639
 640 <tr>
 641 <td style="border: 1px solid black;padding-left: 10px;" >
 642 i
 643 </td>
 644 <td style="border: 1px solid black;padding-left: 10px;" >
 645 A loop counter.
 646 </td>
 647 </tr>
 648
 649 <tr>
 650 <td style="border: 1px solid black;padding-left: 10px;" >
 651 id
 652 </td>
 653 <td style="border: 1px solid black;padding-left: 10px;" >
 654 A (type 4) UUID obtained from calling stompngo.Uuid(), type string.
 655 </td>
 656 </tr>
 657
 658 <tr>
 659 <td style="border: 1px solid black;padding-left: 10px;" >
 660 irid
 661 </td>
 662 <td style="border: 1px solid black;padding-left: 10px;" >
 663 A receipt id, received from the broker, type string.
 664 </td>
 665 </tr>
 666
 667 <tr>
 668 <td style="border: 1px solid black;padding-left: 10px;" >
 669 ll
 670 </td>
 671 <td style="border: 1px solid black;padding-left: 10px;" >
 672 A go logger instance.
 673 </td>
 674 </tr>
 675
 676 <tr>
 677 <td style="border: 1px solid black;padding-left: 10px;" >
 678 mc
 679 </td>
 680 <td style="border: 1px solid black;padding-left: 10px;" >
 681 A message count.
 682 </td>
 683 </tr>
 684
 685 <tr>
 686 <td style="border: 1px solid black;padding-left: 10px;" >
 687 mcs
 688 </td>
 689 <td style="border: 1px solid black;padding-left: 10px;" >
 690 A message count, with type string.
 691 </td>
 692 </tr>
 693
 694 <tr>
 695 <td style="border: 1px solid black;padding-left: 10px;" >
 696 md
 697 </td>
 698 <td style="border: 1px solid black;padding-left: 10px;" >
 699 A stompngo.MessageData instance.  The instance is retrieved from r (i.e.
 700 md := &lt;-r)
 701 </td>
 702 </tr>
 703
 704 <tr>
 705 <td style="border: 1px solid black;padding-left: 10px;" >
 706 ms
 707 </td>
 708 <td style="border: 1px solid black;padding-left: 10px;" >
 709 A message body, with type string.
 710 </td>
 711 </tr>
 712
 713 <tr>
 714 <td style="border: 1px solid black;padding-left: 10px;" >
 715 mse
 716 </td>
 717 <td style="border: 1px solid black;padding-left: 10px;" >
 718 A message body, with addional data, type string.
 719 </td>
 720 </tr>
 721
 722 <tr>
 723 <td style="border: 1px solid black;padding-left: 10px;" >
 724 n
 725 </td>
 726 <td style="border: 1px solid black;padding-left: 10px;" >
 727 An implementation of the net.Conn interface, obtained by calling
 728 net.Dial.
 729 </td>
 730 </tr>
 731
 732 <tr>
 733 <td style="border: 1px solid black;padding-left: 10px;" >
 734 nmsgs
 735 </td>
 736 <td style="border: 1px solid black;padding-left: 10px;" >
 737 The number of messages to process (produce/consume).<br />
 738 Rename candidate: nm.
 739 </td>
 740 </tr>
 741
 742 <tr>
 743 <td style="border: 1px solid black;padding-left: 10px;" >
 744 nqs
 745 </td>
 746 <td style="border: 1px solid black;padding-left: 10px;" >
 747 The number of destinations to use.<br />
 748 Rename candidate: nd.
 749 </td>
 750 </tr>
 751
 752 <tr>
 753 <td style="border: 1px solid black;padding-left: 10px;" >
 754 nr
 755 </td>
 756 <td style="border: 1px solid black;padding-left: 10px;" >
 757 The number of receiver go routines.
 758 </td>
 759 </tr>
 760
 761 <tr>
 762 <td style="border: 1px solid black;padding-left: 10px;" >
 763 p
 764 </td>
 765 <td style="border: 1px solid black;padding-left: 10px;" >
 766 A broker's listener port.
 767 </td>
 768 </tr>
 769
 770 <tr>
 771 <td style="border: 1px solid black;padding-left: 10px;" >
 772 pbc
 773 </td>
 774 <td style="border: 1px solid black;padding-left: 10px;" >
 775 The print byte count.  When message bodies are printed, this is the
 776 maximum number of bytes to print.  Useful when message body sizes are
 777 large.  This is arbitrarily set to 64 unless overridden.  If this is
 778 set to 0, message bodies are (usually) not printed at all.<br />
 779 Rename candidate: pc.<br />
 780 TODO: consistently print no message body if this is &lt;= 0.
 781 </td>
 782 </tr>
 783
 784 <tr>
 785 <td style="border: 1px solid black;padding-left: 10px;" >
 786 qc
 787 </td>
 788 <td style="border: 1px solid black;padding-left: 10px;" >
 789 A channel of type bool, used for signaling event completion.
 790 </td>
 791 </tr>
 792
 793 <tr>
 794 <td style="border: 1px solid black;padding-left: 10px;" >
 795 qn
 796 </td>
 797 <td style="border: 1px solid black;padding-left: 10px;" >
 798 A queue number identifier.  Used in a looping control structure for a
 799 variable number of queues, or as a method parameter.
 800 </td>
 801 </tr>
 802
 803 <tr>
 804 <td style="border: 1px solid black;padding-left: 10px;" >
 805 qns
 806 </td>
 807 <td style="border: 1px solid black;padding-left: 10px;" >
 808 A queue number identifier, type string (from qn).
 809 </td>
 810 </tr>
 811
 812 <tr>
 813 <td style="border: 1px solid black;padding-left: 10px;" >
 814 r
 815 </td>
 816 <td style="border: 1px solid black;padding-left: 10px;" >
 817 Used in the sngecomm subpackage only, for several reasons.<br />
 818 TODO:  this needs to change to a more meaningful variable name and
 819 documentation for same added.
 820 </td>
 821 </tr>
 822
 823 <tr>
 824 <td style="border: 1px solid black;padding-left: 10px;" >
 825 rd
 826 </td>
 827 <td style="border: 1px solid black;padding-left: 10px;" >
 828 A receipt message from the broker. An instance of type stompngo.MessageData.
 829 </td>
 830 </tr>
 831
 832 <tr>
 833 <td style="border: 1px solid black;padding-left: 10px;" >
 834 rf
 835 </td>
 836 <td style="border: 1px solid black;padding-left: 10px;" >
 837 A receive wait time multiplier.
 838 </td>
 839 </tr>
 840
 841 <tr>
 842 <td style="border: 1px solid black;padding-left: 10px;" >
 843 rid
 844 </td>
 845 <td style="border: 1px solid black;padding-left: 10px;" >
 846 A receipt id, type string.
 847 </td>
 848 </tr>
 849
 850
 851 <tr>
 852 <td style="border: 1px solid black;padding-left: 10px;" >
 853 rw
 854 </td>
 855 <td style="border: 1px solid black;padding-left: 10px;" >
 856 A wait flag used by receivers. When set to true, receivers wait for a
 857 random amount of time after each message red.
 858 </td>
 859 </tr>
 860
 861 <tr>
 862 <td style="border: 1px solid black;padding-left: 10px;" >
 863 sbh
 864 </td>
 865 <td style="border: 1px solid black;padding-left: 10px;" >
 866 Subscribe headers.  A stompngo.Headers instance.
 867 </td>
 868 </tr>
 869
 870 <tr>
 871 <td style="border: 1px solid black;padding-left: 10px;" >
 872 sc
 873 </td>
 874 <td style="border: 1px solid black;padding-left: 10px;" >
 875 A channel of type stompngo.MessageData.  Used in example code to
 876 receive messages and metadata from the broker.
 877 </td>
 878 </tr>
 879
 880
 881 <tr>
 882 <td style="border: 1px solid black;padding-left: 10px;" >
 883 sf
 884 </td>
 885 <td style="border: 1px solid black;padding-left: 10px;" >
 886 A send wait time multiplier.
 887 </td>
 888 </tr>
 889
 890 <tr>
 891 <td style="border: 1px solid black;padding-left: 10px;" >
 892 sh
 893 </td>
 894 <td style="border: 1px solid black;padding-left: 10px;" >
 895 Send headers.  A stompngo.Headers instance.
 896 </td>
 897 </tr>
 898
 899 <tr>
 900 <td style="border: 1px solid black;padding-left: 10px;" >
 901 sw
 902 </td>
 903 <td style="border: 1px solid black;padding-left: 10px;" >
 904 A wait flag used by senders. When set to true, senders wait for a
 905 random amount of time after each send.
 906 </td>
 907 </tr>
 908
 909 <tr>
 910 <td style="border: 1px solid black;padding-left: 10px;" >
 911 si
 912 </td>
 913 <td style="border: 1px solid black;padding-left: 10px;" >
 914 A loop counter formatted as a string.
 915 </td>
 916 </tr>
 917
 918 <tr>
 919 <td style="border: 1px solid black;padding-left: 10px;" >
 920 tc
 921 </td>
 922 <td style="border: 1px solid black;padding-left: 10px;" >
 923 An instance of *tls.Config.
 924 </td>
 925 </tr>
 926
 927 <tr>
 928 <td style="border: 1px solid black;padding-left: 10px;" >
 929 tmr
 930 </td>
 931 <td style="border: 1px solid black;padding-left: 10px;" >
 932 A time.Timer.
 933 </td>
 934 </tr>
 935
 936 <tr>
 937 <td style="border: 1px solid black;padding-left: 10px;" >
 938 wga
 939 </td>
 940 <td style="border: 1px solid black;padding-left: 10px;" >
 941 Wait group for all sender and receiver go routines.
 942 </td>
 943 </tr>
 944
 945 <tr>
 946 <td style="border: 1px solid black;padding-left: 10px;" >
 947 wgr
 948 </td>
 949 <td style="border: 1px solid black;padding-left: 10px;" >
 950 Wait group for all receiver go routines.
 951 </td>
 952 </tr>
 953
 954
 955 <tr>
 956 <td style="border: 1px solid black;padding-left: 10px;" >
 957 wgs
 958 </td>
 959 <td style="border: 1px solid black;padding-left: 10px;" >
 960 Wait group for all sender go routines.
 961 </td>
 962 </tr>
 963
 964 <tr>
 965 <td style="border: 1px solid black;padding-left: 10px;" >
 966 wh
 967 </td>
 968 <td style="border: 1px solid black;padding-left: 10px;" >
 969 Work headers.  A stompngo.Headers instance.
 970 </td>
 971 </tr>
 972
 973 </table>
 974
 975 ## Variable Names Specific to the TLS Examples  ##
 976
 977 <table border="1" style="width:80%;border: 1px solid black;">
 978 <tr>
 979 <th style="width:20%;border: 1px solid black;padding-left: 10px;" >
 980 Variable Name
 981 </th>
 982 <th style="width:60%border: 1px solid black;padding-left: 10px;" >
 983 Common Use
 984 </th>
 985 </tr>
 986
 987 <tr>
 988 <td style="border: 1px solid black;padding-left: 10px;" >
 989 b
 990 </td>
 991 <td style="border: 1px solid black;padding-left: 10px;" >
 992 A buffer, type []byte.
 993 </td>
 994 </tr>
 995
 996 <tr>
 997 <td style="border: 1px solid black;padding-left: 10px;" >
 998 c
 999 </td>
1000 <td style="border: 1px solid black;padding-left: 10px;" >
1001 An instance of *x509.Certificate.
1002 </td>
1003 </tr>
1004
1005 <tr>
1006 <td style="border: 1px solid black;padding-left: 10px;" >
1007 cc
1008 </td>
1009 <td style="border: 1px solid black;padding-left: 10px;" >
1010 An instance of tls.Certificate.
1011 </td>
1012 </tr>
1013
1014 <tr>
1015 <td style="border: 1px solid black;padding-left: 10px;" >
1016 cliCertFile
1017 </td>
1018 <td style="border: 1px solid black;padding-left: 10px;" >
1019 The full file name of the client's public cert in PEM format.
1020 </td>
1021 </tr>
1022
1023
1024 <tr>
1025 <td style="border: 1px solid black;padding-left: 10px;" >
1026 cliKeyFile
1027 </td>
1028 <td style="border: 1px solid black;padding-left: 10px;" >
1029 The full file name of the client's private key in PEM format.
1030 </td>
1031 </tr>
1032
1033 <tr>
1034 <td style="border: 1px solid black;padding-left: 10px;" >
1035 e
1036 </td>
1037 <td style="border: 1px solid black;padding-left: 10px;" >
1038 An instance of error.
1039 </td>
1040 </tr>
1041
1042 <tr>
1043 <td style="border: 1px solid black;padding-left: 10px;" >
1044 k
1045 </td>
1046 <td style="border: 1px solid black;padding-left: 10px;" >
1047 An instance of *pem.Block.
1048 </td>
1049 </tr>
1050
1051 <tr>
1052 <td style="border: 1px solid black;padding-left: 10px;" >
1053 ll
1054 </td>
1055 <td style="border: 1px solid black;padding-left: 10px;" >
1056 A logger instance.
1057 </td>
1058 </tr>
1059
1060 <tr>
1061 <td style="border: 1px solid black;padding-left: 10px;" >
1062 nc
1063 </td>
1064 <td style="border: 1px solid black;padding-left: 10px;" >
1065 A pointer to a tls configuration, type *tls.Config, obtained from
1066 'tls.Client'.
1067 </td>
1068 </tr>
1069
1070 <tr>
1071 <td style="border: 1px solid black;padding-left: 10px;" >
1072 svrCAFile
1073 </td>
1074 <td style="border: 1px solid black;padding-left: 10px;" >
1075 The full file name of the server CA's public cert in PEM format.
1076 </td>
1077 </tr>
1078
1079 <tr>
1080 <td style="border: 1px solid black;padding-left: 10px;" >
1081 t
1082 </td>
1083 <td style="border: 1px solid black;padding-left: 10px;" >
1084 An implementation of the net.Conn interface, obtained by calling
1085 net.Dial.
1086 </td>
1087 </tr>
1088
1089 <tr>
1090 <td style="border: 1px solid black;padding-left: 10px;" >
1091 tc
1092 </td>
1093 <td style="border: 1px solid black;padding-left: 10px;" >
1094 A pointer to a tls configuration, type *tls.Config, obtained from 'new'.
1095 </td>
1096 </tr>
1097
1098 </table>
1099