legacy-libs/grpc-cloned/node_modules/protobufjs/docs/ProtoBuf.Builder.Service.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4     <meta charset="utf-8">
   5     <title>JSDoc: Class: Service</title>
   6
   7     <script src="scripts/prettify/prettify.js"> </script>
   8     <script src="scripts/prettify/lang-css.js"> </script>
   9     <!--[if lt IE 9]>
  10       <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  11     <![endif]-->
  12     <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  13     <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  14 </head>
  15
  16 <body>
  17
  18 <div id="main">
  19
  20     <h1 class="page-title">Class: Service</h1>
  21
  22
  23
  24
  25
  26
  27 <section>
  28
  29 <header>
  30
  31         <h2>
  32             <span class="ancestors"><a href="ProtoBuf.html">ProtoBuf</a><a href="ProtoBuf.Builder.html">.Builder</a>.</span>
  33
  34         Service
  35         </h2>
  36
  37             <div class="class-description"><p>Barebone of all runtime services.</p></div>
  38
  39
  40 </header>
  41
  42 <article>
  43     <div class="container-overview">
  44
  45
  46
  47
  48     <h2>Constructor</h2>
  49
  50
  51     <h4 class="name" id="Service"><span class="type-signature"></span>new Service<span class="signature">(rpcImpl<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
  52
  53
  54
  55
  56
  57 <div class="description">
  58     <p>Constructs a new runtime Service.</p>
  59 </div>
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69     <h5>Parameters:</h5>
  70
  71
  72 <table class="params">
  73     <thead>
  74     <tr>
  75
  76         <th>Name</th>
  77
  78
  79         <th>Type</th>
  80
  81
  82         <th>Attributes</th>
  83
  84
  85
  86
  87         <th class="last">Description</th>
  88     </tr>
  89     </thead>
  90
  91     <tbody>
  92
  93
  94         <tr>
  95
  96                 <td class="name"><code>rpcImpl</code></td>
  97
  98
  99             <td class="type">
 100
 101
 102 <span class="param-type">function</span>
 103
 104
 105
 106             </td>
 107
 108
 109                 <td class="attributes">
 110
 111                     &lt;optional><br>
 112
 113
 114
 115
 116
 117                 </td>
 118
 119
 120
 121
 122             <td class="description last"><p>RPC implementation receiving the method name and the message</p></td>
 123         </tr>
 124
 125
 126     </tbody>
 127 </table>
 128
 129
 130
 131
 132
 133
 134 <dl class="details">
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161     <dt class="tag-source">Source:</dt>
 162     <dd class="tag-source"><ul class="dummy"><li>
 163         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4005">line 4005</a>
 164     </li></ul></dd>
 165
 166
 167
 168
 169
 170
 171
 172 </dl>
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184 <h5>Throws:</h5>
 185
 186
 187
 188 <dl>
 189     <dt>
 190         <div class="param-desc">
 191         <p>If the service cannot be created</p>
 192         </div>
 193     </dt>
 194     <dd></dd>
 195     <dt>
 196         <dl>
 197             <dt>
 198                 Type
 199             </dt>
 200             <dd>
 201
 202 <span class="param-type">Error</span>
 203
 204
 205             </dd>
 206         </dl>
 207     </dt>
 208     <dd></dd>
 209 </dl>
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219     </div>
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232         <h3 class="subsection-title">Members</h3>
 233
 234
 235
 236 <h4 class="name" id=".$options"><span class="type-signature">(static) </span>$options<span class="type-signature"> :Object.&lt;string, *></span></h4>
 237
 238
 239
 240
 241 <div class="description">
 242     <p>Service options.</p>
 243 </div>
 244
 245
 246
 247     <h5>Type:</h5>
 248     <ul>
 249         <li>
 250
 251 <span class="param-type">Object.&lt;string, *></span>
 252
 253
 254         </li>
 255     </ul>
 256
 257
 258
 259
 260
 261 <dl class="details">
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288     <dt class="tag-source">Source:</dt>
 289     <dd class="tag-source"><ul class="dummy"><li>
 290         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4108">line 4108</a>
 291     </li></ul></dd>
 292
 293
 294
 295
 296
 297
 298
 299 </dl>
 300
 301
 302
 303
 304
 305
 306
 307
 308 <h4 class="name" id=".$type"><span class="type-signature">(static, non-null) </span>$type<span class="type-signature"> :<a href="ProtoBuf.Reflect.Service.html">ProtoBuf.Reflect.Service</a></span></h4>
 309
 310
 311
 312
 313 <div class="description">
 314     <p>Reflection type.</p>
 315 </div>
 316
 317
 318
 319     <h5>Type:</h5>
 320     <ul>
 321         <li>
 322
 323 <span class="param-type"><a href="ProtoBuf.Reflect.Service.html">ProtoBuf.Reflect.Service</a></span>
 324
 325
 326         </li>
 327     </ul>
 328
 329
 330
 331
 332
 333 <dl class="details">
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360     <dt class="tag-source">Source:</dt>
 361     <dd class="tag-source"><ul class="dummy"><li>
 362         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4124">line 4124</a>
 363     </li></ul></dd>
 364
 365
 366
 367
 368
 369
 370
 371 </dl>
 372
 373
 374
 375
 376
 377
 378
 379
 380 <h4 class="name" id="$options"><span class="type-signature"></span>$options<span class="type-signature"> :Object.&lt;string, *></span></h4>
 381
 382
 383
 384
 385 <div class="description">
 386     <p>Service options.</p>
 387 </div>
 388
 389
 390
 391     <h5>Type:</h5>
 392     <ul>
 393         <li>
 394
 395 <span class="param-type">Object.&lt;string, *></span>
 396
 397
 398         </li>
 399     </ul>
 400
 401
 402
 403
 404
 405 <dl class="details">
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432     <dt class="tag-source">Source:</dt>
 433     <dd class="tag-source"><ul class="dummy"><li>
 434         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4116">line 4116</a>
 435     </li></ul></dd>
 436
 437
 438
 439
 440
 441
 442
 443 </dl>
 444
 445
 446
 447
 448
 449
 450
 451
 452 <h4 class="name" id="$type"><span class="type-signature">(non-null) </span>$type<span class="type-signature"> :<a href="ProtoBuf.Reflect.Service.html">ProtoBuf.Reflect.Service</a></span></h4>
 453
 454
 455
 456
 457 <div class="description">
 458     <p>Reflection type.</p>
 459 </div>
 460
 461
 462
 463     <h5>Type:</h5>
 464     <ul>
 465         <li>
 466
 467 <span class="param-type"><a href="ProtoBuf.Reflect.Service.html">ProtoBuf.Reflect.Service</a></span>
 468
 469
 470         </li>
 471     </ul>
 472
 473
 474
 475
 476
 477 <dl class="details">
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504     <dt class="tag-source">Source:</dt>
 505     <dd class="tag-source"><ul class="dummy"><li>
 506         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4132">line 4132</a>
 507     </li></ul></dd>
 508
 509
 510
 511
 512
 513
 514
 515 </dl>
 516
 517
 518
 519
 520
 521
 522
 523
 524 <h4 class="name" id="rpcImpl"><span class="type-signature">(non-null) </span>rpcImpl<span class="type-signature"> :function</span></h4>
 525
 526
 527
 528
 529 <div class="description">
 530     <p>Service implementation.</p>
 531 </div>
 532
 533
 534
 535     <h5>Type:</h5>
 536     <ul>
 537         <li>
 538
 539 <span class="param-type">function</span>
 540
 541
 542         </li>
 543     </ul>
 544
 545
 546
 547
 548
 549 <dl class="details">
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576     <dt class="tag-source">Source:</dt>
 577     <dd class="tag-source"><ul class="dummy"><li>
 578         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4016">line 4016</a>
 579     </li></ul></dd>
 580
 581
 582
 583
 584
 585
 586
 587 </dl>
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598         <h3 class="subsection-title">Methods</h3>
 599
 600
 601
 602
 603
 604
 605     <h4 class="name" id=".%5BMethod%5D"><span class="type-signature">(abstract, static) </span>[Method]<span class="signature">(rpcImpl<span class="signature-attributes">non-null</span>, req, callback)</span><span class="type-signature"></span></h4>
 606
 607
 608
 609
 610
 611 <div class="description">
 612     <p>Asynchronously performs an RPC call using the given RPC implementation.</p>
 613 </div>
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623     <h5>Parameters:</h5>
 624
 625
 626 <table class="params">
 627     <thead>
 628     <tr>
 629
 630         <th>Name</th>
 631
 632
 633         <th>Type</th>
 634
 635
 636
 637
 638
 639         <th class="last">Description</th>
 640     </tr>
 641     </thead>
 642
 643     <tbody>
 644
 645
 646         <tr>
 647
 648                 <td class="name"><code>rpcImpl</code></td>
 649
 650
 651             <td class="type">
 652
 653
 654 <span class="param-type">function</span>
 655
 656
 657
 658             </td>
 659
 660
 661
 662
 663
 664             <td class="description last"><p>RPC implementation</p></td>
 665         </tr>
 666
 667
 668
 669         <tr>
 670
 671                 <td class="name"><code>req</code></td>
 672
 673
 674             <td class="type">
 675
 676
 677 <span class="param-type"><a href="ProtoBuf.Builder.Message.html">ProtoBuf.Builder.Message</a></span>
 678
 679
 680
 681             </td>
 682
 683
 684
 685
 686
 687             <td class="description last"><p>Request</p></td>
 688         </tr>
 689
 690
 691
 692         <tr>
 693
 694                 <td class="name"><code>callback</code></td>
 695
 696
 697             <td class="type">
 698
 699
 700 <span class="param-type">function</span>
 701
 702
 703
 704             </td>
 705
 706
 707
 708
 709
 710             <td class="description last"><p>Callback receiving
 711  the error if any and the response either as a pre-parsed message or as its raw bytes</p></td>
 712         </tr>
 713
 714
 715     </tbody>
 716 </table>
 717
 718
 719
 720
 721
 722
 723 <dl class="details">
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750     <dt class="tag-source">Source:</dt>
 751     <dd class="tag-source"><ul class="dummy"><li>
 752         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4036">line 4036</a>
 753     </li></ul></dd>
 754
 755
 756
 757
 758
 759
 760
 761 </dl>
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783     <h4 class="name" id="%5BMethod%5D"><span class="type-signature">(abstract) </span>[Method]<span class="signature">(req, callback)</span><span class="type-signature"></span></h4>
 784
 785
 786
 787
 788
 789 <div class="description">
 790     <p>Asynchronously performs an RPC call using the instance's RPC implementation.</p>
 791 </div>
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801     <h5>Parameters:</h5>
 802
 803
 804 <table class="params">
 805     <thead>
 806     <tr>
 807
 808         <th>Name</th>
 809
 810
 811         <th>Type</th>
 812
 813
 814
 815
 816
 817         <th class="last">Description</th>
 818     </tr>
 819     </thead>
 820
 821     <tbody>
 822
 823
 824         <tr>
 825
 826                 <td class="name"><code>req</code></td>
 827
 828
 829             <td class="type">
 830
 831
 832 <span class="param-type"><a href="ProtoBuf.Builder.Message.html">ProtoBuf.Builder.Message</a></span>
 833
 834
 835
 836             </td>
 837
 838
 839
 840
 841
 842             <td class="description last"><p>Request</p></td>
 843         </tr>
 844
 845
 846
 847         <tr>
 848
 849                 <td class="name"><code>callback</code></td>
 850
 851
 852             <td class="type">
 853
 854
 855 <span class="param-type">function</span>
 856
 857
 858
 859             </td>
 860
 861
 862
 863
 864
 865             <td class="description last"><p>Callback receiving
 866  the error if any and the response either as a pre-parsed message or as its raw bytes</p></td>
 867         </tr>
 868
 869
 870     </tbody>
 871 </table>
 872
 873
 874
 875
 876
 877
 878 <dl class="details">
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905     <dt class="tag-source">Source:</dt>
 906     <dd class="tag-source"><ul class="dummy"><li>
 907         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4047">line 4047</a>
 908     </li></ul></dd>
 909
 910
 911
 912
 913
 914
 915
 916 </dl>
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939 </article>
 940
 941 </section>
 942
 943
 944
 945
 946 </div>
 947
 948 <nav>
 949     <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ProtoBuf.Builder.html">Builder</a></li><li><a href="ProtoBuf.Builder.Message.html">Message</a></li><li><a href="ProtoBuf.Builder.Service.html">Service</a></li><li><a href="ProtoBuf.DotProto.Parser.html">Parser</a></li><li><a href="ProtoBuf.DotProto.Tokenizer.html">Tokenizer</a></li><li><a href="ProtoBuf.Map.html">Map</a></li><li><a href="ProtoBuf.Reflect.Element.html">Element</a></li><li><a href="ProtoBuf.Reflect.Enum.html">Enum</a></li><li><a href="ProtoBuf.Reflect.Enum.Value.html">Value</a></li><li><a href="ProtoBuf.Reflect.Extension.html">Extension</a></li><li><a href="ProtoBuf.Reflect.Message.html">Message</a></li><li><a href="ProtoBuf.Reflect.Message.ExtensionField.html">ExtensionField</a></li><li><a href="ProtoBuf.Reflect.Message.Field.html">Field</a></li><li><a href="ProtoBuf.Reflect.Message.OneOf.html">OneOf</a></li><li><a href="ProtoBuf.Reflect.Namespace.html">Namespace</a></li><li><a href="ProtoBuf.Reflect.Service.html">Service</a></li><li><a href="ProtoBuf.Reflect.Service.Method.html">Method</a></li><li><a href="ProtoBuf.Reflect.Service.RPCMethod.html">RPCMethod</a></li><li><a href="ProtoBuf.Reflect.T.html">T</a></li></ul><h3>Namespaces</h3><ul><li><a href="ProtoBuf.html">ProtoBuf</a></li><li><a href="ProtoBuf.DotProto.html">DotProto</a></li><li><a href="ProtoBuf.Reflect.html">Reflect</a></li><li><a href="ProtoBuf.Util.html">Util</a></li></ul>
 950 </nav>
 951
 952 <br class="clear">
 953
 954 <footer>
 955     Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Fri Jan 27 2017 17:03:55 GMT+0100 (Mitteleuropäische Zeit)
 956 </footer>
 957
 958 <script> prettyPrint(); </script>
 959 <script src="scripts/linenumber.js"> </script>
 960 </body>
 961 </html>