| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width">
- <title>Documentation Namespace: grpc</title>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
- <link type="text/css" rel="stylesheet" href="styles/site.simplex.css">
- </head>
- <body>
- <div class="navbar navbar-default navbar-fixed-top ">
- <div class="container">
- <div class="navbar-header">
- <a class="navbar-brand" href="index.html">Documentation</a>
- <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
- </div>
- <div class="navbar-collapse collapse" id="topNavigation">
- <ul class="nav navbar-nav">
-
- <li class="dropdown">
- <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
- <ul class="dropdown-menu ">
- <li><a href="grpc.html">grpc</a></li><li><a href="grpc.credentials.html">grpc.credentials</a></li>
- </ul>
- </li>
-
- <li class="dropdown">
- <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
- <ul class="dropdown-menu ">
- <li><a href="grpc.Client.html">grpc.Client</a></li><li><a href="grpc.credentials-CallCredentials.html">grpc.credentials~CallCredentials</a></li><li><a href="grpc.credentials-ChannelCredentials.html">grpc.credentials~ChannelCredentials</a></li><li><a href="grpc.Metadata.html">grpc.Metadata</a></li><li><a href="grpc.Server.html">grpc.Server</a></li><li><a href="grpc.ServerCredentials.html">grpc.ServerCredentials</a></li><li><a href="grpc-ClientDuplexStream.html">grpc~ClientDuplexStream</a></li><li><a href="grpc-ClientReadableStream.html">grpc~ClientReadableStream</a></li><li><a href="grpc-ClientUnaryCall.html">grpc~ClientUnaryCall</a></li><li><a href="grpc-ClientWritableStream.html">grpc~ClientWritableStream</a></li><li><a href="grpc-ServerDuplexStream.html">grpc~ServerDuplexStream</a></li><li><a href="grpc-ServerReadableStream.html">grpc~ServerReadableStream</a></li><li><a href="grpc-ServerUnaryCall.html">grpc~ServerUnaryCall</a></li><li><a href="grpc-ServerWritableStream.html">grpc~ServerWritableStream</a></li>
- </ul>
- </li>
-
- <li class="dropdown">
- <a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
- <ul class="dropdown-menu ">
- <li><a href="grpc-ClientDuplexStream.html#event:metadata">grpc~ClientDuplexStream#metadata</a></li><li><a href="grpc-ClientDuplexStream.html#event:status">grpc~ClientDuplexStream#status</a></li><li><a href="grpc-ClientReadableStream.html#event:metadata">grpc~ClientReadableStream#metadata</a></li><li><a href="grpc-ClientReadableStream.html#event:status">grpc~ClientReadableStream#status</a></li><li><a href="grpc-ClientUnaryCall.html#event:metadata">grpc~ClientUnaryCall#event:metadata</a></li><li><a href="grpc-ClientUnaryCall.html#event:status">grpc~ClientUnaryCall#event:status</a></li><li><a href="grpc-ClientWritableStream.html#event:metadata">grpc~ClientWritableStream#metadata</a></li><li><a href="grpc-ClientWritableStream.html#event:status">grpc~ClientWritableStream#status</a></li><li><a href="grpc-ServerDuplexStream.html#~event:cancelled">grpc~ServerDuplexStream~event:cancelled</a></li><li><a href="grpc-ServerReadableStream.html#~event:cancelled">grpc~ServerReadableStream~event:cancelled</a></li><li><a href="grpc-ServerUnaryCall.html#~event:cancelled">grpc~ServerUnaryCall~event:cancelled</a></li><li><a href="grpc-ServerWritableStream.html#~event:cancelled">grpc~ServerWritableStream~event:cancelled</a></li>
- </ul>
- </li>
-
- <li class="dropdown">
- <a href="externals.list.html" class="dropdown-toggle" data-toggle="dropdown">Externals<b class="caret"></b></a>
- <ul class="dropdown-menu ">
- <li><a href="external-Duplex.html">Duplex</a></li><li><a href="external-EventEmitter.html">EventEmitter</a></li><li><a href="external-GoogleCredential.html">GoogleCredential</a></li><li><a href="external-Readable.html">Readable</a></li><li><a href="external-Writable.html">Writable</a></li>
- </ul>
- </li>
-
- </ul>
-
- <div class="col-sm-3 col-md-3">
- <form class="navbar-form" role="search">
- <div class="input-group">
- <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
- <div class="input-group-btn">
- <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
- </div>
- </div>
- </form>
- </div>
-
- </div>
- </div>
- </div>
- <div class="container" id="toc-content">
- <div class="row">
-
- <div class="col-md-8">
-
- <div id="main">
-
- <h1 class="page-title">Namespace: grpc</h1>
- <section>
- <header>
-
- <h2>
- grpc
- </h2>
-
-
- </header>
- <article>
- <div class="container-overview">
-
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
-
- </div>
-
-
-
- <h3 class="subsection-title">Classes</h3>
- <dl>
- <dt><a href="grpc.Client.html">Client</a></dt>
- <dd></dd>
-
- <dt><a href="grpc.Metadata.html">Metadata</a></dt>
- <dd></dd>
-
- <dt><a href="grpc.Server.html">Server</a></dt>
- <dd></dd>
-
- <dt><a href="grpc.ServerCredentials.html">ServerCredentials</a></dt>
- <dd></dd>
-
- <dt><a href="grpc-ClientDuplexStream.html">ClientDuplexStream</a></dt>
- <dd></dd>
-
- <dt><a href="grpc-ClientReadableStream.html">ClientReadableStream</a></dt>
- <dd></dd>
-
- <dt><a href="grpc-ClientUnaryCall.html">ClientUnaryCall</a></dt>
- <dd></dd>
-
- <dt><a href="grpc-ClientWritableStream.html">ClientWritableStream</a></dt>
- <dd></dd>
-
- <dt><a href="grpc-ServerDuplexStream.html">ServerDuplexStream</a></dt>
- <dd></dd>
-
- <dt><a href="grpc-ServerReadableStream.html">ServerReadableStream</a></dt>
- <dd></dd>
-
- <dt><a href="grpc-ServerUnaryCall.html">ServerUnaryCall</a></dt>
- <dd></dd>
-
- <dt><a href="grpc-ServerWritableStream.html">ServerWritableStream</a></dt>
- <dd></dd>
- </dl>
-
-
-
- <h3 class="subsection-title">Namespaces</h3>
- <dl>
- <dt><a href="namespaces.html#grpc.credentials"><a href="grpc.credentials.html">credentials</a></a></dt>
- <dd></dd>
- </dl>
-
-
- <h3 class="subsection-title">Members</h3>
- <dl>
-
- <hr>
- <dt class="name" id=".callError">
- <h4 id=".callError"><span class="type-signature"><static, constant> </span>callError<span class="type-signature"> :number</span></h4>
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Call error constants. Call errors almost always indicate bugs in the gRPC
- library, and these error codes are mainly useful for finding those bugs.</p>
- </div>
-
-
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">number</span>
- </li>
- </ul>
-
-
- <dl class="details">
-
- <h5 class="subsection-title">Properties:</h5>
- <dl>
- <table class="props table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th>Default</th>
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>OK</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 0
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>ERROR</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 1
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>NOT_ON_SERVER</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 2
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>NOT_ON_CLIENT</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 3
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>ALREADY_INVOKED</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 5
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>NOT_INVOKED</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 6
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>ALREADY_FINISHED</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 7
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>TOO_MANY_OPERATIONS</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 8
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>INVALID_FLAGS</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 9
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>INVALID_METADATA</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 10
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>INVALID_MESSAGE</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 11
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>NOT_SERVER_COMPLETION_QUEUE</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 12
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>BATCH_TOO_BIG</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 13
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>PAYLOAD_TYPE_MISMATCH</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 14
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- </tbody>
- </table>
- </dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
- </dd>
-
-
- <hr>
- <dt class="name" id=".logVerbosity">
- <h4 id=".logVerbosity"><span class="type-signature"><static, readonly> </span>logVerbosity<span class="type-signature"> :number</span></h4>
-
- </dt>
- <dd>
-
-
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">number</span>
- </li>
- </ul>
-
-
- <dl class="details">
-
- <h5 class="subsection-title">Properties:</h5>
- <dl>
- <table class="props table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th>Default</th>
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>DEBUG</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 0
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>INFO</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 1
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>ERROR</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 2
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- </tbody>
- </table>
- </dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
- </dd>
-
-
- <hr>
- <dt class="name" id=".propagate">
- <h4 id=".propagate"><span class="type-signature"><static> </span>propagate<span class="type-signature"> :number</span></h4>
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Propagation flags: these can be bitwise or-ed to form the propagation option
- for calls.</p>
- <p>Users are encouraged to write propagation masks as deltas from the default.
- i.e. write <code>grpc.propagate.DEFAULTS & ~grpc.propagate.DEADLINE</code> to disable
- deadline propagation.</p>
- </div>
-
-
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">number</span>
- </li>
- </ul>
-
-
- <dl class="details">
-
- <h5 class="subsection-title">Properties:</h5>
- <dl>
- <table class="props table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th>Default</th>
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>DEADLINE</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 1
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>CENSUS_STATS_CONTEXT</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 2
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>CENSUS_TRACING_CONTEXT</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 4
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>CANCELLATION</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 8
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>DEFAULTS</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 65535
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- </tbody>
- </table>
- </dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
- </dd>
-
-
- <hr>
- <dt class="name" id=".status">
- <h4 id=".status"><span class="type-signature"><static, readonly> </span>status<span class="type-signature"> :number</span></h4>
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Enum of status codes that gRPC can return</p>
- </div>
-
-
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">number</span>
- </li>
- </ul>
-
-
- <dl class="details">
-
- <h5 class="subsection-title">Properties:</h5>
- <dl>
- <table class="props table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th>Default</th>
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>OK</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 0
-
- </td>
-
- <td class="description last"><p>Not an error; returned on success</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>CANCELLED</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 1
-
- </td>
-
- <td class="description last"><p>The operation was cancelled (typically by the caller).</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>UNKNOWN</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 2
-
- </td>
-
- <td class="description last"><p>Unknown error. An example of where this error may be returned is
- if a status value received from another address space belongs to
- an error-space that is not known in this address space. Also
- errors raised by APIs that do not return enough error information
- may be converted to this error.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>INVALID_ARGUMENT</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 3
-
- </td>
-
- <td class="description last"><p>Client specified an invalid argument. Note that this differs
- from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments
- that are problematic regardless of the state of the system
- (e.g., a malformed file name).</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>DEADLINE_EXCEEDED</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 4
-
- </td>
-
- <td class="description last"><p>Deadline expired before operation could complete. For operations
- that change the state of the system, this error may be returned
- even if the operation has completed successfully. For example, a
- successful response from a server could have been delayed long
- enough for the deadline to expire.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>NOT_FOUND</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 5
-
- </td>
-
- <td class="description last"><p>Some requested entity (e.g., file or directory) was not found.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>ALREADY_EXISTS</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 6
-
- </td>
-
- <td class="description last"><p>Some entity that we attempted to create (e.g., file or directory)
- already exists.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>PERMISSION_DENIED</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 7
-
- </td>
-
- <td class="description last"><p>The caller does not have permission to execute the specified
- operation. PERMISSION_DENIED must not be used for rejections
- caused by exhausting some resource (use RESOURCE_EXHAUSTED
- instead for those errors). PERMISSION_DENIED must not be
- used if the caller can not be identified (use UNAUTHENTICATED
- instead for those errors).</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>RESOURCE_EXHAUSTED</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 8
-
- </td>
-
- <td class="description last"><p>Some resource has been exhausted, perhaps a per-user quota, or
- perhaps the entire file system is out of space.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>FAILED_PRECONDITION</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 9
-
- </td>
-
- <td class="description last"><p>Operation was rejected because the system is not in a state
- required for the operation's execution. For example, directory
- to be deleted may be non-empty, an rmdir operation is applied to
- a non-directory, etc.</p>
- <p>A litmus test that may help a service implementor in deciding
- between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE:</p>
- <ul>
- <li>Use UNAVAILABLE if the client can retry just the failing call.</li>
- <li>Use ABORTED if the client should retry at a higher-level
- (e.g., restarting a read-modify-write sequence).</li>
- <li>Use FAILED_PRECONDITION if the client should not retry until
- the system state has been explicitly fixed. E.g., if an "rmdir"
- fails because the directory is non-empty, FAILED_PRECONDITION
- should be returned since the client should not retry unless
- they have first fixed up the directory by deleting files from it.</li>
- <li>Use FAILED_PRECONDITION if the client performs conditional
- REST Get/Update/Delete on a resource and the resource on the
- server does not match the condition. E.g., conflicting
- read-modify-write on the same resource.</li>
- </ul></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>ABORTED</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 10
-
- </td>
-
- <td class="description last"><p>The operation was aborted, typically due to a concurrency issue
- like sequencer check failures, transaction aborts, etc.</p>
- <p>See litmus test above for deciding between FAILED_PRECONDITION,
- ABORTED, and UNAVAILABLE.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>OUT_OF_RANGE</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 11
-
- </td>
-
- <td class="description last"><p>Operation was attempted past the valid range. E.g., seeking or
- reading past end of file.</p>
- <p>Unlike INVALID_ARGUMENT, this error indicates a problem that may
- be fixed if the system state changes. For example, a 32-bit file
- system will generate INVALID_ARGUMENT if asked to read at an
- offset that is not in the range [0,2^32-1], but it will generate
- OUT_OF_RANGE if asked to read from an offset past the current
- file size.</p>
- <p>There is a fair bit of overlap between FAILED_PRECONDITION and
- OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific
- error) when it applies so that callers who are iterating through
- a space can easily look for an OUT_OF_RANGE error to detect when
- they are done.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>UNIMPLEMENTED</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 12
-
- </td>
-
- <td class="description last"><p>Operation is not implemented or not supported/enabled in this service.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>INTERNAL</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 13
-
- </td>
-
- <td class="description last"><p>Internal errors. Means some invariants expected by underlying
- system has been broken. If you see one of these errors,
- something is very broken.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>UNAVAILABLE</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 14
-
- </td>
-
- <td class="description last"><p>The service is currently unavailable. This is a most likely a
- transient condition and may be corrected by retrying with
- a backoff.</p>
- <p>See litmus test above for deciding between FAILED_PRECONDITION,
- ABORTED, and UNAVAILABLE.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>DATA_LOSS</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 15
-
- </td>
-
- <td class="description last"><p>Unrecoverable data loss or corruption.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>UNAUTHENTICATED</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 16
-
- </td>
-
- <td class="description last"><p>The request does not have valid authentication credentials for the
- operation.</p></td>
- </tr>
-
- </tbody>
- </table>
- </dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
- </dd>
-
-
- <hr>
- <dt class="name" id=".writeFlags">
- <h4 id=".writeFlags"><span class="type-signature"><static, readonly> </span>writeFlags<span class="type-signature"> :number</span></h4>
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Write flags: these can be bitwise or-ed to form write options that modify
- how data is written.</p>
- </div>
-
-
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">number</span>
- </li>
- </ul>
-
-
- <dl class="details">
-
- <h5 class="subsection-title">Properties:</h5>
- <dl>
- <table class="props table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th>Default</th>
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>BUFFER_HINT</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 1
-
- </td>
-
- <td class="description last"><p>Hint that the write may be buffered and need not go out on the wire
- immediately. GRPC is free to buffer the message until the next non-buffered
- write, or until writes_done, but it need not buffer completely or at all.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>NO_COMPRESS</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 2
-
- </td>
-
- <td class="description last"><p>Force compression to be disabled for a particular write</p></td>
- </tr>
-
- </tbody>
- </table>
- </dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
- </dd>
-
-
- <hr>
- <dt class="name" id="~defaultLoadOptions">
- <h4 id="~defaultLoadOptions"><span class="type-signature"><inner> </span>defaultLoadOptions<span class="type-signature"></span></h4>
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Default options for loading proto files into gRPC</p>
- </div>
-
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
- </dd>
- </dl>
-
-
- <h3 class="subsection-title">Methods</h3>
- <dl>
-
- <hr>
- <dt>
- <h4 class="name" id=".closeClient"><span class="type-signature"><static> </span>closeClient(client_obj)</h4>
-
-
- </dt>
- <dd>
-
-
-
-
-
- <h5>Parameters:</h5>
-
- <table class="params table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>client_obj</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="grpc.Client.html">grpc.Client</a></span>
-
- </td>
-
-
- <td class="description last"><p>The client to close</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
-
-
-
-
-
-
- </dd>
-
-
- <hr>
- <dt>
- <h4 class="name" id=".load"><span class="type-signature"><static> </span>load(filename [, format] [, options])</h4>
-
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Load a gRPC object from a .proto file.</p>
- </div>
-
-
-
-
-
- <h5>Parameters:</h5>
-
- <table class="params table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
- <th>Argument</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>filename</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
- |
- <span class="param-type">Object</span>
-
- </td>
-
- <td class="attributes">
-
-
-
- </td>
-
-
- <td class="description last"><p>The file to load</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>format</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="description last"><p>The file format to expect. Must be either 'proto' or
- 'json'. Defaults to 'proto'</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>options</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Object</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="description last"><p>Options to apply to the loaded file</p>
- <h6 class="method-params-label method-subparams-label">Properties</h6>
-
- <table class="params table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
- <th>Argument</th>
-
-
- <th>Default</th>
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>convertFieldsToCamelCase</code></td>
-
- <td class="type">
-
-
- <span class="param-type">bool</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="default">
-
- false
-
- </td>
-
- <td class="description last"><p>Load this file with
- field names in camel case instead of their original case</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>binaryAsBase64</code></td>
-
- <td class="type">
-
-
- <span class="param-type">bool</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="default">
-
- false
-
- </td>
-
- <td class="description last"><p>deserialize bytes values as
- base64 strings instead of Buffers</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>longsAsStrings</code></td>
-
- <td class="type">
-
-
- <span class="param-type">bool</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="default">
-
- true
-
- </td>
-
- <td class="description last"><p>deserialize long values as
- strings instead of objects</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>deprecatedArgumentOrder</code></td>
-
- <td class="type">
-
-
- <span class="param-type">bool</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="default">
-
- false
-
- </td>
-
- <td class="description last"><p>use the beta method
- argument order for client methods, with optional arguments after the
- callback. This option is only a temporary stopgap measure to smooth an
- API breakage. It is deprecated, and new code should not use it.</p></td>
- </tr>
-
- </tbody>
- </table>
- </td>
- </tr>
-
- </tbody>
- </table>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
- <div class="param-desc">
- <p>The resulting gRPC object</p>
- </div>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">Object.<string, *></span>
- </dd>
- </dl>
-
-
- </dd>
-
-
- <hr>
- <dt>
- <h4 class="name" id=".loadObject"><span class="type-signature"><static> </span>loadObject(value [, options])</h4>
-
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Load a ProtoBuf.js object as a gRPC object.</p>
- </div>
-
-
-
-
-
- <h5>Parameters:</h5>
-
- <table class="params table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
- <th>Argument</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>value</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Object</span>
-
- </td>
-
- <td class="attributes">
-
-
-
- </td>
-
-
- <td class="description last"><p>The ProtoBuf.js reflection object to load</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>options</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Object</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="description last"><p>Options to apply to the loaded file</p>
- <h6 class="method-params-label method-subparams-label">Properties</h6>
-
- <table class="params table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
- <th>Argument</th>
-
-
- <th>Default</th>
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>binaryAsBase64</code></td>
-
- <td class="type">
-
-
- <span class="param-type">bool</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="default">
-
- false
-
- </td>
-
- <td class="description last"><p>deserialize bytes values as
- base64 strings instead of Buffers</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>longsAsStrings</code></td>
-
- <td class="type">
-
-
- <span class="param-type">bool</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="default">
-
- true
-
- </td>
-
- <td class="description last"><p>deserialize long values as
- strings instead of objects</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>enumsAsStrings</code></td>
-
- <td class="type">
-
-
- <span class="param-type">bool</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="default">
-
- true
-
- </td>
-
- <td class="description last"><p>deserialize enum values as
- strings instead of numbers. Only works with Protobuf.js 6 values.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>deprecatedArgumentOrder</code></td>
-
- <td class="type">
-
-
- <span class="param-type">bool</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="default">
-
- false
-
- </td>
-
- <td class="description last"><p>use the beta method
- argument order for client methods, with optional arguments after the
- callback. This option is only a temporary stopgap measure to smooth an
- API breakage. It is deprecated, and new code should not use it.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>protobufjsVersion</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
- |
- <span class="param-type">string</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="default">
-
- 'detect'
-
- </td>
-
- <td class="description last"><p>5 and 6
- respectively indicate that an object from the corresponding version of
- Protobuf.js is provided in the value argument. If the option is 'detect',
- gRPC will guess what the version is based on the structure of the value.</p></td>
- </tr>
-
- </tbody>
- </table>
- </td>
- </tr>
-
- </tbody>
- </table>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
- <div class="param-desc">
- <p>The resulting gRPC object.</p>
- </div>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">Object.<string, *></span>
- </dd>
- </dl>
-
-
- </dd>
-
-
- <hr>
- <dt>
- <h4 class="name" id=".setLogger"><span class="type-signature"><static> </span>setLogger(logger)</h4>
-
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Sets the logger function for the gRPC module. For debugging purposes, the C
- core will log synchronously directly to stdout unless this function is
- called. Note: the output format here is intended to be informational, and
- is not guaranteed to stay the same in the future.
- Logs will be directed to logger.error.</p>
- </div>
-
-
-
-
-
- <h5>Parameters:</h5>
-
- <table class="params table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>logger</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Console</span>
-
- </td>
-
-
- <td class="description last"><p>A Console-like object.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
-
-
-
-
-
-
- </dd>
-
-
- <hr>
- <dt>
- <h4 class="name" id=".setLogVerbosity"><span class="type-signature"><static> </span>setLogVerbosity(verbosity)</h4>
-
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Sets the logger verbosity for gRPC module logging. The options are members
- of the grpc.logVerbosity map.</p>
- </div>
-
-
-
-
-
- <h5>Parameters:</h5>
-
- <table class="params table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>verbosity</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>The minimum severity to log</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
-
-
-
-
-
-
- </dd>
-
-
- <hr>
- <dt>
- <h4 class="name" id="~getClientChannel"><span class="type-signature"><inner> </span>getClientChannel(client)</h4>
-
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Return the underlying channel object for the specified client</p>
- </div>
-
-
-
-
-
- <h5>Parameters:</h5>
-
- <table class="params table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>client</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="grpc.Client.html">grpc.Client</a></span>
-
- </td>
-
-
- <td class="description last"><p>The client</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
- <dd class="tag-see">
- <ul>
- <li><a href="grpc.Client.html#getChannel">grpc.Client#getChannel</a></li>
- </ul>
- </dd>
-
-
- </dl>
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
- <div class="param-desc">
- <p>The channel</p>
- </div>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">Channel</span>
- </dd>
- </dl>
-
-
- </dd>
-
-
- <hr>
- <dt>
- <h4 class="name" id="~makeGenericClientConstructor"><span class="type-signature"><inner> </span>makeGenericClientConstructor(methods, serviceName, class_options)</h4>
-
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Creates a constructor for a client with the given methods, as specified in
- the methods argument. The resulting class will have an instance method for
- each method in the service, which is a partial application of one of the
- <a href="grpc.Client.html">Client</a> request methods, depending on <code>requestSerialize</code>
- and <code>responseSerialize</code>, with the <code>method</code>, <code>serialize</code>, and <code>deserialize</code>
- arguments predefined.</p>
- </div>
-
-
-
-
-
- <h5>Parameters:</h5>
-
- <table class="params table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>methods</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="grpc.html#~ServiceDefinition">grpc~ServiceDefinition</a></span>
-
- </td>
-
-
- <td class="description last"><p>An object mapping method names to
- method attributes</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>serviceName</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last"><p>The fully qualified name of the service</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>class_options</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Object</span>
-
- </td>
-
-
- <td class="description last"><p>An options object.</p>
- <h6 class="method-params-label method-subparams-label">Properties</h6>
-
- <table class="params table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
- <th>Argument</th>
-
-
- <th>Default</th>
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>deprecatedArgumentOrder</code></td>
-
- <td class="type">
-
-
- <span class="param-type">boolean</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="default">
-
- false
-
- </td>
-
- <td class="description last"><p>Indicates
- that the old argument order should be used for methods, with optional
- arguments at the end instead of the callback at the end. This option
- is only a temporary stopgap measure to smooth an API breakage.
- It is deprecated, and new code should not use it.</p></td>
- </tr>
-
- </tbody>
- </table>
- </td>
- </tr>
-
- </tbody>
- </table>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
- <div class="param-desc">
- <p>New client constructor, which is a subclass of
- <a href="grpc.Client.html">grpc.Client</a>, and has the same arguments as that constructor.</p>
- </div>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">function</span>
- </dd>
- </dl>
-
-
- </dd>
-
-
- <hr>
- <dt>
- <h4 class="name" id="~waitForClientReady"><span class="type-signature"><inner> </span>waitForClientReady(client, deadline, callback)</h4>
-
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Wait for the client to be ready. The callback will be called when the
- client has successfully connected to the server, and it will be called
- with an error if the attempt to connect to the server has unrecoverablly
- failed or if the deadline expires. This function will make the channel
- start connecting if it has not already done so.</p>
- </div>
-
-
-
-
-
- <h5>Parameters:</h5>
-
- <table class="params table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>client</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="grpc.Client.html">grpc.Client</a></span>
-
- </td>
-
-
- <td class="description last"><p>The client to wait on</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>deadline</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="grpc.html#~Deadline">grpc~Deadline</a></span>
-
- </td>
-
-
- <td class="description last"><p>When to stop waiting for a connection. Pass
- Infinity to wait forever.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>callback</code></td>
-
- <td class="type">
-
-
- <span class="param-type">function</span>
-
- </td>
-
-
- <td class="description last"><p>The callback to call when done attempting
- to connect.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
- <dd class="tag-see">
- <ul>
- <li><a href="grpc.Client.html#waitForReady">grpc.Client#waitForReady</a></li>
- </ul>
- </dd>
-
-
- </dl>
-
-
-
-
-
-
-
- </dd>
- </dl>
-
-
- <h3 class="subsection-title">Type Definitions</h3>
- <dl>
-
- <hr>
- <dt class="name" id="~Deadline">
- <h4 id="~Deadline">Deadline</h4>
-
- </dt>
- <dd>
-
- <div class="description">
- <p>The deadline of an operation. If it is a date, the deadline is reached at
- the date and time specified. If it is a finite number, it is treated as
- a number of milliseconds since the Unix Epoch. If it is Infinity, the
- deadline will never be reached. If it is -Infinity, the deadline has already
- passed.</p>
- </div>
-
-
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">number</span>
- |
- <span class="param-type">Date</span>
- </li>
- </ul>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
- </dd>
-
-
- <hr>
- <dt>
- <h4 class="name" id="~deserialize"><span class="type-signature"></span>deserialize(data)</h4>
-
-
- </dt>
- <dd>
-
- <div class="description">
- <p>A deserialization function</p>
- </div>
-
-
-
-
-
- <h5>Parameters:</h5>
-
- <table class="params table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>data</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Buffer</span>
-
- </td>
-
-
- <td class="description last"><p>The byte sequence to deserialize</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
- <div class="param-desc">
- <p>The data deserialized as a value</p>
- </div>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">*</span>
- </dd>
- </dl>
-
-
- </dd>
-
-
- <hr>
- <dt class="name" id="~MethodDefinition">
- <h4 id="~MethodDefinition">MethodDefinition</h4>
-
- </dt>
- <dd>
-
- <div class="description">
- <p>An object that completely defines a service method signature.</p>
- </div>
-
-
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">Object</span>
- </li>
- </ul>
-
-
- <dl class="details">
-
- <h5 class="subsection-title">Properties:</h5>
- <dl>
- <table class="props table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>path</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last"><p>The method's URL path</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>requestStream</code></td>
-
- <td class="type">
-
-
- <span class="param-type">boolean</span>
-
- </td>
-
-
- <td class="description last"><p>Indicates whether the method accepts
- a stream of requests</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>responseStream</code></td>
-
- <td class="type">
-
-
- <span class="param-type">boolean</span>
-
- </td>
-
-
- <td class="description last"><p>Indicates whether the method returns
- a stream of responses</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>requestSerialize</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="grpc.html#~serialize">grpc~serialize</a></span>
-
- </td>
-
-
- <td class="description last"><p>Serialization
- function for request values</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>responseSerialize</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="grpc.html#~serialize">grpc~serialize</a></span>
-
- </td>
-
-
- <td class="description last"><p>Serialization
- function for response values</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>requestDeserialize</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="grpc.html#~deserialize">grpc~deserialize</a></span>
-
- </td>
-
-
- <td class="description last"><p>Deserialization
- function for request data</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>responseDeserialize</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="grpc.html#~deserialize">grpc~deserialize</a></span>
-
- </td>
-
-
- <td class="description last"><p>Deserialization
- function for repsonse data</p></td>
- </tr>
-
- </tbody>
- </table>
- </dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
- </dd>
-
-
- <hr>
- <dt>
- <h4 class="name" id="~serialize"><span class="type-signature"></span>serialize(value)</h4>
-
-
- </dt>
- <dd>
-
- <div class="description">
- <p>A serialization function</p>
- </div>
-
-
-
-
-
- <h5>Parameters:</h5>
-
- <table class="params table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>value</code></td>
-
- <td class="type">
-
-
- <span class="param-type">*</span>
-
- </td>
-
-
- <td class="description last"><p>The value to serialize</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
- <div class="param-desc">
- <p>The value serialized as a byte sequence</p>
- </div>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">Buffer</span>
- </dd>
- </dl>
-
-
- </dd>
-
-
- <hr>
- <dt class="name" id="~ServiceDefinition">
- <h4 id="~ServiceDefinition">ServiceDefinition</h4>
-
- </dt>
- <dd>
-
- <div class="description">
- <p>An object that completely defines a service.</p>
- </div>
-
-
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">Object.<string, <a href="grpc.html#~MethodDefinition">grpc~MethodDefinition</a>></span>
- </li>
- </ul>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
- </dd>
-
-
- <hr>
- <dt class="name" id="~ServiceError">
- <h4 id="~ServiceError">ServiceError</h4>
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Describes how a request has failed. The member <code>message</code> will be the same as
- <code>details</code> in <a href="grpc.html#~StatusObject">grpc~StatusObject</a>, and <code>code</code> and <code>metadata</code> are the
- same as in that object.</p>
- </div>
-
-
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">Error</span>
- </li>
- </ul>
-
-
- <dl class="details">
-
- <h5 class="subsection-title">Properties:</h5>
- <dl>
- <table class="props table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>code</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="description last"><p>The error code, a key of <a href="grpc.html#.status">grpc.status</a> that is
- not <code>grpc.status.OK</code></p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>metadata</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="grpc.Metadata.html">grpc.Metadata</a></span>
-
- </td>
-
-
- <td class="description last"><p>Trailing metadata sent with the status,
- if applicable</p></td>
- </tr>
-
- </tbody>
- </table>
- </dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
- </dd>
-
-
- <hr>
- <dt class="name" id="~StatusObject">
- <h4 id="~StatusObject">StatusObject</h4>
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Represents the status of a completed request. If <code>code</code> is
- <a href="grpc.html#.status">grpc.status</a>.OK, then the request has completed successfully.
- Otherwise, the request has failed, <code>details</code> will contain a description of
- the error. Either way, <code>metadata</code> contains the trailing response metadata
- sent by the server when it finishes processing the call.</p>
- </div>
-
-
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">object</span>
- </li>
- </ul>
-
-
- <dl class="details">
-
- <h5 class="subsection-title">Properties:</h5>
- <dl>
- <table class="props table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>code</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="description last"><p>The error code, a key of <a href="grpc.html#.status">grpc.status</a></p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>details</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last"><p>Human-readable description of the status</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>metadata</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="grpc.Metadata.html">grpc.Metadata</a></span>
-
- </td>
-
-
- <td class="description last"><p>Trailing metadata sent with the status,
- if applicable</p></td>
- </tr>
-
- </tbody>
- </table>
- </dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
- </dd>
- </dl>
-
-
- </article>
- </section>
- </div>
- </div>
- <div class="clearfix"></div>
-
- <div class="col-md-3">
- <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
- </div>
-
- </div>
- </div>
- <div class="modal fade" id="searchResults">
- <div class="modal-dialog">
- <div class="modal-content">
- <div class="modal-header">
- <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
- <h4 class="modal-title">Search results</h4>
- </div>
- <div class="modal-body"></div>
- <div class="modal-footer">
- <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
- </div>
- </div><!-- /.modal-content -->
- </div><!-- /.modal-dialog -->
- </div>
- <footer>
- <span class="jsdoc-message">
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
-
- on 2018-01-16T12:05:13-05:00
-
- using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
- </span>
- </footer>
- <script src="scripts/docstrap.lib.js"></script>
- <script src="scripts/toc.js"></script>
- <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
- <script>
- $( function () {
- $( "[id*='$']" ).each( function () {
- var $this = $( this );
- $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
- } );
- $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
- var $this = $( this );
- var example = $this.find( "code" );
- exampleText = example.html();
- var lang = /{@lang (.*?)}/.exec( exampleText );
- if ( lang && lang[1] ) {
- exampleText = exampleText.replace( lang[0], "" );
- example.html( exampleText );
- lang = lang[1];
- } else {
- var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
- lang = langClassMatch ? langClassMatch[1] : "javascript";
- }
- if ( lang ) {
- $this
- .addClass( "sunlight-highlight-" + lang )
- .addClass( "linenums" )
- .html( example.html() );
- }
- } );
- Sunlight.highlightAll( {
- lineNumbers : false,
- showMenu : true,
- enableDoclinks : true
- } );
- $.catchAnchorLinks( {
- navbarOffset: 10
- } );
- $( "#toc" ).toc( {
- anchorName : function ( i, heading, prefix ) {
- return $( heading ).attr( "id" ) || ( prefix + i );
- },
- selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
- showAndHide : false,
- smoothScrolling: true
- } );
- $( "#main span[id^='toc']" ).addClass( "toc-shim" );
- $( '.dropdown-toggle' ).dropdown();
- $( "table" ).each( function () {
- var $this = $( this );
- $this.addClass('table');
- } );
- } );
- </script>
- <!--Navigation and Symbol Display-->
- <!--Google Analytics-->
- <script type="text/javascript">
- $(document).ready(function() {
- SearcherDisplay.init();
- });
- </script>
- </body>
- </html>
|