1 |
- Search.setIndex({docnames:["glossary","grpc","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_health_checking.rst","grpc_reflection.rst","grpc_testing.rst","index.rst"],objects:{"":{grpc:[1,0,0,"-"],grpc_testing:[4,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,""],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_health.v1.health":{HealthServicer:[2,1,1,""]},"grpc_health.v1.health.HealthServicer":{set:[2,3,1,""]},"grpc_reflection.v1alpha":{reflection:[3,0,0,"-"]},"grpc_reflection.v1alpha.reflection":{ReflectionServicer:[3,1,1,""],enable_server_reflection:[3,5,1,""]},"grpc_testing.Channel":{take_stream_stream:[4,3,1,""],take_stream_unary:[4,3,1,""],take_unary_stream:[4,3,1,""],take_unary_unary:[4,3,1,""]},"grpc_testing.Server":{invoke_stream_stream:[4,3,1,""],invoke_stream_unary:[4,3,1,""],invoke_unary_stream:[4,3,1,""],invoke_unary_unary:[4,3,1,""]},"grpc_testing.StreamStreamChannelRpc":{cancelled:[4,3,1,""],requests_closed:[4,3,1,""],send_initial_metadata:[4,3,1,""],send_response:[4,3,1,""],take_request:[4,3,1,""],terminate:[4,3,1,""]},"grpc_testing.StreamStreamServerRpc":{cancel:[4,3,1,""],initial_metadata:[4,3,1,""],requests_closed:[4,3,1,""],send_request:[4,3,1,""],take_response:[4,3,1,""],termination:[4,3,1,""]},"grpc_testing.StreamUnaryChannelRpc":{cancelled:[4,3,1,""],requests_closed:[4,3,1,""],send_initial_metadata:[4,3,1,""],take_request:[4,3,1,""],terminate:[4,3,1,""]},"grpc_testing.StreamUnaryServerRpc":{cancel:[4,3,1,""],initial_metadata:[4,3,1,""],requests_closed:[4,3,1,""],send_request:[4,3,1,""],termination:[4,3,1,""]},"grpc_testing.Time":{call_at:[4,3,1,""],call_in:[4,3,1,""],sleep_for:[4,3,1,""],sleep_until:[4,3,1,""],time:[4,3,1,""]},"grpc_testing.UnaryStreamChannelRpc":{cancelled:[4,3,1,""],send_initial_metadata:[4,3,1,""],send_response:[4,3,1,""],terminate:[4,3,1,""]},"grpc_testing.UnaryStreamServerRpc":{cancel:[4,3,1,""],initial_metadata:[4,3,1,""],take_response:[4,3,1,""],termination:[4,3,1,""]},"grpc_testing.UnaryUnaryChannelRpc":{cancelled:[4,3,1,""],send_initial_metadata:[4,3,1,""],terminate:[4,3,1,""]},"grpc_testing.UnaryUnaryServerRpc":{cancel:[4,3,1,""],initial_metadata:[4,3,1,""],termination:[4,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:[4,1,1,""],Server:[4,1,1,""],StreamStreamChannelRpc:[4,1,1,""],StreamStreamServerRpc:[4,1,1,""],StreamUnaryChannelRpc:[4,1,1,""],StreamUnaryServerRpc:[4,1,1,""],Time:[4,1,1,""],UnaryStreamChannelRpc:[4,1,1,""],UnaryStreamServerRpc:[4,1,1,""],UnaryUnaryChannelRpc:[4,1,1,""],UnaryUnaryServerRpc:[4,1,1,""],channel:[4,5,1,""],server_from_dictionary:[4,5,1,""],strict_fake_time:[4,5,1,""],strict_real_time:[4,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:{"1rc1":5,"boolean":1,"byte":[0,1],"case":1,"class":[1,2,3,4],"default":[1,3],"enum":2,"float":1,"function":1,"long":4,"new":1,"return":[1,4],"true":1,For:1,Not:1,One:1,TLS:1,The:[0,1,4],__call__:1,_pb2_grpc:4,abort:1,accept:1,access:[1,4],access_token:1,access_token_call_credenti:1,action:1,activ:1,actual:1,add:[1,4],add_callback:1,add_done_callback:1,add_generic_rpc_handl:1,add_insecure_port:1,add_secure_port:1,added:[1,3,4],address:1,advanc:4,affect:1,afford:1,after:[1,4],again:1,all:[1,4],allot:1,allow:1,alreadi:1,already_exist:1,also:1,although:1,alwai:1,ani:[1,4],anoth:1,api:1,applic:[1,4],arbitrari:1,arbitrarili:1,arg:1,argument:[1,4],arriv:1,ascii:[0,1],assert:1,asynchron:1,attempt:1,attribut:1,auth:1,auth_context:1,authent:5,authmetadatacontext:1,authmetadataplugin:1,authmetadataplugincallback:1,author:[4,5],avail:[1,3],back:4,basic:1,bearer:1,becam:1,becaus:1,been:[1,4],befor:[1,4],begun:1,behavior:[1,4],behaviour:1,being:[1,4],belong:1,better:1,beyond:4,bin:0,binari:0,block:[1,4],bool:1,both:1,broken:1,busi:1,call:[1,4],call_at:4,call_credenti:1,call_in:4,callabl:5,callback:[1,4],callcredenti:1,caller:1,can:[0,1,4],cancel:[1,4],cannot:1,caus:4,certif:1,certificate_chain:1,certificate_configur:1,certificate_configuration_fetch:1,chain:1,chang:[1,4],channel:[4,5],channel_credenti:1,channel_ready_futur:1,channelconnect:1,channelcredenti:1,check:[1,3,5],choos:1,chosen:1,circumst:1,client:[4,5],client_call_detail:1,clientcalldetail:1,close:[1,4],code:[4,5],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:[4,5],consid:1,construct:1,content:5,context:5,continu:1,control:1,core:1,correspond:1,corrupt:1,could:1,creat:[4,5],credenti:5,current:[1,4],custom:1,data:1,data_loss:1,deadlin:1,deadline_exceed:1,debug:1,decid:1,decoupl:1,defin:[1,4],delai:4,deriv:1,describ:[1,4],descriptor:4,descriptor_pool:3,descriptorpool:3,descriptors_to_servic:4,deseri:1,detail:[1,4],determin:1,dictionari:[1,4],did:1,directli:1,directori:1,dive:1,doe:[1,4],done:1,doubl:4,draw:[1,4],due:1,durat:[1,4],dure:1,dynamic_ssl_server_credenti:1,each:1,effect:1,either:[0,1,4],emit:4,enabl:[1,3,4],enable_server_reflect:3,encapsul:1,encod:1,end:[0,1,4],ensur:4,enter:1,entir:1,entiti:1,entri:0,equival:1,error:1,etc:1,event:1,everi:1,exactli:1,exampl:5,except:5,execut:[1,4],exhaust:1,exist:1,exit:1,expect:1,experiment:1,expir:1,extens:1,failed_precondit:1,failur:1,fals:1,fetch:1,file:1,finish:1,first:[0,1],fixtur:4,flag:1,flow:1,form:1,format:1,forward:1,found:1,from:[1,4],fulli:[1,3],futur:[4,5],futurecancellederror:1,futuretimeouterror:1,gain:1,gener:[1,4],generic_rpc_handl:1,genericrpchandl:1,get:1,github:3,given:[1,4],glossari:5,goe:1,grace:1,grpc_connectivity_st:1,grpc_health:2,grpc_reflect:3,grpc_status_cod:1,grpc_test:4,hand:1,handl:[1,2,3],handler:5,handler_call_detail:1,handlercalldetail:1,handshak:1,has:[1,4],have:[1,4],header:[0,1],health:5,healthcheckrespons:2,healthservic:2,held:1,http:[0,1],idempot:1,ident:1,identifi:[1,4],idl:1,immedi:1,implement:[1,3,4],imposs:1,includ:0,incom:1,independ:4,index:5,indic:[1,2,4],infinit:1,inform:1,initi:[1,4],initial_certificate_configur:1,initial_metadata:[1,4],insecur:1,insecure_channel:1,instanc:[1,4],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:5,interfac:[4,5],intern:[1,4],interpret:4,invalid:1,invalid_argu:1,invari:1,invoc:[1,4],invocation_metadata:[1,4],invok:[1,4],invoke_stream_stream:4,invoke_stream_unari:4,invoke_unary_stream:4,invoke_unary_unari:4,is_act:[1,4],issu:1,iter:[1,3,4],its:[1,4],just:1,kei:[0,1],larger:1,last:1,later:1,least:1,length:[1,4],librari:1,like:1,limit:[1,4],list:1,live:4,locat:1,logic:1,lookup:1,loss:1,machin:1,made:4,mai:[1,4],maintain:4,make:1,manag:1,mani:1,manipul:[1,4],map:1,matur:1,maximum:1,maximum_concurrent_rpc:1,mean:1,mechan:1,mere:1,messag:[1,4],metadata:[0,1,4],metadata_call_credenti:1,metadata_plugin:1,metadatum:0,method:[4,5],method_descriptor:4,method_handl:1,method_handlers_generic_handl:1,method_nam:1,methoddescriptor:4,mirror:1,modul:5,monitor:1,more:[1,4],most:1,move:1,multi:5,multipl:1,must:[0,1,2],name:[0,1,2,3],need:1,needn:4,next:1,non:1,none:[1,3,4],nonneg:1,not_found:1,note:2,now:4,number:1,object:[3,4,5],observ:1,omit:1,onc:1,one:[1,4],ones:1,ongo:1,onli:[1,4],open:1,oper:1,opposit:1,option:1,order:[1,4],other:1,otherwis:1,out:[1,3],outcom:1,outgo:1,over:[1,4],page:5,pair:[0,1],paramet:[1,2,3,4],pass:1,passag:4,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:4,plugin:1,pool:3,port:1,previous:1,privat:1,private_kei:1,private_key_certificate_chain_pair:1,proce:1,produc:1,properti:1,provid:[0,1,4],python:[1,3,4],qualifi:[1,3],queri:4,quickstart:1,quota:1,rais:1,raw:1,readi:5,real:4,reason:1,receiv:1,recov:1,refer:3,reflect:5,reflectionservic:3,regist:[1,4],reject:1,relat:1,releas:[1,5],remain:1,replac:1,repres:1,represent:[1,4],request:[1,4],request_deseri:1,request_iter:1,request_seri:1,request_stream:1,requests_clos:4,requir:1,require_client_auth:1,require_client_authent:1,resourc:1,resource_exhaust:1,respect:4,respons:[1,4],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],rpccontext:[1,4],rpcerror:1,rpcmethodhandl:1,run:1,runtim:1,safe:1,same:[1,4],schedul:1,scope:1,search:5,second:[0,1,4],secur:1,secure_channel:1,see:1,seen:1,send:[1,4],send_initial_metadata:[1,4],send_request:4,send_respons:4,sent:[1,4],sequenc:[0,1,4],serial:1,server:[3,4,5],server_credenti:1,server_from_dictionari:4,servercertificateconfigur:1,servercredenti:1,serverinterceptor:1,servic:[2,3,4,5],service_descriptor:4,service_nam:[1,3],service_url:1,servicedescriptor:4,servicer_context:1,servicercontext:1,servicerpchandl:1,set:[1,2],set_cod:1,set_detail:1,set_trailing_metadata:1,setup:1,share:5,should:1,shutdown:1,side:5,signal:1,simul:4,singl:1,sleep_for:4,sleep_until:4,smaller:1,some:[1,4],sooner:1,sourc:[1,2,3,4],space:1,specif:[1,4],specifi:1,ssl:1,ssl_channel_credenti:1,ssl_server_certificate_configur:1,ssl_server_credenti:1,start:1,state:1,statu:[2,4,5],status:[2,3],statuscod:1,stop:1,str:0,stream:[1,4],stream_stream:1,stream_stream_channel_rpc:4,stream_stream_rpc_method_handl:1,stream_unari:1,stream_unary_channel_rpc:4,stream_unary_rpc_method_handl:1,streamstreamchannelrpc:4,streamstreamclientinterceptor:1,streamstreammultical:1,streamstreamserverrpc:4,streamunarychannelrpc:4,streamunaryclientinterceptor:1,streamunarymultical:1,streamunaryserverrpc:4,strict:4,strict_fake_tim:4,strict_real_tim:4,string:[1,2],structur:1,submit:4,subscrib:1,subscript:1,subsequ:1,success:[1,4],successfulli:1,suitabl:1,superced:1,support:1,synchron:1,synthes:4,system:[1,4],take:1,take_request:4,take_respons:4,take_stream_stream:4,take_stream_unari:4,take_unary_stream:4,take_unary_unari:4,taken:1,target:1,terim:1,termin:[1,4],test:5,thei:1,them:[1,4],thi:[1,3,4],those:4,thread:1,thread_pool:1,threadpoolexecutor:1,through:1,thu:1,time:[1,4],time_remain:[1,4],timeout:[1,4],token:1,traceback:1,track:1,trail:[1,4],trailing_metadata:[1,4],transact:1,transient_failur:1,transit:1,transmit:1,try_to_connect:1,tupl:[0,4],tutori:5,two:1,type:1,typeerror:1,typic:1,unari:[1,4],unary_stream:1,unary_stream_channel_rpc:4,unary_stream_rpc_method_handl:1,unary_unari:1,unary_unary_channel_rpc:4,unary_unary_rpc_method_handl:1,unarystreamchannelrpc:4,unarystreamclientinterceptor:1,unarystreammultical:1,unarystreamserverrpc:4,unaryunarychannelrpc:4,unaryunaryclientinterceptor:1,unaryunarymultical:1,unaryunaryserverrpc:4,unauthent:1,unavail:1,under:[1,4],underli:1,undeseri:1,unimpl:1,unknown:1,unrecover:1,unseri:1,unsubscrib:1,until:[1,4],upon:1,url:1,usag:1,use:[1,3,4],used:[1,4],user:[1,4],using:4,usual:4,util:1,v1alpha:3,valid:[0,1],valu:[0,1,2],verifi:1,version:5,via:1,visibl:1,visit:1,wait:1,wait_for_readi:1,want:1,what:[1,5],when:[1,4],where:[0,1],whether:1,which:[1,3,4],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,zero:1},titles:["Glossary","gRPC","gRPC Health Checking","gRPC Reflection","gRPC Testing","Welcome to gRPC Python\u2019s documentation!"],titleterms:{api:5,authent:1,author:1,callabl:1,channel:1,check:2,client:1,code:1,connect:1,content:[1,2,3,4],context:1,creat:1,credenti:1,document:5,exampl:[1,3],except:1,futur:1,glossari:0,grpc:[1,2,3,4,5],handler:1,health:2,indic:5,interceptor:1,interfac:1,method:1,modul:[1,2,3,4],multi:1,object:1,python:5,readi:1,refer:5,reflect:3,rpc:1,server:1,servic:1,share:1,side:1,statu:1,tabl:5,test:4,tutori:1,welcom:5,what:3}})
|