1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845 |
- <!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="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
- <ul class="dropdown-menu ">
- <li><a href="module-src_client_interceptors.html">src/client_interceptors</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.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>
- </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="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
- <ul class="dropdown-menu ">
- <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>
- </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.Channel.html">Channel</a></dt>
- <dd></dd>
-
- <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-Call.html">Call</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=".connectivityState">
- <h4 id=".connectivityState"><span class="type-signature"><static, readonly> </span>connectivityState<span class="type-signature"> :number</span></h4>
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Connectivity state values</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>IDLE</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>CONNECTING</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>READY</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>TRANSIENT_FAILURE</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>SHUTDOWN</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 4
-
- </td>
-
- <td class="description last"></td>
- </tr>
-
- </tbody>
- </table>
- </dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
- </dd>
-
-
- <hr>
- <dt class="name" id=".load">
- <h4 id=".load"><span class="type-signature"><static> </span>load<span class="type-signature"></span></h4>
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Load a gRPC object from a .proto file.</p>
- </div>
-
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
- <dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
-
- <dd>
- <ul class="dummy">
- <li>Use the <a href="https://www.npmjs.com/package/@grpc/proto-loader">proto-loader module</a>
- with grpc.loadPackageDefinition instead.</li>
- </ul>
- </dd>
-
-
-
-
-
-
-
-
-
-
- </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=".methodTypes">
- <h4 id=".methodTypes"><span class="type-signature"><static, readonly> </span>methodTypes<span class="type-signature"> :number</span></h4>
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Method types: the supported RPC types</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>UNARY</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>CLIENT_STREAMING</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>SERVER_STREAMING</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>BIDI_STREAMING</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="default">
-
- 3
-
- </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=".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="~ChannelOptions">
- <h4 id="~ChannelOptions">ChannelOptions</h4>
-
- </dt>
- <dd>
-
-
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">Object.<string, (string|number)></span>
- </li>
- </ul>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
- </dd>
-
-
- <hr>
- <dt class="name" id="~CoreMetadata">
- <h4 id="~CoreMetadata">CoreMetadata</h4>
-
- </dt>
- <dd>
-
- <div class="description">
- <p>Metadata representation as passed to and the native addon</p>
- </div>
-
-
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">object</span>
- </li>
- </ul>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
- </dd>
-
-
- <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="~Listener">
- <h4 id="~Listener">Listener</h4>
-
- </dt>
- <dd>
-
- <div class="description">
- <p>A set of interceptor functions triggered by responses</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>Argument</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>onReceiveMetadata</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="global.html#MetadataListener">MetadataListener</a></span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
- </td>
-
-
- <td class="description last"><p>A function triggered by
- response metadata.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>onReceiveMessage</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="global.html#MessageListener">MessageListener</a></span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
- </td>
-
-
- <td class="description last"><p>A function triggered by a
- response message.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>onReceiveStatus</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="global.html#StatusListener">StatusListener</a></span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
- </td>
-
-
- <td class="description last"><p>A function triggered by a
- response status.</p></td>
- </tr>
-
- </tbody>
- </table>
- </dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </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 class="name" id="~PackageDefinition">
- <h4 id="~PackageDefinition">PackageDefinition</h4>
-
- </dt>
- <dd>
-
- <div class="description">
- <p>An object that defines a package hierarchy with multiple services</p>
- </div>
-
-
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">Object.<string, (<a href="grpc.html#~ServiceDefinition">grpc~ServiceDefinition</a>|<a href="grpc.html#~ProtobufTypeDefinition">grpc~ProtobufTypeDefinition</a>)></span>
- </li>
- </ul>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
- </dd>
-
-
- <hr>
- <dt class="name" id="~ProtobufTypeDefinition">
- <h4 id="~ProtobufTypeDefinition">ProtobufTypeDefinition</h4>
-
- </dt>
- <dd>
-
- <div class="description">
- <p>An object that defines a protobuf type</p>
- </div>
-
-
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">object</span>
- </li>
- </ul>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
- </dd>
-
-
- <hr>
- <dt class="name" id="~Requester">
- <h4 id="~Requester">Requester</h4>
-
- </dt>
- <dd>
-
-
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">object</span>
- </li>
- </ul>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </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 2019-07-15T16:38:16-07: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>
|