grpc.html 82 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width">
  6. <title>Documentation Namespace: grpc</title>
  7. <!--[if lt IE 9]>
  8. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  9. <![endif]-->
  10. <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
  11. <link type="text/css" rel="stylesheet" href="styles/site.simplex.css">
  12. </head>
  13. <body>
  14. <div class="navbar navbar-default navbar-fixed-top ">
  15. <div class="container">
  16. <div class="navbar-header">
  17. <a class="navbar-brand" href="index.html">Documentation</a>
  18. <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
  19. <span class="icon-bar"></span>
  20. <span class="icon-bar"></span>
  21. <span class="icon-bar"></span>
  22. </button>
  23. </div>
  24. <div class="navbar-collapse collapse" id="topNavigation">
  25. <ul class="nav navbar-nav">
  26. <li class="dropdown">
  27. <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
  28. <ul class="dropdown-menu ">
  29. <li><a href="grpc.html">grpc</a></li><li><a href="grpc.credentials.html">grpc.credentials</a></li>
  30. </ul>
  31. </li>
  32. <li class="dropdown">
  33. <a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
  34. <ul class="dropdown-menu ">
  35. <li><a href="module-src_client_interceptors.html">src/client_interceptors</a></li>
  36. </ul>
  37. </li>
  38. <li class="dropdown">
  39. <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
  40. <ul class="dropdown-menu ">
  41. <li><a href="grpc.Channel.html">grpc.Channel</a></li><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-Call.html">grpc~Call</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><li><a href="module-src_client_interceptors-EndListener.html">src/client_interceptors~EndListener</a></li><li><a href="module-src_client_interceptors-InterceptingCall.html">src/client_interceptors~InterceptingCall</a></li><li><a href="module-src_client_interceptors-InterceptingListener.html">src/client_interceptors~InterceptingListener</a></li><li><a href="module-src_client_interceptors-InterceptorConfigurationError.html">src/client_interceptors~InterceptorConfigurationError</a></li><li><a href="module-src_client_interceptors-ListenerBuilder.html">src/client_interceptors~ListenerBuilder</a></li><li><a href="module-src_client_interceptors-RequesterBuilder.html">src/client_interceptors~RequesterBuilder</a></li><li><a href="module-src_client_interceptors-StatusBuilder.html">src/client_interceptors~StatusBuilder</a></li>
  42. </ul>
  43. </li>
  44. <li class="dropdown">
  45. <a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
  46. <ul class="dropdown-menu ">
  47. <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>
  48. </ul>
  49. </li>
  50. <li class="dropdown">
  51. <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
  52. <ul class="dropdown-menu ">
  53. <li><a href="global.html#CancelRequester">CancelRequester</a></li><li><a href="global.html#CloseRequester">CloseRequester</a></li><li><a href="global.html#createStatusError">createStatusError</a></li><li><a href="global.html#getClientInterceptors">getClientInterceptors</a></li><li><a href="global.html#getMethodType">getMethodType</a></li><li><a href="global.html#GetPeerRequester">GetPeerRequester</a></li><li><a href="global.html#Interceptor">Interceptor</a></li><li><a href="global.html#InterceptorProvider">InterceptorProvider</a></li><li><a href="global.html#loadPackageDefinition">loadPackageDefinition</a></li><li><a href="global.html#MessageListener">MessageListener</a></li><li><a href="global.html#MessageRequester">MessageRequester</a></li><li><a href="global.html#MetadataListener">MetadataListener</a></li><li><a href="global.html#MetadataRequester">MetadataRequester</a></li><li><a href="global.html#NextCall">NextCall</a></li><li><a href="global.html#StatusListener">StatusListener</a></li>
  54. </ul>
  55. </li>
  56. <li class="dropdown">
  57. <a href="externals.list.html" class="dropdown-toggle" data-toggle="dropdown">Externals<b class="caret"></b></a>
  58. <ul class="dropdown-menu ">
  59. <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>
  60. </ul>
  61. </li>
  62. </ul>
  63. <div class="col-sm-3 col-md-3">
  64. <form class="navbar-form" role="search">
  65. <div class="input-group">
  66. <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
  67. <div class="input-group-btn">
  68. <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
  69. </div>
  70. </div>
  71. </form>
  72. </div>
  73. </div>
  74. </div>
  75. </div>
  76. <div class="container" id="toc-content">
  77. <div class="row">
  78. <div class="col-md-8">
  79. <div id="main">
  80. <h1 class="page-title">Namespace: grpc</h1>
  81. <section>
  82. <header>
  83. <h2>
  84. grpc
  85. </h2>
  86. </header>
  87. <article>
  88. <div class="container-overview">
  89. <dl class="details">
  90. </dl>
  91. </div>
  92. <h3 class="subsection-title">Classes</h3>
  93. <dl>
  94. <dt><a href="grpc.Channel.html">Channel</a></dt>
  95. <dd></dd>
  96. <dt><a href="grpc.Client.html">Client</a></dt>
  97. <dd></dd>
  98. <dt><a href="grpc.Metadata.html">Metadata</a></dt>
  99. <dd></dd>
  100. <dt><a href="grpc.Server.html">Server</a></dt>
  101. <dd></dd>
  102. <dt><a href="grpc.ServerCredentials.html">ServerCredentials</a></dt>
  103. <dd></dd>
  104. <dt><a href="grpc-Call.html">Call</a></dt>
  105. <dd></dd>
  106. <dt><a href="grpc-ClientDuplexStream.html">ClientDuplexStream</a></dt>
  107. <dd></dd>
  108. <dt><a href="grpc-ClientReadableStream.html">ClientReadableStream</a></dt>
  109. <dd></dd>
  110. <dt><a href="grpc-ClientUnaryCall.html">ClientUnaryCall</a></dt>
  111. <dd></dd>
  112. <dt><a href="grpc-ClientWritableStream.html">ClientWritableStream</a></dt>
  113. <dd></dd>
  114. <dt><a href="grpc-ServerDuplexStream.html">ServerDuplexStream</a></dt>
  115. <dd></dd>
  116. <dt><a href="grpc-ServerReadableStream.html">ServerReadableStream</a></dt>
  117. <dd></dd>
  118. <dt><a href="grpc-ServerUnaryCall.html">ServerUnaryCall</a></dt>
  119. <dd></dd>
  120. <dt><a href="grpc-ServerWritableStream.html">ServerWritableStream</a></dt>
  121. <dd></dd>
  122. </dl>
  123. <h3 class="subsection-title">Namespaces</h3>
  124. <dl>
  125. <dt><a href="namespaces.html#grpc.credentials"><a href="grpc.credentials.html">credentials</a></a></dt>
  126. <dd></dd>
  127. </dl>
  128. <h3 class="subsection-title">Members</h3>
  129. <dl>
  130. <hr>
  131. <dt class="name" id=".callError">
  132. <h4 id=".callError"><span class="type-signature">&lt;static, constant> </span>callError<span class="type-signature"> :number</span></h4>
  133. </dt>
  134. <dd>
  135. <div class="description">
  136. <p>Call error constants. Call errors almost always indicate bugs in the gRPC
  137. library, and these error codes are mainly useful for finding those bugs.</p>
  138. </div>
  139. <h5>Type:</h5>
  140. <ul>
  141. <li>
  142. <span class="param-type">number</span>
  143. </li>
  144. </ul>
  145. <dl class="details">
  146. <h5 class="subsection-title">Properties:</h5>
  147. <dl>
  148. <table class="props table table-striped">
  149. <thead>
  150. <tr>
  151. <th>Name</th>
  152. <th>Type</th>
  153. <th>Default</th>
  154. <th class="last">Description</th>
  155. </tr>
  156. </thead>
  157. <tbody>
  158. <tr>
  159. <td class="name"><code>OK</code></td>
  160. <td class="type">
  161. <span class="param-type">number</span>
  162. </td>
  163. <td class="default">
  164. 0
  165. </td>
  166. <td class="description last"></td>
  167. </tr>
  168. <tr>
  169. <td class="name"><code>ERROR</code></td>
  170. <td class="type">
  171. <span class="param-type">number</span>
  172. </td>
  173. <td class="default">
  174. 1
  175. </td>
  176. <td class="description last"></td>
  177. </tr>
  178. <tr>
  179. <td class="name"><code>NOT_ON_SERVER</code></td>
  180. <td class="type">
  181. <span class="param-type">number</span>
  182. </td>
  183. <td class="default">
  184. 2
  185. </td>
  186. <td class="description last"></td>
  187. </tr>
  188. <tr>
  189. <td class="name"><code>NOT_ON_CLIENT</code></td>
  190. <td class="type">
  191. <span class="param-type">number</span>
  192. </td>
  193. <td class="default">
  194. 3
  195. </td>
  196. <td class="description last"></td>
  197. </tr>
  198. <tr>
  199. <td class="name"><code>ALREADY_INVOKED</code></td>
  200. <td class="type">
  201. <span class="param-type">number</span>
  202. </td>
  203. <td class="default">
  204. 5
  205. </td>
  206. <td class="description last"></td>
  207. </tr>
  208. <tr>
  209. <td class="name"><code>NOT_INVOKED</code></td>
  210. <td class="type">
  211. <span class="param-type">number</span>
  212. </td>
  213. <td class="default">
  214. 6
  215. </td>
  216. <td class="description last"></td>
  217. </tr>
  218. <tr>
  219. <td class="name"><code>ALREADY_FINISHED</code></td>
  220. <td class="type">
  221. <span class="param-type">number</span>
  222. </td>
  223. <td class="default">
  224. 7
  225. </td>
  226. <td class="description last"></td>
  227. </tr>
  228. <tr>
  229. <td class="name"><code>TOO_MANY_OPERATIONS</code></td>
  230. <td class="type">
  231. <span class="param-type">number</span>
  232. </td>
  233. <td class="default">
  234. 8
  235. </td>
  236. <td class="description last"></td>
  237. </tr>
  238. <tr>
  239. <td class="name"><code>INVALID_FLAGS</code></td>
  240. <td class="type">
  241. <span class="param-type">number</span>
  242. </td>
  243. <td class="default">
  244. 9
  245. </td>
  246. <td class="description last"></td>
  247. </tr>
  248. <tr>
  249. <td class="name"><code>INVALID_METADATA</code></td>
  250. <td class="type">
  251. <span class="param-type">number</span>
  252. </td>
  253. <td class="default">
  254. 10
  255. </td>
  256. <td class="description last"></td>
  257. </tr>
  258. <tr>
  259. <td class="name"><code>INVALID_MESSAGE</code></td>
  260. <td class="type">
  261. <span class="param-type">number</span>
  262. </td>
  263. <td class="default">
  264. 11
  265. </td>
  266. <td class="description last"></td>
  267. </tr>
  268. <tr>
  269. <td class="name"><code>NOT_SERVER_COMPLETION_QUEUE</code></td>
  270. <td class="type">
  271. <span class="param-type">number</span>
  272. </td>
  273. <td class="default">
  274. 12
  275. </td>
  276. <td class="description last"></td>
  277. </tr>
  278. <tr>
  279. <td class="name"><code>BATCH_TOO_BIG</code></td>
  280. <td class="type">
  281. <span class="param-type">number</span>
  282. </td>
  283. <td class="default">
  284. 13
  285. </td>
  286. <td class="description last"></td>
  287. </tr>
  288. <tr>
  289. <td class="name"><code>PAYLOAD_TYPE_MISMATCH</code></td>
  290. <td class="type">
  291. <span class="param-type">number</span>
  292. </td>
  293. <td class="default">
  294. 14
  295. </td>
  296. <td class="description last"></td>
  297. </tr>
  298. </tbody>
  299. </table>
  300. </dl>
  301. </dl>
  302. </dd>
  303. <hr>
  304. <dt class="name" id=".connectivityState">
  305. <h4 id=".connectivityState"><span class="type-signature">&lt;static, readonly> </span>connectivityState<span class="type-signature"> :number</span></h4>
  306. </dt>
  307. <dd>
  308. <div class="description">
  309. <p>Connectivity state values</p>
  310. </div>
  311. <h5>Type:</h5>
  312. <ul>
  313. <li>
  314. <span class="param-type">number</span>
  315. </li>
  316. </ul>
  317. <dl class="details">
  318. <h5 class="subsection-title">Properties:</h5>
  319. <dl>
  320. <table class="props table table-striped">
  321. <thead>
  322. <tr>
  323. <th>Name</th>
  324. <th>Type</th>
  325. <th>Default</th>
  326. <th class="last">Description</th>
  327. </tr>
  328. </thead>
  329. <tbody>
  330. <tr>
  331. <td class="name"><code>IDLE</code></td>
  332. <td class="type">
  333. <span class="param-type">number</span>
  334. </td>
  335. <td class="default">
  336. 0
  337. </td>
  338. <td class="description last"></td>
  339. </tr>
  340. <tr>
  341. <td class="name"><code>CONNECTING</code></td>
  342. <td class="type">
  343. <span class="param-type">number</span>
  344. </td>
  345. <td class="default">
  346. 1
  347. </td>
  348. <td class="description last"></td>
  349. </tr>
  350. <tr>
  351. <td class="name"><code>READY</code></td>
  352. <td class="type">
  353. <span class="param-type">number</span>
  354. </td>
  355. <td class="default">
  356. 2
  357. </td>
  358. <td class="description last"></td>
  359. </tr>
  360. <tr>
  361. <td class="name"><code>TRANSIENT_FAILURE</code></td>
  362. <td class="type">
  363. <span class="param-type">number</span>
  364. </td>
  365. <td class="default">
  366. 3
  367. </td>
  368. <td class="description last"></td>
  369. </tr>
  370. <tr>
  371. <td class="name"><code>SHUTDOWN</code></td>
  372. <td class="type">
  373. <span class="param-type">number</span>
  374. </td>
  375. <td class="default">
  376. 4
  377. </td>
  378. <td class="description last"></td>
  379. </tr>
  380. </tbody>
  381. </table>
  382. </dl>
  383. </dl>
  384. </dd>
  385. <hr>
  386. <dt class="name" id=".load">
  387. <h4 id=".load"><span class="type-signature">&lt;static> </span>load<span class="type-signature"></span></h4>
  388. </dt>
  389. <dd>
  390. <div class="description">
  391. <p>Load a gRPC object from a .proto file.</p>
  392. </div>
  393. <dl class="details">
  394. <dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
  395. <dd>
  396. <ul class="dummy">
  397. <li>Use the <a href="https://www.npmjs.com/package/@grpc/proto-loader">proto-loader module</a>
  398. with grpc.loadPackageDefinition instead.</li>
  399. </ul>
  400. </dd>
  401. </dl>
  402. </dd>
  403. <hr>
  404. <dt class="name" id=".logVerbosity">
  405. <h4 id=".logVerbosity"><span class="type-signature">&lt;static, readonly> </span>logVerbosity<span class="type-signature"> :number</span></h4>
  406. </dt>
  407. <dd>
  408. <h5>Type:</h5>
  409. <ul>
  410. <li>
  411. <span class="param-type">number</span>
  412. </li>
  413. </ul>
  414. <dl class="details">
  415. <h5 class="subsection-title">Properties:</h5>
  416. <dl>
  417. <table class="props table table-striped">
  418. <thead>
  419. <tr>
  420. <th>Name</th>
  421. <th>Type</th>
  422. <th>Default</th>
  423. <th class="last">Description</th>
  424. </tr>
  425. </thead>
  426. <tbody>
  427. <tr>
  428. <td class="name"><code>DEBUG</code></td>
  429. <td class="type">
  430. <span class="param-type">number</span>
  431. </td>
  432. <td class="default">
  433. 0
  434. </td>
  435. <td class="description last"></td>
  436. </tr>
  437. <tr>
  438. <td class="name"><code>INFO</code></td>
  439. <td class="type">
  440. <span class="param-type">number</span>
  441. </td>
  442. <td class="default">
  443. 1
  444. </td>
  445. <td class="description last"></td>
  446. </tr>
  447. <tr>
  448. <td class="name"><code>ERROR</code></td>
  449. <td class="type">
  450. <span class="param-type">number</span>
  451. </td>
  452. <td class="default">
  453. 2
  454. </td>
  455. <td class="description last"></td>
  456. </tr>
  457. </tbody>
  458. </table>
  459. </dl>
  460. </dl>
  461. </dd>
  462. <hr>
  463. <dt class="name" id=".methodTypes">
  464. <h4 id=".methodTypes"><span class="type-signature">&lt;static, readonly> </span>methodTypes<span class="type-signature"> :number</span></h4>
  465. </dt>
  466. <dd>
  467. <div class="description">
  468. <p>Method types: the supported RPC types</p>
  469. </div>
  470. <h5>Type:</h5>
  471. <ul>
  472. <li>
  473. <span class="param-type">number</span>
  474. </li>
  475. </ul>
  476. <dl class="details">
  477. <h5 class="subsection-title">Properties:</h5>
  478. <dl>
  479. <table class="props table table-striped">
  480. <thead>
  481. <tr>
  482. <th>Name</th>
  483. <th>Type</th>
  484. <th>Default</th>
  485. <th class="last">Description</th>
  486. </tr>
  487. </thead>
  488. <tbody>
  489. <tr>
  490. <td class="name"><code>UNARY</code></td>
  491. <td class="type">
  492. <span class="param-type">number</span>
  493. </td>
  494. <td class="default">
  495. 0
  496. </td>
  497. <td class="description last"></td>
  498. </tr>
  499. <tr>
  500. <td class="name"><code>CLIENT_STREAMING</code></td>
  501. <td class="type">
  502. <span class="param-type">number</span>
  503. </td>
  504. <td class="default">
  505. 1
  506. </td>
  507. <td class="description last"></td>
  508. </tr>
  509. <tr>
  510. <td class="name"><code>SERVER_STREAMING</code></td>
  511. <td class="type">
  512. <span class="param-type">number</span>
  513. </td>
  514. <td class="default">
  515. 2
  516. </td>
  517. <td class="description last"></td>
  518. </tr>
  519. <tr>
  520. <td class="name"><code>BIDI_STREAMING</code></td>
  521. <td class="type">
  522. <span class="param-type">number</span>
  523. </td>
  524. <td class="default">
  525. 3
  526. </td>
  527. <td class="description last"></td>
  528. </tr>
  529. </tbody>
  530. </table>
  531. </dl>
  532. </dl>
  533. </dd>
  534. <hr>
  535. <dt class="name" id=".propagate">
  536. <h4 id=".propagate"><span class="type-signature">&lt;static> </span>propagate<span class="type-signature"> :number</span></h4>
  537. </dt>
  538. <dd>
  539. <div class="description">
  540. <p>Propagation flags: these can be bitwise or-ed to form the propagation option
  541. for calls.</p>
  542. <p>Users are encouraged to write propagation masks as deltas from the default.
  543. i.e. write <code>grpc.propagate.DEFAULTS &amp; ~grpc.propagate.DEADLINE</code> to disable
  544. deadline propagation.</p>
  545. </div>
  546. <h5>Type:</h5>
  547. <ul>
  548. <li>
  549. <span class="param-type">number</span>
  550. </li>
  551. </ul>
  552. <dl class="details">
  553. <h5 class="subsection-title">Properties:</h5>
  554. <dl>
  555. <table class="props table table-striped">
  556. <thead>
  557. <tr>
  558. <th>Name</th>
  559. <th>Type</th>
  560. <th>Default</th>
  561. <th class="last">Description</th>
  562. </tr>
  563. </thead>
  564. <tbody>
  565. <tr>
  566. <td class="name"><code>DEADLINE</code></td>
  567. <td class="type">
  568. <span class="param-type">number</span>
  569. </td>
  570. <td class="default">
  571. 1
  572. </td>
  573. <td class="description last"></td>
  574. </tr>
  575. <tr>
  576. <td class="name"><code>CENSUS_STATS_CONTEXT</code></td>
  577. <td class="type">
  578. <span class="param-type">number</span>
  579. </td>
  580. <td class="default">
  581. 2
  582. </td>
  583. <td class="description last"></td>
  584. </tr>
  585. <tr>
  586. <td class="name"><code>CENSUS_TRACING_CONTEXT</code></td>
  587. <td class="type">
  588. <span class="param-type">number</span>
  589. </td>
  590. <td class="default">
  591. 4
  592. </td>
  593. <td class="description last"></td>
  594. </tr>
  595. <tr>
  596. <td class="name"><code>CANCELLATION</code></td>
  597. <td class="type">
  598. <span class="param-type">number</span>
  599. </td>
  600. <td class="default">
  601. 8
  602. </td>
  603. <td class="description last"></td>
  604. </tr>
  605. <tr>
  606. <td class="name"><code>DEFAULTS</code></td>
  607. <td class="type">
  608. <span class="param-type">number</span>
  609. </td>
  610. <td class="default">
  611. 65535
  612. </td>
  613. <td class="description last"></td>
  614. </tr>
  615. </tbody>
  616. </table>
  617. </dl>
  618. </dl>
  619. </dd>
  620. <hr>
  621. <dt class="name" id=".status">
  622. <h4 id=".status"><span class="type-signature">&lt;static, readonly> </span>status<span class="type-signature"> :number</span></h4>
  623. </dt>
  624. <dd>
  625. <div class="description">
  626. <p>Enum of status codes that gRPC can return</p>
  627. </div>
  628. <h5>Type:</h5>
  629. <ul>
  630. <li>
  631. <span class="param-type">number</span>
  632. </li>
  633. </ul>
  634. <dl class="details">
  635. <h5 class="subsection-title">Properties:</h5>
  636. <dl>
  637. <table class="props table table-striped">
  638. <thead>
  639. <tr>
  640. <th>Name</th>
  641. <th>Type</th>
  642. <th>Default</th>
  643. <th class="last">Description</th>
  644. </tr>
  645. </thead>
  646. <tbody>
  647. <tr>
  648. <td class="name"><code>OK</code></td>
  649. <td class="type">
  650. <span class="param-type">number</span>
  651. </td>
  652. <td class="default">
  653. 0
  654. </td>
  655. <td class="description last"><p>Not an error; returned on success</p></td>
  656. </tr>
  657. <tr>
  658. <td class="name"><code>CANCELLED</code></td>
  659. <td class="type">
  660. <span class="param-type">number</span>
  661. </td>
  662. <td class="default">
  663. 1
  664. </td>
  665. <td class="description last"><p>The operation was cancelled (typically by the caller).</p></td>
  666. </tr>
  667. <tr>
  668. <td class="name"><code>UNKNOWN</code></td>
  669. <td class="type">
  670. <span class="param-type">number</span>
  671. </td>
  672. <td class="default">
  673. 2
  674. </td>
  675. <td class="description last"><p>Unknown error. An example of where this error may be returned is
  676. if a status value received from another address space belongs to
  677. an error-space that is not known in this address space. Also
  678. errors raised by APIs that do not return enough error information
  679. may be converted to this error.</p></td>
  680. </tr>
  681. <tr>
  682. <td class="name"><code>INVALID_ARGUMENT</code></td>
  683. <td class="type">
  684. <span class="param-type">number</span>
  685. </td>
  686. <td class="default">
  687. 3
  688. </td>
  689. <td class="description last"><p>Client specified an invalid argument. Note that this differs
  690. from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments
  691. that are problematic regardless of the state of the system
  692. (e.g., a malformed file name).</p></td>
  693. </tr>
  694. <tr>
  695. <td class="name"><code>DEADLINE_EXCEEDED</code></td>
  696. <td class="type">
  697. <span class="param-type">number</span>
  698. </td>
  699. <td class="default">
  700. 4
  701. </td>
  702. <td class="description last"><p>Deadline expired before operation could complete. For operations
  703. that change the state of the system, this error may be returned
  704. even if the operation has completed successfully. For example, a
  705. successful response from a server could have been delayed long
  706. enough for the deadline to expire.</p></td>
  707. </tr>
  708. <tr>
  709. <td class="name"><code>NOT_FOUND</code></td>
  710. <td class="type">
  711. <span class="param-type">number</span>
  712. </td>
  713. <td class="default">
  714. 5
  715. </td>
  716. <td class="description last"><p>Some requested entity (e.g., file or directory) was not found.</p></td>
  717. </tr>
  718. <tr>
  719. <td class="name"><code>ALREADY_EXISTS</code></td>
  720. <td class="type">
  721. <span class="param-type">number</span>
  722. </td>
  723. <td class="default">
  724. 6
  725. </td>
  726. <td class="description last"><p>Some entity that we attempted to create (e.g., file or directory)
  727. already exists.</p></td>
  728. </tr>
  729. <tr>
  730. <td class="name"><code>PERMISSION_DENIED</code></td>
  731. <td class="type">
  732. <span class="param-type">number</span>
  733. </td>
  734. <td class="default">
  735. 7
  736. </td>
  737. <td class="description last"><p>The caller does not have permission to execute the specified
  738. operation. PERMISSION_DENIED must not be used for rejections
  739. caused by exhausting some resource (use RESOURCE_EXHAUSTED
  740. instead for those errors). PERMISSION_DENIED must not be
  741. used if the caller can not be identified (use UNAUTHENTICATED
  742. instead for those errors).</p></td>
  743. </tr>
  744. <tr>
  745. <td class="name"><code>RESOURCE_EXHAUSTED</code></td>
  746. <td class="type">
  747. <span class="param-type">number</span>
  748. </td>
  749. <td class="default">
  750. 8
  751. </td>
  752. <td class="description last"><p>Some resource has been exhausted, perhaps a per-user quota, or
  753. perhaps the entire file system is out of space.</p></td>
  754. </tr>
  755. <tr>
  756. <td class="name"><code>FAILED_PRECONDITION</code></td>
  757. <td class="type">
  758. <span class="param-type">number</span>
  759. </td>
  760. <td class="default">
  761. 9
  762. </td>
  763. <td class="description last"><p>Operation was rejected because the system is not in a state
  764. required for the operation's execution. For example, directory
  765. to be deleted may be non-empty, an rmdir operation is applied to
  766. a non-directory, etc.</p>
  767. <p>A litmus test that may help a service implementor in deciding
  768. between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE:</p>
  769. <ul>
  770. <li>Use UNAVAILABLE if the client can retry just the failing call.</li>
  771. <li>Use ABORTED if the client should retry at a higher-level
  772. (e.g., restarting a read-modify-write sequence).</li>
  773. <li>Use FAILED_PRECONDITION if the client should not retry until
  774. the system state has been explicitly fixed. E.g., if an &quot;rmdir&quot;
  775. fails because the directory is non-empty, FAILED_PRECONDITION
  776. should be returned since the client should not retry unless
  777. they have first fixed up the directory by deleting files from it.</li>
  778. <li>Use FAILED_PRECONDITION if the client performs conditional
  779. REST Get/Update/Delete on a resource and the resource on the
  780. server does not match the condition. E.g., conflicting
  781. read-modify-write on the same resource.</li>
  782. </ul></td>
  783. </tr>
  784. <tr>
  785. <td class="name"><code>ABORTED</code></td>
  786. <td class="type">
  787. <span class="param-type">number</span>
  788. </td>
  789. <td class="default">
  790. 10
  791. </td>
  792. <td class="description last"><p>The operation was aborted, typically due to a concurrency issue
  793. like sequencer check failures, transaction aborts, etc.</p>
  794. <p>See litmus test above for deciding between FAILED_PRECONDITION,
  795. ABORTED, and UNAVAILABLE.</p></td>
  796. </tr>
  797. <tr>
  798. <td class="name"><code>OUT_OF_RANGE</code></td>
  799. <td class="type">
  800. <span class="param-type">number</span>
  801. </td>
  802. <td class="default">
  803. 11
  804. </td>
  805. <td class="description last"><p>Operation was attempted past the valid range. E.g., seeking or
  806. reading past end of file.</p>
  807. <p>Unlike INVALID_ARGUMENT, this error indicates a problem that may
  808. be fixed if the system state changes. For example, a 32-bit file
  809. system will generate INVALID_ARGUMENT if asked to read at an
  810. offset that is not in the range [0,2^32-1], but it will generate
  811. OUT_OF_RANGE if asked to read from an offset past the current
  812. file size.</p>
  813. <p>There is a fair bit of overlap between FAILED_PRECONDITION and
  814. OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific
  815. error) when it applies so that callers who are iterating through
  816. a space can easily look for an OUT_OF_RANGE error to detect when
  817. they are done.</p></td>
  818. </tr>
  819. <tr>
  820. <td class="name"><code>UNIMPLEMENTED</code></td>
  821. <td class="type">
  822. <span class="param-type">number</span>
  823. </td>
  824. <td class="default">
  825. 12
  826. </td>
  827. <td class="description last"><p>Operation is not implemented or not supported/enabled in this service.</p></td>
  828. </tr>
  829. <tr>
  830. <td class="name"><code>INTERNAL</code></td>
  831. <td class="type">
  832. <span class="param-type">number</span>
  833. </td>
  834. <td class="default">
  835. 13
  836. </td>
  837. <td class="description last"><p>Internal errors. Means some invariants expected by underlying
  838. system has been broken. If you see one of these errors,
  839. something is very broken.</p></td>
  840. </tr>
  841. <tr>
  842. <td class="name"><code>UNAVAILABLE</code></td>
  843. <td class="type">
  844. <span class="param-type">number</span>
  845. </td>
  846. <td class="default">
  847. 14
  848. </td>
  849. <td class="description last"><p>The service is currently unavailable. This is a most likely a
  850. transient condition and may be corrected by retrying with
  851. a backoff.</p>
  852. <p>See litmus test above for deciding between FAILED_PRECONDITION,
  853. ABORTED, and UNAVAILABLE.</p></td>
  854. </tr>
  855. <tr>
  856. <td class="name"><code>DATA_LOSS</code></td>
  857. <td class="type">
  858. <span class="param-type">number</span>
  859. </td>
  860. <td class="default">
  861. 15
  862. </td>
  863. <td class="description last"><p>Unrecoverable data loss or corruption.</p></td>
  864. </tr>
  865. <tr>
  866. <td class="name"><code>UNAUTHENTICATED</code></td>
  867. <td class="type">
  868. <span class="param-type">number</span>
  869. </td>
  870. <td class="default">
  871. 16
  872. </td>
  873. <td class="description last"><p>The request does not have valid authentication credentials for the
  874. operation.</p></td>
  875. </tr>
  876. </tbody>
  877. </table>
  878. </dl>
  879. </dl>
  880. </dd>
  881. <hr>
  882. <dt class="name" id=".writeFlags">
  883. <h4 id=".writeFlags"><span class="type-signature">&lt;static, readonly> </span>writeFlags<span class="type-signature"> :number</span></h4>
  884. </dt>
  885. <dd>
  886. <div class="description">
  887. <p>Write flags: these can be bitwise or-ed to form write options that modify
  888. how data is written.</p>
  889. </div>
  890. <h5>Type:</h5>
  891. <ul>
  892. <li>
  893. <span class="param-type">number</span>
  894. </li>
  895. </ul>
  896. <dl class="details">
  897. <h5 class="subsection-title">Properties:</h5>
  898. <dl>
  899. <table class="props table table-striped">
  900. <thead>
  901. <tr>
  902. <th>Name</th>
  903. <th>Type</th>
  904. <th>Default</th>
  905. <th class="last">Description</th>
  906. </tr>
  907. </thead>
  908. <tbody>
  909. <tr>
  910. <td class="name"><code>BUFFER_HINT</code></td>
  911. <td class="type">
  912. <span class="param-type">number</span>
  913. </td>
  914. <td class="default">
  915. 1
  916. </td>
  917. <td class="description last"><p>Hint that the write may be buffered and need not go out on the wire
  918. immediately. GRPC is free to buffer the message until the next non-buffered
  919. write, or until writes_done, but it need not buffer completely or at all.</p></td>
  920. </tr>
  921. <tr>
  922. <td class="name"><code>NO_COMPRESS</code></td>
  923. <td class="type">
  924. <span class="param-type">number</span>
  925. </td>
  926. <td class="default">
  927. 2
  928. </td>
  929. <td class="description last"><p>Force compression to be disabled for a particular write</p></td>
  930. </tr>
  931. </tbody>
  932. </table>
  933. </dl>
  934. </dl>
  935. </dd>
  936. <hr>
  937. <dt class="name" id="~defaultLoadOptions">
  938. <h4 id="~defaultLoadOptions"><span class="type-signature">&lt;inner> </span>defaultLoadOptions<span class="type-signature"></span></h4>
  939. </dt>
  940. <dd>
  941. <div class="description">
  942. <p>Default options for loading proto files into gRPC</p>
  943. </div>
  944. <dl class="details">
  945. </dl>
  946. </dd>
  947. </dl>
  948. <h3 class="subsection-title">Methods</h3>
  949. <dl>
  950. <hr>
  951. <dt>
  952. <h4 class="name" id=".closeClient"><span class="type-signature">&lt;static> </span>closeClient(client_obj)</h4>
  953. </dt>
  954. <dd>
  955. <h5>Parameters:</h5>
  956. <table class="params table table-striped">
  957. <thead>
  958. <tr>
  959. <th>Name</th>
  960. <th>Type</th>
  961. <th class="last">Description</th>
  962. </tr>
  963. </thead>
  964. <tbody>
  965. <tr>
  966. <td class="name"><code>client_obj</code></td>
  967. <td class="type">
  968. <span class="param-type"><a href="grpc.Client.html">grpc.Client</a></span>
  969. </td>
  970. <td class="description last"><p>The client to close</p></td>
  971. </tr>
  972. </tbody>
  973. </table>
  974. <dl class="details">
  975. </dl>
  976. </dd>
  977. <hr>
  978. <dt>
  979. <h4 class="name" id=".loadObject"><span class="type-signature">&lt;static> </span>loadObject(value [, options])</h4>
  980. </dt>
  981. <dd>
  982. <div class="description">
  983. <p>Load a ProtoBuf.js object as a gRPC object.</p>
  984. </div>
  985. <h5>Parameters:</h5>
  986. <table class="params table table-striped">
  987. <thead>
  988. <tr>
  989. <th>Name</th>
  990. <th>Type</th>
  991. <th>Argument</th>
  992. <th class="last">Description</th>
  993. </tr>
  994. </thead>
  995. <tbody>
  996. <tr>
  997. <td class="name"><code>value</code></td>
  998. <td class="type">
  999. <span class="param-type">Object</span>
  1000. </td>
  1001. <td class="attributes">
  1002. </td>
  1003. <td class="description last"><p>The ProtoBuf.js reflection object to load</p></td>
  1004. </tr>
  1005. <tr>
  1006. <td class="name"><code>options</code></td>
  1007. <td class="type">
  1008. <span class="param-type">Object</span>
  1009. </td>
  1010. <td class="attributes">
  1011. &lt;optional><br>
  1012. </td>
  1013. <td class="description last"><p>Options to apply to the loaded file</p>
  1014. <h6 class="method-params-label method-subparams-label">Properties</h6>
  1015. <table class="params table table-striped">
  1016. <thead>
  1017. <tr>
  1018. <th>Name</th>
  1019. <th>Type</th>
  1020. <th>Argument</th>
  1021. <th>Default</th>
  1022. <th class="last">Description</th>
  1023. </tr>
  1024. </thead>
  1025. <tbody>
  1026. <tr>
  1027. <td class="name"><code>binaryAsBase64</code></td>
  1028. <td class="type">
  1029. <span class="param-type">bool</span>
  1030. </td>
  1031. <td class="attributes">
  1032. &lt;optional><br>
  1033. </td>
  1034. <td class="default">
  1035. false
  1036. </td>
  1037. <td class="description last"><p>deserialize bytes values as
  1038. base64 strings instead of Buffers</p></td>
  1039. </tr>
  1040. <tr>
  1041. <td class="name"><code>longsAsStrings</code></td>
  1042. <td class="type">
  1043. <span class="param-type">bool</span>
  1044. </td>
  1045. <td class="attributes">
  1046. &lt;optional><br>
  1047. </td>
  1048. <td class="default">
  1049. true
  1050. </td>
  1051. <td class="description last"><p>deserialize long values as
  1052. strings instead of objects</p></td>
  1053. </tr>
  1054. <tr>
  1055. <td class="name"><code>enumsAsStrings</code></td>
  1056. <td class="type">
  1057. <span class="param-type">bool</span>
  1058. </td>
  1059. <td class="attributes">
  1060. &lt;optional><br>
  1061. </td>
  1062. <td class="default">
  1063. true
  1064. </td>
  1065. <td class="description last"><p>deserialize enum values as
  1066. strings instead of numbers. Only works with Protobuf.js 6 values.</p></td>
  1067. </tr>
  1068. <tr>
  1069. <td class="name"><code>deprecatedArgumentOrder</code></td>
  1070. <td class="type">
  1071. <span class="param-type">bool</span>
  1072. </td>
  1073. <td class="attributes">
  1074. &lt;optional><br>
  1075. </td>
  1076. <td class="default">
  1077. false
  1078. </td>
  1079. <td class="description last"><p>use the beta method
  1080. argument order for client methods, with optional arguments after the
  1081. callback. This option is only a temporary stopgap measure to smooth an
  1082. API breakage. It is deprecated, and new code should not use it.</p></td>
  1083. </tr>
  1084. <tr>
  1085. <td class="name"><code>protobufjsVersion</code></td>
  1086. <td class="type">
  1087. <span class="param-type">number</span>
  1088. |
  1089. <span class="param-type">string</span>
  1090. </td>
  1091. <td class="attributes">
  1092. &lt;optional><br>
  1093. </td>
  1094. <td class="default">
  1095. 'detect'
  1096. </td>
  1097. <td class="description last"><p>5 and 6
  1098. respectively indicate that an object from the corresponding version of
  1099. Protobuf.js is provided in the value argument. If the option is 'detect',
  1100. gRPC will guess what the version is based on the structure of the value.</p></td>
  1101. </tr>
  1102. </tbody>
  1103. </table>
  1104. </td>
  1105. </tr>
  1106. </tbody>
  1107. </table>
  1108. <dl class="details">
  1109. </dl>
  1110. <h5>Returns:</h5>
  1111. <div class="param-desc">
  1112. <p>The resulting gRPC object.</p>
  1113. </div>
  1114. <dl>
  1115. <dt>
  1116. Type
  1117. </dt>
  1118. <dd>
  1119. <span class="param-type">Object.&lt;string, *></span>
  1120. </dd>
  1121. </dl>
  1122. </dd>
  1123. <hr>
  1124. <dt>
  1125. <h4 class="name" id=".setLogger"><span class="type-signature">&lt;static> </span>setLogger(logger)</h4>
  1126. </dt>
  1127. <dd>
  1128. <div class="description">
  1129. <p>Sets the logger function for the gRPC module. For debugging purposes, the C
  1130. core will log synchronously directly to stdout unless this function is
  1131. called. Note: the output format here is intended to be informational, and
  1132. is not guaranteed to stay the same in the future.
  1133. Logs will be directed to logger.error.</p>
  1134. </div>
  1135. <h5>Parameters:</h5>
  1136. <table class="params table table-striped">
  1137. <thead>
  1138. <tr>
  1139. <th>Name</th>
  1140. <th>Type</th>
  1141. <th class="last">Description</th>
  1142. </tr>
  1143. </thead>
  1144. <tbody>
  1145. <tr>
  1146. <td class="name"><code>logger</code></td>
  1147. <td class="type">
  1148. <span class="param-type">Console</span>
  1149. </td>
  1150. <td class="description last"><p>A Console-like object.</p></td>
  1151. </tr>
  1152. </tbody>
  1153. </table>
  1154. <dl class="details">
  1155. </dl>
  1156. </dd>
  1157. <hr>
  1158. <dt>
  1159. <h4 class="name" id=".setLogVerbosity"><span class="type-signature">&lt;static> </span>setLogVerbosity(verbosity)</h4>
  1160. </dt>
  1161. <dd>
  1162. <div class="description">
  1163. <p>Sets the logger verbosity for gRPC module logging. The options are members
  1164. of the grpc.logVerbosity map.</p>
  1165. </div>
  1166. <h5>Parameters:</h5>
  1167. <table class="params table table-striped">
  1168. <thead>
  1169. <tr>
  1170. <th>Name</th>
  1171. <th>Type</th>
  1172. <th class="last">Description</th>
  1173. </tr>
  1174. </thead>
  1175. <tbody>
  1176. <tr>
  1177. <td class="name"><code>verbosity</code></td>
  1178. <td class="type">
  1179. <span class="param-type">Number</span>
  1180. </td>
  1181. <td class="description last"><p>The minimum severity to log</p></td>
  1182. </tr>
  1183. </tbody>
  1184. </table>
  1185. <dl class="details">
  1186. </dl>
  1187. </dd>
  1188. <hr>
  1189. <dt>
  1190. <h4 class="name" id="~getClientChannel"><span class="type-signature">&lt;inner> </span>getClientChannel(client)</h4>
  1191. </dt>
  1192. <dd>
  1193. <div class="description">
  1194. <p>Return the underlying channel object for the specified client</p>
  1195. </div>
  1196. <h5>Parameters:</h5>
  1197. <table class="params table table-striped">
  1198. <thead>
  1199. <tr>
  1200. <th>Name</th>
  1201. <th>Type</th>
  1202. <th class="last">Description</th>
  1203. </tr>
  1204. </thead>
  1205. <tbody>
  1206. <tr>
  1207. <td class="name"><code>client</code></td>
  1208. <td class="type">
  1209. <span class="param-type"><a href="grpc.Client.html">grpc.Client</a></span>
  1210. </td>
  1211. <td class="description last"><p>The client</p></td>
  1212. </tr>
  1213. </tbody>
  1214. </table>
  1215. <dl class="details">
  1216. <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
  1217. <dd class="tag-see">
  1218. <ul>
  1219. <li><a href="grpc.Client.html#getChannel">grpc.Client#getChannel</a></li>
  1220. </ul>
  1221. </dd>
  1222. </dl>
  1223. <h5>Returns:</h5>
  1224. <div class="param-desc">
  1225. <p>The channel</p>
  1226. </div>
  1227. <dl>
  1228. <dt>
  1229. Type
  1230. </dt>
  1231. <dd>
  1232. <span class="param-type">Channel</span>
  1233. </dd>
  1234. </dl>
  1235. </dd>
  1236. <hr>
  1237. <dt>
  1238. <h4 class="name" id="~makeGenericClientConstructor"><span class="type-signature">&lt;inner> </span>makeGenericClientConstructor(methods, serviceName, class_options)</h4>
  1239. </dt>
  1240. <dd>
  1241. <div class="description">
  1242. <p>Creates a constructor for a client with the given methods, as specified in
  1243. the methods argument. The resulting class will have an instance method for
  1244. each method in the service, which is a partial application of one of the
  1245. <a href="grpc.Client.html">Client</a> request methods, depending on <code>requestSerialize</code>
  1246. and <code>responseSerialize</code>, with the <code>method</code>, <code>serialize</code>, and <code>deserialize</code>
  1247. arguments predefined.</p>
  1248. </div>
  1249. <h5>Parameters:</h5>
  1250. <table class="params table table-striped">
  1251. <thead>
  1252. <tr>
  1253. <th>Name</th>
  1254. <th>Type</th>
  1255. <th class="last">Description</th>
  1256. </tr>
  1257. </thead>
  1258. <tbody>
  1259. <tr>
  1260. <td class="name"><code>methods</code></td>
  1261. <td class="type">
  1262. <span class="param-type"><a href="grpc.html#~ServiceDefinition">grpc~ServiceDefinition</a></span>
  1263. </td>
  1264. <td class="description last"><p>An object mapping method names to
  1265. method attributes</p></td>
  1266. </tr>
  1267. <tr>
  1268. <td class="name"><code>serviceName</code></td>
  1269. <td class="type">
  1270. <span class="param-type">string</span>
  1271. </td>
  1272. <td class="description last"><p>The fully qualified name of the service</p></td>
  1273. </tr>
  1274. <tr>
  1275. <td class="name"><code>class_options</code></td>
  1276. <td class="type">
  1277. <span class="param-type">Object</span>
  1278. </td>
  1279. <td class="description last"><p>An options object.</p>
  1280. <h6 class="method-params-label method-subparams-label">Properties</h6>
  1281. <table class="params table table-striped">
  1282. <thead>
  1283. <tr>
  1284. <th>Name</th>
  1285. <th>Type</th>
  1286. <th>Argument</th>
  1287. <th>Default</th>
  1288. <th class="last">Description</th>
  1289. </tr>
  1290. </thead>
  1291. <tbody>
  1292. <tr>
  1293. <td class="name"><code>deprecatedArgumentOrder</code></td>
  1294. <td class="type">
  1295. <span class="param-type">boolean</span>
  1296. </td>
  1297. <td class="attributes">
  1298. &lt;optional><br>
  1299. </td>
  1300. <td class="default">
  1301. false
  1302. </td>
  1303. <td class="description last"><p>Indicates
  1304. that the old argument order should be used for methods, with optional
  1305. arguments at the end instead of the callback at the end. This option
  1306. is only a temporary stopgap measure to smooth an API breakage.
  1307. It is deprecated, and new code should not use it.</p></td>
  1308. </tr>
  1309. </tbody>
  1310. </table>
  1311. </td>
  1312. </tr>
  1313. </tbody>
  1314. </table>
  1315. <dl class="details">
  1316. </dl>
  1317. <h5>Returns:</h5>
  1318. <div class="param-desc">
  1319. <p>New client constructor, which is a subclass of
  1320. <a href="grpc.Client.html">grpc.Client</a>, and has the same arguments as that constructor.</p>
  1321. </div>
  1322. <dl>
  1323. <dt>
  1324. Type
  1325. </dt>
  1326. <dd>
  1327. <span class="param-type">function</span>
  1328. </dd>
  1329. </dl>
  1330. </dd>
  1331. <hr>
  1332. <dt>
  1333. <h4 class="name" id="~waitForClientReady"><span class="type-signature">&lt;inner> </span>waitForClientReady(client, deadline, callback)</h4>
  1334. </dt>
  1335. <dd>
  1336. <div class="description">
  1337. <p>Wait for the client to be ready. The callback will be called when the
  1338. client has successfully connected to the server, and it will be called
  1339. with an error if the attempt to connect to the server has unrecoverablly
  1340. failed or if the deadline expires. This function will make the channel
  1341. start connecting if it has not already done so.</p>
  1342. </div>
  1343. <h5>Parameters:</h5>
  1344. <table class="params table table-striped">
  1345. <thead>
  1346. <tr>
  1347. <th>Name</th>
  1348. <th>Type</th>
  1349. <th class="last">Description</th>
  1350. </tr>
  1351. </thead>
  1352. <tbody>
  1353. <tr>
  1354. <td class="name"><code>client</code></td>
  1355. <td class="type">
  1356. <span class="param-type"><a href="grpc.Client.html">grpc.Client</a></span>
  1357. </td>
  1358. <td class="description last"><p>The client to wait on</p></td>
  1359. </tr>
  1360. <tr>
  1361. <td class="name"><code>deadline</code></td>
  1362. <td class="type">
  1363. <span class="param-type"><a href="grpc.html#~Deadline">grpc~Deadline</a></span>
  1364. </td>
  1365. <td class="description last"><p>When to stop waiting for a connection. Pass
  1366. Infinity to wait forever.</p></td>
  1367. </tr>
  1368. <tr>
  1369. <td class="name"><code>callback</code></td>
  1370. <td class="type">
  1371. <span class="param-type">function</span>
  1372. </td>
  1373. <td class="description last"><p>The callback to call when done attempting
  1374. to connect.</p></td>
  1375. </tr>
  1376. </tbody>
  1377. </table>
  1378. <dl class="details">
  1379. <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
  1380. <dd class="tag-see">
  1381. <ul>
  1382. <li><a href="grpc.Client.html#waitForReady">grpc.Client#waitForReady</a></li>
  1383. </ul>
  1384. </dd>
  1385. </dl>
  1386. </dd>
  1387. </dl>
  1388. <h3 class="subsection-title">Type Definitions</h3>
  1389. <dl>
  1390. <hr>
  1391. <dt class="name" id="~ChannelOptions">
  1392. <h4 id="~ChannelOptions">ChannelOptions</h4>
  1393. </dt>
  1394. <dd>
  1395. <h5>Type:</h5>
  1396. <ul>
  1397. <li>
  1398. <span class="param-type">Object.&lt;string, (string|number)></span>
  1399. </li>
  1400. </ul>
  1401. <dl class="details">
  1402. </dl>
  1403. </dd>
  1404. <hr>
  1405. <dt class="name" id="~CoreMetadata">
  1406. <h4 id="~CoreMetadata">CoreMetadata</h4>
  1407. </dt>
  1408. <dd>
  1409. <div class="description">
  1410. <p>Metadata representation as passed to and the native addon</p>
  1411. </div>
  1412. <h5>Type:</h5>
  1413. <ul>
  1414. <li>
  1415. <span class="param-type">object</span>
  1416. </li>
  1417. </ul>
  1418. <dl class="details">
  1419. </dl>
  1420. </dd>
  1421. <hr>
  1422. <dt class="name" id="~Deadline">
  1423. <h4 id="~Deadline">Deadline</h4>
  1424. </dt>
  1425. <dd>
  1426. <div class="description">
  1427. <p>The deadline of an operation. If it is a date, the deadline is reached at
  1428. the date and time specified. If it is a finite number, it is treated as
  1429. a number of milliseconds since the Unix Epoch. If it is Infinity, the
  1430. deadline will never be reached. If it is -Infinity, the deadline has already
  1431. passed.</p>
  1432. </div>
  1433. <h5>Type:</h5>
  1434. <ul>
  1435. <li>
  1436. <span class="param-type">number</span>
  1437. |
  1438. <span class="param-type">Date</span>
  1439. </li>
  1440. </ul>
  1441. <dl class="details">
  1442. </dl>
  1443. </dd>
  1444. <hr>
  1445. <dt>
  1446. <h4 class="name" id="~deserialize"><span class="type-signature"></span>deserialize(data)</h4>
  1447. </dt>
  1448. <dd>
  1449. <div class="description">
  1450. <p>A deserialization function</p>
  1451. </div>
  1452. <h5>Parameters:</h5>
  1453. <table class="params table table-striped">
  1454. <thead>
  1455. <tr>
  1456. <th>Name</th>
  1457. <th>Type</th>
  1458. <th class="last">Description</th>
  1459. </tr>
  1460. </thead>
  1461. <tbody>
  1462. <tr>
  1463. <td class="name"><code>data</code></td>
  1464. <td class="type">
  1465. <span class="param-type">Buffer</span>
  1466. </td>
  1467. <td class="description last"><p>The byte sequence to deserialize</p></td>
  1468. </tr>
  1469. </tbody>
  1470. </table>
  1471. <dl class="details">
  1472. </dl>
  1473. <h5>Returns:</h5>
  1474. <div class="param-desc">
  1475. <p>The data deserialized as a value</p>
  1476. </div>
  1477. <dl>
  1478. <dt>
  1479. Type
  1480. </dt>
  1481. <dd>
  1482. <span class="param-type">*</span>
  1483. </dd>
  1484. </dl>
  1485. </dd>
  1486. <hr>
  1487. <dt class="name" id="~Listener">
  1488. <h4 id="~Listener">Listener</h4>
  1489. </dt>
  1490. <dd>
  1491. <div class="description">
  1492. <p>A set of interceptor functions triggered by responses</p>
  1493. </div>
  1494. <h5>Type:</h5>
  1495. <ul>
  1496. <li>
  1497. <span class="param-type">object</span>
  1498. </li>
  1499. </ul>
  1500. <dl class="details">
  1501. <h5 class="subsection-title">Properties:</h5>
  1502. <dl>
  1503. <table class="props table table-striped">
  1504. <thead>
  1505. <tr>
  1506. <th>Name</th>
  1507. <th>Type</th>
  1508. <th>Argument</th>
  1509. <th class="last">Description</th>
  1510. </tr>
  1511. </thead>
  1512. <tbody>
  1513. <tr>
  1514. <td class="name"><code>onReceiveMetadata</code></td>
  1515. <td class="type">
  1516. <span class="param-type"><a href="global.html#MetadataListener">MetadataListener</a></span>
  1517. </td>
  1518. <td class="attributes">
  1519. &lt;optional><br>
  1520. </td>
  1521. <td class="description last"><p>A function triggered by
  1522. response metadata.</p></td>
  1523. </tr>
  1524. <tr>
  1525. <td class="name"><code>onReceiveMessage</code></td>
  1526. <td class="type">
  1527. <span class="param-type"><a href="global.html#MessageListener">MessageListener</a></span>
  1528. </td>
  1529. <td class="attributes">
  1530. &lt;optional><br>
  1531. </td>
  1532. <td class="description last"><p>A function triggered by a
  1533. response message.</p></td>
  1534. </tr>
  1535. <tr>
  1536. <td class="name"><code>onReceiveStatus</code></td>
  1537. <td class="type">
  1538. <span class="param-type"><a href="global.html#StatusListener">StatusListener</a></span>
  1539. </td>
  1540. <td class="attributes">
  1541. &lt;optional><br>
  1542. </td>
  1543. <td class="description last"><p>A function triggered by a
  1544. response status.</p></td>
  1545. </tr>
  1546. </tbody>
  1547. </table>
  1548. </dl>
  1549. </dl>
  1550. </dd>
  1551. <hr>
  1552. <dt class="name" id="~MethodDefinition">
  1553. <h4 id="~MethodDefinition">MethodDefinition</h4>
  1554. </dt>
  1555. <dd>
  1556. <div class="description">
  1557. <p>An object that completely defines a service method signature.</p>
  1558. </div>
  1559. <h5>Type:</h5>
  1560. <ul>
  1561. <li>
  1562. <span class="param-type">Object</span>
  1563. </li>
  1564. </ul>
  1565. <dl class="details">
  1566. <h5 class="subsection-title">Properties:</h5>
  1567. <dl>
  1568. <table class="props table table-striped">
  1569. <thead>
  1570. <tr>
  1571. <th>Name</th>
  1572. <th>Type</th>
  1573. <th class="last">Description</th>
  1574. </tr>
  1575. </thead>
  1576. <tbody>
  1577. <tr>
  1578. <td class="name"><code>path</code></td>
  1579. <td class="type">
  1580. <span class="param-type">string</span>
  1581. </td>
  1582. <td class="description last"><p>The method's URL path</p></td>
  1583. </tr>
  1584. <tr>
  1585. <td class="name"><code>requestStream</code></td>
  1586. <td class="type">
  1587. <span class="param-type">boolean</span>
  1588. </td>
  1589. <td class="description last"><p>Indicates whether the method accepts
  1590. a stream of requests</p></td>
  1591. </tr>
  1592. <tr>
  1593. <td class="name"><code>responseStream</code></td>
  1594. <td class="type">
  1595. <span class="param-type">boolean</span>
  1596. </td>
  1597. <td class="description last"><p>Indicates whether the method returns
  1598. a stream of responses</p></td>
  1599. </tr>
  1600. <tr>
  1601. <td class="name"><code>requestSerialize</code></td>
  1602. <td class="type">
  1603. <span class="param-type"><a href="grpc.html#~serialize">grpc~serialize</a></span>
  1604. </td>
  1605. <td class="description last"><p>Serialization
  1606. function for request values</p></td>
  1607. </tr>
  1608. <tr>
  1609. <td class="name"><code>responseSerialize</code></td>
  1610. <td class="type">
  1611. <span class="param-type"><a href="grpc.html#~serialize">grpc~serialize</a></span>
  1612. </td>
  1613. <td class="description last"><p>Serialization
  1614. function for response values</p></td>
  1615. </tr>
  1616. <tr>
  1617. <td class="name"><code>requestDeserialize</code></td>
  1618. <td class="type">
  1619. <span class="param-type"><a href="grpc.html#~deserialize">grpc~deserialize</a></span>
  1620. </td>
  1621. <td class="description last"><p>Deserialization
  1622. function for request data</p></td>
  1623. </tr>
  1624. <tr>
  1625. <td class="name"><code>responseDeserialize</code></td>
  1626. <td class="type">
  1627. <span class="param-type"><a href="grpc.html#~deserialize">grpc~deserialize</a></span>
  1628. </td>
  1629. <td class="description last"><p>Deserialization
  1630. function for repsonse data</p></td>
  1631. </tr>
  1632. </tbody>
  1633. </table>
  1634. </dl>
  1635. </dl>
  1636. </dd>
  1637. <hr>
  1638. <dt class="name" id="~PackageDefinition">
  1639. <h4 id="~PackageDefinition">PackageDefinition</h4>
  1640. </dt>
  1641. <dd>
  1642. <div class="description">
  1643. <p>An object that defines a package hierarchy with multiple services</p>
  1644. </div>
  1645. <h5>Type:</h5>
  1646. <ul>
  1647. <li>
  1648. <span class="param-type">Object.&lt;string, (<a href="grpc.html#~ServiceDefinition">grpc~ServiceDefinition</a>|<a href="grpc.html#~ProtobufTypeDefinition">grpc~ProtobufTypeDefinition</a>)></span>
  1649. </li>
  1650. </ul>
  1651. <dl class="details">
  1652. </dl>
  1653. </dd>
  1654. <hr>
  1655. <dt class="name" id="~ProtobufTypeDefinition">
  1656. <h4 id="~ProtobufTypeDefinition">ProtobufTypeDefinition</h4>
  1657. </dt>
  1658. <dd>
  1659. <div class="description">
  1660. <p>An object that defines a protobuf type</p>
  1661. </div>
  1662. <h5>Type:</h5>
  1663. <ul>
  1664. <li>
  1665. <span class="param-type">object</span>
  1666. </li>
  1667. </ul>
  1668. <dl class="details">
  1669. </dl>
  1670. </dd>
  1671. <hr>
  1672. <dt class="name" id="~Requester">
  1673. <h4 id="~Requester">Requester</h4>
  1674. </dt>
  1675. <dd>
  1676. <h5>Type:</h5>
  1677. <ul>
  1678. <li>
  1679. <span class="param-type">object</span>
  1680. </li>
  1681. </ul>
  1682. <dl class="details">
  1683. </dl>
  1684. </dd>
  1685. <hr>
  1686. <dt>
  1687. <h4 class="name" id="~serialize"><span class="type-signature"></span>serialize(value)</h4>
  1688. </dt>
  1689. <dd>
  1690. <div class="description">
  1691. <p>A serialization function</p>
  1692. </div>
  1693. <h5>Parameters:</h5>
  1694. <table class="params table table-striped">
  1695. <thead>
  1696. <tr>
  1697. <th>Name</th>
  1698. <th>Type</th>
  1699. <th class="last">Description</th>
  1700. </tr>
  1701. </thead>
  1702. <tbody>
  1703. <tr>
  1704. <td class="name"><code>value</code></td>
  1705. <td class="type">
  1706. <span class="param-type">*</span>
  1707. </td>
  1708. <td class="description last"><p>The value to serialize</p></td>
  1709. </tr>
  1710. </tbody>
  1711. </table>
  1712. <dl class="details">
  1713. </dl>
  1714. <h5>Returns:</h5>
  1715. <div class="param-desc">
  1716. <p>The value serialized as a byte sequence</p>
  1717. </div>
  1718. <dl>
  1719. <dt>
  1720. Type
  1721. </dt>
  1722. <dd>
  1723. <span class="param-type">Buffer</span>
  1724. </dd>
  1725. </dl>
  1726. </dd>
  1727. <hr>
  1728. <dt class="name" id="~ServiceDefinition">
  1729. <h4 id="~ServiceDefinition">ServiceDefinition</h4>
  1730. </dt>
  1731. <dd>
  1732. <div class="description">
  1733. <p>An object that completely defines a service.</p>
  1734. </div>
  1735. <h5>Type:</h5>
  1736. <ul>
  1737. <li>
  1738. <span class="param-type">Object.&lt;string, <a href="grpc.html#~MethodDefinition">grpc~MethodDefinition</a>></span>
  1739. </li>
  1740. </ul>
  1741. <dl class="details">
  1742. </dl>
  1743. </dd>
  1744. <hr>
  1745. <dt class="name" id="~ServiceError">
  1746. <h4 id="~ServiceError">ServiceError</h4>
  1747. </dt>
  1748. <dd>
  1749. <div class="description">
  1750. <p>Describes how a request has failed. The member <code>message</code> will be the same as
  1751. <code>details</code> in <a href="grpc.html#~StatusObject">grpc~StatusObject</a>, and <code>code</code> and <code>metadata</code> are the
  1752. same as in that object.</p>
  1753. </div>
  1754. <h5>Type:</h5>
  1755. <ul>
  1756. <li>
  1757. <span class="param-type">Error</span>
  1758. </li>
  1759. </ul>
  1760. <dl class="details">
  1761. <h5 class="subsection-title">Properties:</h5>
  1762. <dl>
  1763. <table class="props table table-striped">
  1764. <thead>
  1765. <tr>
  1766. <th>Name</th>
  1767. <th>Type</th>
  1768. <th class="last">Description</th>
  1769. </tr>
  1770. </thead>
  1771. <tbody>
  1772. <tr>
  1773. <td class="name"><code>code</code></td>
  1774. <td class="type">
  1775. <span class="param-type">number</span>
  1776. </td>
  1777. <td class="description last"><p>The error code, a key of <a href="grpc.html#.status">grpc.status</a> that is
  1778. not <code>grpc.status.OK</code></p></td>
  1779. </tr>
  1780. <tr>
  1781. <td class="name"><code>metadata</code></td>
  1782. <td class="type">
  1783. <span class="param-type"><a href="grpc.Metadata.html">grpc.Metadata</a></span>
  1784. </td>
  1785. <td class="description last"><p>Trailing metadata sent with the status,
  1786. if applicable</p></td>
  1787. </tr>
  1788. </tbody>
  1789. </table>
  1790. </dl>
  1791. </dl>
  1792. </dd>
  1793. <hr>
  1794. <dt class="name" id="~StatusObject">
  1795. <h4 id="~StatusObject">StatusObject</h4>
  1796. </dt>
  1797. <dd>
  1798. <div class="description">
  1799. <p>Represents the status of a completed request. If <code>code</code> is
  1800. <a href="grpc.html#.status">grpc.status</a>.OK, then the request has completed successfully.
  1801. Otherwise, the request has failed, <code>details</code> will contain a description of
  1802. the error. Either way, <code>metadata</code> contains the trailing response metadata
  1803. sent by the server when it finishes processing the call.</p>
  1804. </div>
  1805. <h5>Type:</h5>
  1806. <ul>
  1807. <li>
  1808. <span class="param-type">object</span>
  1809. </li>
  1810. </ul>
  1811. <dl class="details">
  1812. <h5 class="subsection-title">Properties:</h5>
  1813. <dl>
  1814. <table class="props table table-striped">
  1815. <thead>
  1816. <tr>
  1817. <th>Name</th>
  1818. <th>Type</th>
  1819. <th class="last">Description</th>
  1820. </tr>
  1821. </thead>
  1822. <tbody>
  1823. <tr>
  1824. <td class="name"><code>code</code></td>
  1825. <td class="type">
  1826. <span class="param-type">number</span>
  1827. </td>
  1828. <td class="description last"><p>The error code, a key of <a href="grpc.html#.status">grpc.status</a></p></td>
  1829. </tr>
  1830. <tr>
  1831. <td class="name"><code>details</code></td>
  1832. <td class="type">
  1833. <span class="param-type">string</span>
  1834. </td>
  1835. <td class="description last"><p>Human-readable description of the status</p></td>
  1836. </tr>
  1837. <tr>
  1838. <td class="name"><code>metadata</code></td>
  1839. <td class="type">
  1840. <span class="param-type"><a href="grpc.Metadata.html">grpc.Metadata</a></span>
  1841. </td>
  1842. <td class="description last"><p>Trailing metadata sent with the status,
  1843. if applicable</p></td>
  1844. </tr>
  1845. </tbody>
  1846. </table>
  1847. </dl>
  1848. </dl>
  1849. </dd>
  1850. </dl>
  1851. </article>
  1852. </section>
  1853. </div>
  1854. </div>
  1855. <div class="clearfix"></div>
  1856. <div class="col-md-3">
  1857. <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
  1858. </div>
  1859. </div>
  1860. </div>
  1861. <div class="modal fade" id="searchResults">
  1862. <div class="modal-dialog">
  1863. <div class="modal-content">
  1864. <div class="modal-header">
  1865. <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
  1866. <h4 class="modal-title">Search results</h4>
  1867. </div>
  1868. <div class="modal-body"></div>
  1869. <div class="modal-footer">
  1870. <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
  1871. </div>
  1872. </div><!-- /.modal-content -->
  1873. </div><!-- /.modal-dialog -->
  1874. </div>
  1875. <footer>
  1876. <span class="jsdoc-message">
  1877. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
  1878. on 2019-07-15T16:38:16-07:00
  1879. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
  1880. </span>
  1881. </footer>
  1882. <script src="scripts/docstrap.lib.js"></script>
  1883. <script src="scripts/toc.js"></script>
  1884. <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
  1885. <script>
  1886. $( function () {
  1887. $( "[id*='$']" ).each( function () {
  1888. var $this = $( this );
  1889. $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
  1890. } );
  1891. $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
  1892. var $this = $( this );
  1893. var example = $this.find( "code" );
  1894. exampleText = example.html();
  1895. var lang = /{@lang (.*?)}/.exec( exampleText );
  1896. if ( lang && lang[1] ) {
  1897. exampleText = exampleText.replace( lang[0], "" );
  1898. example.html( exampleText );
  1899. lang = lang[1];
  1900. } else {
  1901. var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
  1902. lang = langClassMatch ? langClassMatch[1] : "javascript";
  1903. }
  1904. if ( lang ) {
  1905. $this
  1906. .addClass( "sunlight-highlight-" + lang )
  1907. .addClass( "linenums" )
  1908. .html( example.html() );
  1909. }
  1910. } );
  1911. Sunlight.highlightAll( {
  1912. lineNumbers : false,
  1913. showMenu : true,
  1914. enableDoclinks : true
  1915. } );
  1916. $.catchAnchorLinks( {
  1917. navbarOffset: 10
  1918. } );
  1919. $( "#toc" ).toc( {
  1920. anchorName : function ( i, heading, prefix ) {
  1921. return $( heading ).attr( "id" ) || ( prefix + i );
  1922. },
  1923. selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
  1924. showAndHide : false,
  1925. smoothScrolling: true
  1926. } );
  1927. $( "#main span[id^='toc']" ).addClass( "toc-shim" );
  1928. $( '.dropdown-toggle' ).dropdown();
  1929. $( "table" ).each( function () {
  1930. var $this = $( this );
  1931. $this.addClass('table');
  1932. } );
  1933. } );
  1934. </script>
  1935. <!--Navigation and Symbol Display-->
  1936. <!--Google Analytics-->
  1937. <script type="text/javascript">
  1938. $(document).ready(function() {
  1939. SearcherDisplay.init();
  1940. });
  1941. </script>
  1942. </body>
  1943. </html>