grpc/python/searchindex.js

Search.setIndex({docnames:["glossary","grpc","grpc_channelz","grpc_health_checking","grpc_reflection","grpc_testing","index"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":1,"sphinx.ext.viewcode":1,sphinx:54},filenames:["glossary.rst","grpc.rst","grpc_channelz.rst","grpc_health_checking.rst","grpc_reflection.rst","grpc_testing.rst","index.rst"],objects:{"":{grpc:[1,0,0,"-"],grpc_testing:[5,0,0,"-"]},"grpc.AuthMetadataContext":{method_name:[1,2,1,""],service_url:[1,2,1,""]},"grpc.AuthMetadataPlugin":{__call__:[1,3,1,""]},"grpc.AuthMetadataPluginCallback":{__call__:[1,3,1,""]},"grpc.Call":{code:[1,3,1,""],details:[1,3,1,""],initial_metadata:[1,3,1,""],trailing_metadata:[1,3,1,""]},"grpc.Channel":{close:[1,3,1,""],stream_stream:[1,3,1,""],stream_unary:[1,3,1,""],subscribe:[1,3,1,""],unary_stream:[1,3,1,""],unary_unary:[1,3,1,""],unsubscribe:[1,3,1,""]},"grpc.ChannelConnectivity":{CONNECTING:[1,2,1,""],IDLE:[1,2,1,""],READY:[1,2,1,""],SHUTDOWN:[1,2,1,""],TRANSIENT_FAILURE:[1,2,1,""]},"grpc.ClientCallDetails":{credentials:[1,2,1,""],metadata:[1,2,1,""],method:[1,2,1,""],timeout:[1,2,1,""],wait_for_ready:[1,2,1,""]},"grpc.Future":{add_done_callback:[1,3,1,""],cancel:[1,3,1,""],cancelled:[1,3,1,""],done:[1,3,1,""],exception:[1,3,1,""],result:[1,3,1,""],running:[1,3,1,""],traceback:[1,3,1,""]},"grpc.GenericRpcHandler":{service:[1,3,1,""]},"grpc.HandlerCallDetails":{invocation_metadata:[1,2,1,""]},"grpc.RpcContext":{add_callback:[1,3,1,""],cancel:[1,3,1,""],is_active:[1,3,1,""],time_remaining:[1,3,1,""]},"grpc.RpcMethodHandler":{request_deserializer:[1,2,1,""],request_streaming:[1,2,1,""],response_serializer:[1,2,1,""],response_streaming:[1,2,1,""],stream_stream:[1,2,1,""],stream_unary:[1,2,1,""],unary_stream:[1,2,1,""],unary_unary:[1,2,1,""]},"grpc.Server":{add_generic_rpc_handlers:[1,3,1,""],add_insecure_port:[1,3,1,""],add_secure_port:[1,3,1,""],start:[1,3,1,""],stop:[1,3,1,""]},"grpc.ServerInterceptor":{intercept_service:[1,3,1,""]},"grpc.ServiceRpcHandler":{service_name:[1,3,1,""]},"grpc.ServicerContext":{abort:[1,3,1,""],abort_with_status:[1,3,1,""],auth_context:[1,3,1,""],invocation_metadata:[1,3,1,""],peer:[1,3,1,""],peer_identities:[1,3,1,""],peer_identity_key:[1,3,1,""],send_initial_metadata:[1,3,1,""],set_code:[1,3,1,""],set_details:[1,3,1,""],set_trailing_metadata:[1,3,1,""]},"grpc.StatusCode":{ABORTED:[1,2,1,""],ALREADY_EXISTS:[1,2,1,""],CANCELLED:[1,2,1,""],DATA_LOSS:[1,2,1,""],DEADLINE_EXCEEDED:[1,2,1,""],FAILED_PRECONDITION:[1,2,1,""],INTERNAL:[1,2,1,""],INVALID_ARGUMENT:[1,2,1,""],NOT_FOUND:[1,2,1,""],OK:[1,2,1,""],PERMISSION_DENIED:[1,2,1,""],RESOURCE_EXHAUSTED:[1,2,1,""],UNAUTHENTICATED:[1,2,1,""],UNAVAILABLE:[1,2,1,""],UNIMPLEMENTED:[1,2,1,""],UNKNOWN:[1,2,1,""]},"grpc.StreamStreamClientInterceptor":{intercept_stream_stream:[1,3,1,""]},"grpc.StreamStreamMultiCallable":{__call__:[1,3,1,""]},"grpc.StreamUnaryClientInterceptor":{intercept_stream_unary:[1,3,1,""]},"grpc.StreamUnaryMultiCallable":{__call__:[1,3,1,""],future:[1,3,1,""],with_call:[1,3,1,""]},"grpc.UnaryStreamClientInterceptor":{intercept_unary_stream:[1,3,1,""]},"grpc.UnaryStreamMultiCallable":{__call__:[1,3,1,""]},"grpc.UnaryUnaryClientInterceptor":{intercept_unary_unary:[1,3,1,""]},"grpc.UnaryUnaryMultiCallable":{__call__:[1,3,1,""],future:[1,3,1,""],with_call:[1,3,1,""]},"grpc_channelz.v1":{channelz:[2,0,0,"-"]},"grpc_channelz.v1.channelz":{ChannelzServicer:[2,1,1,""],add_channelz_servicer:[2,5,1,""]},"grpc_health.v1.health":{HealthServicer:[3,1,1,""]},"grpc_health.v1.health.HealthServicer":{set:[3,3,1,""]},"grpc_reflection.v1alpha":{reflection:[4,0,0,"-"]},"grpc_reflection.v1alpha.reflection":{ReflectionServicer:[4,1,1,""],enable_server_reflection:[4,5,1,""]},"grpc_testing.Channel":{take_stream_stream:[5,3,1,""],take_stream_unary:[5,3,1,""],take_unary_stream:[5,3,1,""],take_unary_unary:[5,3,1,""]},"grpc_testing.Server":{invoke_stream_stream:[5,3,1,""],invoke_stream_unary:[5,3,1,""],invoke_unary_stream:[5,3,1,""],invoke_unary_unary:[5,3,1,""]},"grpc_testing.StreamStreamChannelRpc":{cancelled:[5,3,1,""],requests_closed:[5,3,1,""],send_initial_metadata:[5,3,1,""],send_response:[5,3,1,""],take_request:[5,3,1,""],terminate:[5,3,1,""]},"grpc_testing.StreamStreamServerRpc":{cancel:[5,3,1,""],initial_metadata:[5,3,1,""],requests_closed:[5,3,1,""],send_request:[5,3,1,""],take_response:[5,3,1,""],termination:[5,3,1,""]},"grpc_testing.StreamUnaryChannelRpc":{cancelled:[5,3,1,""],requests_closed:[5,3,1,""],send_initial_metadata:[5,3,1,""],take_request:[5,3,1,""],terminate:[5,3,1,""]},"grpc_testing.StreamUnaryServerRpc":{cancel:[5,3,1,""],initial_metadata:[5,3,1,""],requests_closed:[5,3,1,""],send_request:[5,3,1,""],termination:[5,3,1,""]},"grpc_testing.Time":{call_at:[5,3,1,""],call_in:[5,3,1,""],sleep_for:[5,3,1,""],sleep_until:[5,3,1,""],time:[5,3,1,""]},"grpc_testing.UnaryStreamChannelRpc":{cancelled:[5,3,1,""],send_initial_metadata:[5,3,1,""],send_response:[5,3,1,""],terminate:[5,3,1,""]},"grpc_testing.UnaryStreamServerRpc":{cancel:[5,3,1,""],initial_metadata:[5,3,1,""],take_response:[5,3,1,""],termination:[5,3,1,""]},"grpc_testing.UnaryUnaryChannelRpc":{cancelled:[5,3,1,""],send_initial_metadata:[5,3,1,""],terminate:[5,3,1,""]},"grpc_testing.UnaryUnaryServerRpc":{cancel:[5,3,1,""],initial_metadata:[5,3,1,""],termination:[5,3,1,""]},grpc:{AuthMetadataContext:[1,1,1,""],AuthMetadataPlugin:[1,1,1,""],AuthMetadataPluginCallback:[1,1,1,""],Call:[1,1,1,""],CallCredentials:[1,1,1,""],Channel:[1,1,1,""],ChannelConnectivity:[1,1,1,""],ChannelCredentials:[1,1,1,""],ClientCallDetails:[1,1,1,""],Future:[1,1,1,""],FutureCancelledError:[1,4,1,""],FutureTimeoutError:[1,4,1,""],GenericRpcHandler:[1,1,1,""],HandlerCallDetails:[1,1,1,""],RpcContext:[1,1,1,""],RpcError:[1,4,1,""],RpcMethodHandler:[1,1,1,""],Server:[1,1,1,""],ServerCertificateConfiguration:[1,1,1,""],ServerCredentials:[1,1,1,""],ServerInterceptor:[1,1,1,""],ServiceRpcHandler:[1,1,1,""],ServicerContext:[1,1,1,""],StatusCode:[1,1,1,""],StreamStreamClientInterceptor:[1,1,1,""],StreamStreamMultiCallable:[1,1,1,""],StreamUnaryClientInterceptor:[1,1,1,""],StreamUnaryMultiCallable:[1,1,1,""],UnaryStreamClientInterceptor:[1,1,1,""],UnaryStreamMultiCallable:[1,1,1,""],UnaryUnaryClientInterceptor:[1,1,1,""],UnaryUnaryMultiCallable:[1,1,1,""],access_token_call_credentials:[1,5,1,""],channel_ready_future:[1,5,1,""],composite_call_credentials:[1,5,1,""],composite_channel_credentials:[1,5,1,""],dynamic_ssl_server_credentials:[1,5,1,""],insecure_channel:[1,5,1,""],intercept_channel:[1,5,1,""],metadata_call_credentials:[1,5,1,""],method_handlers_generic_handler:[1,5,1,""],secure_channel:[1,5,1,""],server:[1,5,1,""],ssl_channel_credentials:[1,5,1,""],ssl_server_certificate_configuration:[1,5,1,""],ssl_server_credentials:[1,5,1,""],stream_stream_rpc_method_handler:[1,5,1,""],stream_unary_rpc_method_handler:[1,5,1,""],unary_stream_rpc_method_handler:[1,5,1,""],unary_unary_rpc_method_handler:[1,5,1,""]},grpc_testing:{Channel:[5,1,1,""],Server:[5,1,1,""],StreamStreamChannelRpc:[5,1,1,""],StreamStreamServerRpc:[5,1,1,""],StreamUnaryChannelRpc:[5,1,1,""],StreamUnaryServerRpc:[5,1,1,""],Time:[5,1,1,""],UnaryStreamChannelRpc:[5,1,1,""],UnaryStreamServerRpc:[5,1,1,""],UnaryUnaryChannelRpc:[5,1,1,""],UnaryUnaryServerRpc:[5,1,1,""],channel:[5,5,1,""],server_from_dictionary:[5,5,1,""],strict_fake_time:[5,5,1,""],strict_real_time:[5,5,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"],"4":["py","exception","Python exception"],"5":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method","4":"py:exception","5":"py:function"},terms:{"boolean":1,"byte":[0,1],"case":1,"class":[1,2,3,4,5],"default":[1,2,4],"enum":3,"float":1,"function":1,"long":5,"new":1,"return":[1,5],"true":1,For:1,Not:1,One:1,TLS:1,That:2,The:[0,1,2,5],__call__:1,__version__:1,_pb2_grpc:5,abort:1,abort_with_statu:1,accept:1,access:[1,5],access_token:1,access_token_call_credenti:1,action:1,activ:1,actual:1,add:[1,2,5],add_callback:1,add_channelz_servic:2,add_done_callback:1,add_generic_rpc_handl:1,add_insecure_port:1,add_secure_port:1,added:[1,2,4,5],adding:2,address:1,advanc:5,affect:1,afford:1,after:[1,5],again:1,all:[1,5],allot:1,allow:[1,2],alreadi:1,already_exist:1,also:1,although:1,alwai:1,ani:[1,5],anoth:1,api:[1,2],applic:[1,5],arbitrari:1,arbitrarili:1,arg:[1,2],argument:[1,5],arriv:1,ascii:[0,1],assert:1,asynchron:1,attempt:1,attribut:1,auth:1,auth_context:1,authent:6,authmetadatacontext:1,authmetadataplugin:1,authmetadataplugincallback:1,author:[5,6],avail:[1,4],back:5,basic:1,bearer:1,becam:1,becaus:1,been:[1,5],befor:[1,5],begun:1,behavior:[1,5],behaviour:1,being:[1,5],belong:1,better:1,beyond:5,bin:0,binari:0,block:[1,5],bool:1,both:1,broken:1,busi:1,call:[1,5],call_at:5,call_credenti:1,call_in:5,callabl:6,callback:[1,5],callcredenti:1,caller:1,can:[0,1,2,5],cancel:[1,5],cannot:1,caus:5,certif:1,certificate_chain:1,certificate_configur:1,certificate_configuration_fetch:1,chain:1,chang:[1,5],channel:[2,5,6],channel_credenti:1,channel_ready_futur:1,channelconnect:1,channelcredenti:1,channelz:6,channelzservic:2,charg:2,check:[1,4,6],choos:1,chosen:1,circumst:1,client:[5,6],client_call_detail:1,clientcalldetail:1,close:[1,5],code:[5,6],collect:1,complet:1,compos:1,composite_call_credenti:1,composite_channel_credenti:1,comput:1,concurr:1,conduct:1,config:1,configur:1,connect:[5,6],consid:1,construct:1,content:6,context:6,continu:1,control:1,core:[1,2],correspond:1,corrupt:1,could:1,creat:[5,6],credenti:6,current:[1,5],custom:1,data:1,data_loss:1,deadlin:1,deadline_exceed:1,debug:[1,2],decid:1,decoupl:1,defin:[1,5],delai:5,deriv:1,describ:[1,5],descriptor:5,descriptor_pool:4,descriptorpool:4,descriptors_to_servic:5,deseri:1,design:2,detail:[1,5],determin:1,dev0:6,dictionari:[1,5],did:1,directli:1,directori:1,disabl:2,dive:1,document:2,doe:[1,5],done:1,doubl:5,draw:[1,5],due:1,durat:[1,5],dure:1,dynamic_ssl_server_credenti:1,each:1,effect:1,either:[0,1,5],emit:5,enabl:[1,2,4,5],enable_channelz:2,enable_server_reflect:4,encapsul:1,encod:1,end:[0,1,5],ensur:5,enter:1,entir:[1,2],entiti:1,entri:0,equival:1,error:1,etc:1,event:1,everi:1,exactli:1,exampl:6,except:6,execut:[1,5],exhaust:1,exist:1,exit:1,expect:1,experiment:[1,2],expir:1,extens:1,failed_precondit:1,failur:1,fals:1,fetch:1,file:1,finish:1,first:[0,1],fixtur:5,flag:1,flow:1,form:1,format:1,forward:1,found:1,from:[1,2,5],fulli:[1,4],futur:[5,6],futurecancellederror:1,futuretimeouterror:1,gain:1,gener:[1,5],generic_rpc_handl:1,genericrpchandl:1,get:1,github:4,given:[1,5],glossari:6,goe:1,grace:1,grpc_channelz:2,grpc_connectivity_st:1,grpc_health:3,grpc_reflect:4,grpc_status_cod:1,grpc_test:5,hand:1,handl:[1,2,3,4],handler:6,handler_call_detail:1,handlercalldetail:1,handshak:1,has:[1,5],have:[1,5],header:[0,1],health:6,healthcheckrespons:3,healthservic:3,held:1,http:[0,1],idempot:1,ident:1,identifi:[1,5],idl:1,immedi:1,implement:[1,2,4,5],imposs:1,includ:0,incom:1,independ:5,index:6,indic:[1,3,5],infinit:1,info:2,inform:[1,2],initi:[1,5],initial_certificate_configur:1,initial_metadata:[1,5],insecur:1,insecure_channel:1,insid:2,instanc:[1,5],integ:1,intercept:1,intercept_channel:1,intercept_servic:1,intercept_stream_stream:1,intercept_stream_unari:1,intercept_unary_stream:1,intercept_unary_unari:1,interceptor:6,interfac:[5,6],intern:[1,5],interpret:5,invalid:1,invalid_argu:1,invari:1,invoc:[1,5],invocation_metadata:[1,5],invok:[1,5],invoke_stream_stream:5,invoke_stream_unari:5,invoke_unary_stream:5,invoke_unary_unari:5,is_act:[1,5],isol:2,issu:1,iter:[1,4,5],its:[1,5],just:1,kei:[0,1],kwarg:2,larger:1,last:1,later:1,least:1,length:[1,5],librari:1,like:1,limit:[1,5],list:1,live:5,locat:1,logic:1,lookup:1,loss:1,machin:1,made:5,mai:[1,5],maintain:5,make:1,manag:1,mani:1,manipul:[1,5],map:1,matur:1,maximum:1,maximum_concurrent_rpc:1,mean:[1,2],mechan:1,mere:1,messag:[1,5],metadata:[0,1,5],metadata_call_credenti:1,metadata_plugin:1,metadatum:0,method:[5,6],method_descriptor:5,method_handl:1,method_handlers_generic_handl:1,method_nam:1,methoddescriptor:5,mirror:1,modul:6,monitor:1,more:[1,5],most:1,move:1,multi:6,multipl:1,must:[0,1,3],name:[0,1,3,4],need:1,needn:5,next:1,non:1,none:[1,4,5],nonneg:1,not_found:1,note:3,now:5,number:1,object:[4,5,6],observ:1,omit:1,onc:1,one:[1,5],ones:1,ongo:1,onli:[1,5],open:1,oper:1,opposit:1,option:[1,2],order:[1,5],other:1,otherwis:1,out:[1,4],outcom:1,outgo:1,over:[1,5],page:6,pair:[0,1],paramet:[1,2,3,4,5],pass:1,passag:5,peer:1,peer_ident:1,peer_identity_kei:1,pem:1,per:1,perhap:1,period:1,permiss:1,permission_deni:1,place:1,plai:5,plugin:1,pool:4,port:1,previous:1,privat:1,private_kei:1,private_key_certificate_chain_pair:1,proce:1,process:2,produc:1,properti:1,provid:[0,1,5],pull:2,python:[1,2,4,5],qualifi:[1,4],queri:[2,5],quickstart:1,quota:1,rais:1,raw:1,readi:6,real:5,reason:1,receiv:1,recov:1,refer:4,reflect:6,reflectionservic:4,regist:[1,5],reject:1,relat:1,releas:[1,6],remain:1,replac:1,repres:1,represent:[1,5],request:[1,5],request_deseri:1,request_iter:1,request_seri:1,request_stream:1,requests_clos:5,requir:1,require_client_auth:1,require_client_authent:1,resourc:1,resource_exhaust:1,respect:5,respons:[1,2,5],response_deseri:1,response_futur:1,response_iter:1,response_seri:1,response_stream:1,restrict:1,result:1,retriev:1,root:1,root_certif:1,rpc:[2,3,4,5,6],rpccontext:[1,5],rpcerror:1,rpcmethodhandl:1,run:1,runtim:1,safe:1,same:[1,5],schedul:1,scope:1,search:6,second:[0,1,5],secur:1,secure_channel:1,see:1,seen:1,send:[1,5],send_initial_metadata:[1,5],send_request:5,send_respons:5,sent:[1,5],sequenc:[0,1,5],serial:1,server:[2,4,5,6],server_credenti:1,server_from_dictionari:5,servercertificateconfigur:1,servercredenti:1,serverinterceptor:1,servic:[2,3,4,5,6],service_descriptor:5,service_nam:[1,4],service_url:1,servicedescriptor:5,servicer_context:1,servicercontext:1,servicerpchandl:1,set:[1,2,3],set_cod:1,set_detail:1,set_trailing_metadata:1,setup:1,share:6,should:1,shutdown:1,side:6,signal:1,simul:5,singl:1,sleep_for:5,sleep_until:5,smaller:1,some:[1,5],sooner:1,sourc:[1,2,3,4,5],space:1,specif:[1,5],specifi:1,ssl:1,ssl_channel_credenti:1,ssl_server_certificate_configur:1,ssl_server_credenti:1,start:1,state:1,statist:2,statu:[3,5,6],status:[2,3,4],statuscod:1,stop:1,str:0,stream:[1,5],stream_stream:1,stream_stream_channel_rpc:5,stream_stream_rpc_method_handl:1,stream_unari:1,stream_unary_channel_rpc:5,stream_unary_rpc_method_handl:1,streamstreamchannelrpc:5,streamstreamclientinterceptor:1,streamstreammultical:1,streamstreamserverrpc:5,streamunarychannelrpc:5,streamunaryclientinterceptor:1,streamunarymultical:1,streamunaryserverrpc:5,strict:5,strict_fake_tim:5,strict_real_tim:5,string:[1,3],structur:1,submit:5,subscrib:1,subscript:1,subsequ:1,success:[1,5],successfulli:1,suitabl:1,superced:1,support:1,synchron:1,synthes:5,system:[1,5],take:1,take_request:5,take_respons:5,take_stream_stream:5,take_stream_unari:5,take_unary_stream:5,take_unary_unari:5,taken:1,target:1,terim:1,termin:[1,5],test:6,thei:1,them:[1,5],thi:[1,2,4,5],those:5,thread:1,thread_pool:1,threadpoolexecutor:1,through:1,thu:1,time:[1,5],time_remain:[1,5],timeout:[1,5],token:1,traceback:1,track:1,trail:[1,5],trailing_metadata:[1,5],transact:1,transient_failur:1,transit:1,transmit:1,try_to_connect:1,tupl:[0,5],tutori:6,two:1,type:1,typeerror:1,typic:1,unari:[1,5],unary_stream:1,unary_stream_channel_rpc:5,unary_stream_rpc_method_handl:1,unary_unari:1,unary_unary_channel_rpc:5,unary_unary_rpc_method_handl:1,unarystreamchannelrpc:5,unarystreamclientinterceptor:1,unarystreammultical:1,unarystreamserverrpc:5,unaryunarychannelrpc:5,unaryunaryclientinterceptor:1,unaryunarymultical:1,unaryunaryserverrpc:5,unauthent:1,unavail:1,under:[1,5],underli:1,undeseri:1,unimpl:1,unknown:1,unrecover:1,unseri:1,unsubscrib:1,until:[1,5],upon:1,url:1,usag:1,use:[1,4,5],used:[1,5],user:[1,5],using:5,usual:5,util:1,v1alpha:4,valid:[0,1],valu:[0,1,3],verifi:1,version:6,via:1,visibl:1,visit:1,wait:1,wait_for_readi:1,want:1,what:[1,6],when:[1,5],where:[0,1],whether:[1,2],which:[1,2,4,5],wire:1,wish:1,with_cal:1,within:1,without:1,would:1,x00:0,x509_common_nam:1,x509_subject_alternative_nam:1,xff:0,yet:1,yield:1,you:[1,2],zero:1},titles:["Glossary","gRPC","gRPC Channelz","gRPC Health Checking","gRPC Reflection","gRPC Testing","Welcome to gRPC Python\u2019s documentation!"],titleterms:{api:6,authent:1,author:1,callabl:1,channel:1,channelz:2,check:3,client:1,code:1,connect:1,content:[1,2,3,4,5],context:1,creat:1,credenti:1,document:6,exampl:[1,4],except:1,futur:1,glossari:0,grpc:[1,2,3,4,5,6],handler:1,health:3,indic:6,interceptor:1,interfac:1,method:1,modul:[1,2,3,4,5],multi:1,object:1,python:6,readi:1,refer:6,reflect:4,rpc:1,server:1,servic:1,share:1,side:1,statu:1,tabl:6,test:5,tutori:1,version:1,welcom:6,what:[2,4]}})