| 12345678910111213141516171819202122232425262728293031 |
- <html>
- <head>
- </head>
- <body style="background: transparent;">
- <script src="scripts/docstrap.lib.js"></script>
- <script src="scripts/lunr.min.js"></script>
- <script src="scripts/fulltext-search.js"></script>
- <script type="text/x-docstrap-searchdb">
- {"global.html":{"id":"global.html","title":"Global","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Global Methods CancelRequester(next) Parameters: Name Type Description next function Calls the next interceptor. CloseRequester(next) Parameters: Name Type Description next function Calls the next interceptor. createStatusError(status) Create an Error object from a status object Parameters: Name Type Description status grpc~StatusObject The status object Returns: The resulting Error Type Error getClientInterceptors(client) Gets a map of client method names to interceptor stacks. Parameters: Name Type Description client grpc.Client Returns: Type Object.<string, Array.<Interceptor>> getMethodType(method_definition) Get a method's type from its definition Parameters: Name Type Description method_definition grpc~MethodDefinition Returns: Type number GetPeerRequester(next) Parameters: Name Type Description next function Calls the next interceptor. Returns: Type string Interceptor(options, nextCall) A function which can modify call options and produce methods to intercept RPC operations. Parameters: Name Type Description options object The grpc call options nextCall NextCall Returns: Type InterceptingCall InterceptorProvider(method_definition) A function for dynamically assigning an interceptor to a call. Parameters: Name Type Description method_definition grpc~MethodDefinition The method to provide an interceptor for. Returns: The interceptor to provide or nothing Type Interceptor | null loadPackageDefinition(packageDef) Load a gRPC package definition as a gRPC object hierarchy Parameters: Name Type Description packageDef grpc~PackageDefinition The package definition object Returns: The resulting gRPC object Type Object.<string, *> MessageListener(message, next) Parameters: Name Type Description message jspb.Message The response message. next function Passes a message to the next interceptor. MessageRequester(message, next) Parameters: Name Type Description message jspb.Message The request message. next function Passes a message to the next interceptor. MetadataListener(metadata, next) Parameters: Name Type Description metadata grpc.Metadata The response metadata. next function Passes metadata to the next interceptor. MetadataRequester(metadata, listener, next) Parameters: Name Type Description metadata grpc.Metadata The request metadata. listener grpc~Listener A listener wired to the previous layers in the interceptor stack. next function Passes metadata and a listener to the next interceptor. NextCall(options) A function which produces the next InterceptingCall. Parameters: Name Type Description options object The grpc call options Returns: Type InterceptingCall | null StatusListener(status, next) Parameters: Name Type Description status grpc~StatusObject The response status. next function Passes a status to the next interceptor. × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"modules.list.html":{"id":"modules.list.html","title":"Modules","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Modules Classes Channel Client CallCredentials ChannelCredentials Metadata Server ServerCredentials Call ClientDuplexStream ClientReadableStream ClientUnaryCall ClientWritableStream ServerDuplexStream ServerReadableStream ServerUnaryCall ServerWritableStream EndListener InterceptingCall InterceptingListener InterceptorConfigurationError ListenerBuilder RequesterBuilder StatusBuilder Namespaces grpc credentials Events metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Classes Classes Channel Client CallCredentials ChannelCredentials Metadata Server ServerCredentials Call ClientDuplexStream ClientReadableStream ClientUnaryCall ClientWritableStream ServerDuplexStream ServerReadableStream ServerUnaryCall ServerWritableStream EndListener InterceptingCall InterceptingListener InterceptorConfigurationError ListenerBuilder RequesterBuilder StatusBuilder Namespaces grpc credentials Events metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"namespaces.list.html":{"id":"namespaces.list.html","title":"Namespaces","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Namespaces Classes Channel Client CallCredentials ChannelCredentials Metadata Server ServerCredentials Call ClientDuplexStream ClientReadableStream ClientUnaryCall ClientWritableStream ServerDuplexStream ServerReadableStream ServerUnaryCall ServerWritableStream EndListener InterceptingCall InterceptingListener InterceptorConfigurationError ListenerBuilder RequesterBuilder StatusBuilder Namespaces grpc credentials Events metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"externals.list.html":{"id":"externals.list.html","title":"Externals","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Externals Classes Channel Client CallCredentials ChannelCredentials Metadata Server ServerCredentials Call ClientDuplexStream ClientReadableStream ClientUnaryCall ClientWritableStream ServerDuplexStream ServerReadableStream ServerUnaryCall ServerWritableStream EndListener InterceptingCall InterceptingListener InterceptorConfigurationError ListenerBuilder RequesterBuilder StatusBuilder Namespaces grpc credentials Events metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Node.js gRPC LibraryPREREQUISITES node: This requires node to be installed, version 4.0 or above. If you instead have the nodejs executable on Debian, you should install the nodejs-legacy package. Note: If you installed node via a package manager and the version is still less than 4.0, try directly installing it from nodejs.org. INSTALLATIONInstall the gRPC NPM package npm install grpcBUILD FROM SOURCEThe following command can be used to build from source when installing the package from npm: npm install grpc --build-from-sourceThe --build-from-source option will work even when installing another package that depends on grpc. To build only grpc from source, you can use the argument --build-from-source=grpc. ABOUT ELECTRONThe official electron documentation recommends to build all of your native packages from source. While the reasons behind this are technically good - many native extensions won't be packaged to work properly with electron - the gRPC source code is fairly difficult to build from source due to its complex nature, and we're also providing working electron pre-built binaries. Therefore, we recommend that you do not follow this model for using gRPC with electron. Also, for the same reason, electron-rebuild will always build from source. We advise you to not use this tool if you are depending on gRPC. Please note that there's not just one way to get native extensions running in electron, and that there's never any silver bullet for anything. The following instructions try to cater about some of the most generic ways, but different edge cases might require different methodologies. The best to get gRPC to work with electron is to do this, possibly in your postinstall script of your package.json file: npm rebuild --target=2.0.0 --runtime=electron --dist-url=https://atom.io/download/electronNote that the 2.0.0 above is the electron runtime version number. You will need to update this every time you go on a different version of the runtime. If you have more native dependencies than gRPC, and they work better when built from source, you can explicitely specify which extension to build the following way: npm rebuild --build-from-source=sqlite3 --target=2.0.0 --runtime=electron --dist-url=https://atom.io/download/electronThis way, if you depend on both grpc and sqlite3, only the sqlite3 package will be rebuilt from source, leaving the grpc package to use its precompiled binaries. BUILD IN GIT REPOSITORY Clone the grpc-node Git Repository. Run git submodule update --init --recursive from the repository root. Run cd packages/grpc-native-core. Run npm install --build-from-source. Note: On Windows, this might fail due to nodejs issue #4932 in which case, you will see something like the following in npm install's output (towards the very beginning): .. Building the projects in this solution one at a time. To enable parallel build, please add the "/m" switch. WINDOWS_BUILD_WARNING "..\\IMPORTANT: Due to https:\\github.com\\nodejs\\node\\issues\\4932, to build this library on Windows, you must first remove C:\\Users\\jenkins\\.node-gyp\\4.4.0\\include\\node\\openssl" ... .. To fix this, you will have to delete the folder C:\\Users\\<username>\\.node-gyp\\<node_version>\\include\\node\\openssl and retry npm install CONFIGURE BINARIES' LOCATIONYou can configure the location from which the pre-compiled binaries are downloaded during installation. npm install --grpc_node_binary_host_mirror=https://your-url.com Or defining grpc_node_binary_host_mirror in your .npmrc. API DOCUMENTATIONSee the API Documentation. TESTINGTo run the test suite, simply run npm test in the install location. × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"external-Duplex.html":{"id":"external-Duplex.html","title":"External: Duplex","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable External: Duplex Duplex The Duplex class in the stream standard module See: https://nodejs.org/api/stream.html#stream_class_stream_duplex × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"external-EventEmitter.html":{"id":"external-EventEmitter.html","title":"External: EventEmitter","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable External: EventEmitter EventEmitter The EventEmitter class in the event standard module See: https://nodejs.org/api/events.html#events_class_eventemitter × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"external-GoogleCredential.html":{"id":"external-GoogleCredential.html","title":"External: GoogleCredential","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable External: GoogleCredential GoogleCredential See: https://github.com/google/google-auth-library-nodejs × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"external-Readable.html":{"id":"external-Readable.html","title":"External: Readable","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable External: Readable Readable The Readable class in the stream standard module See: https://nodejs.org/api/stream.html#stream_readable_streams × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"external-Writable.html":{"id":"external-Writable.html","title":"External: Writable","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable External: Writable Writable The Writable class in the stream standard module See: https://nodejs.org/api/stream.html#stream_writable_streams × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc.html":{"id":"grpc.html","title":"Namespace: grpc","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Namespace: grpc grpc Classes Channel Client Metadata Server ServerCredentials Call ClientDuplexStream ClientReadableStream ClientUnaryCall ClientWritableStream ServerDuplexStream ServerReadableStream ServerUnaryCall ServerWritableStream Namespaces credentials Members <static, constant> callError :number Call error constants. Call errors almost always indicate bugs in the gRPC library, and these error codes are mainly useful for finding those bugs. Type: number Properties: Name Type Default Description OK number 0 ERROR number 1 NOT_ON_SERVER number 2 NOT_ON_CLIENT number 3 ALREADY_INVOKED number 5 NOT_INVOKED number 6 ALREADY_FINISHED number 7 TOO_MANY_OPERATIONS number 8 INVALID_FLAGS number 9 INVALID_METADATA number 10 INVALID_MESSAGE number 11 NOT_SERVER_COMPLETION_QUEUE number 12 BATCH_TOO_BIG number 13 PAYLOAD_TYPE_MISMATCH number 14 <static, readonly> connectivityState :number Connectivity state values Type: number Properties: Name Type Default Description IDLE number 0 CONNECTING number 1 READY number 2 TRANSIENT_FAILURE number 3 SHUTDOWN number 4 <static> load Load a gRPC object from a .proto file. Deprecated: Use the proto-loader module with grpc.loadPackageDefinition instead. <static, readonly> logVerbosity :number Type: number Properties: Name Type Default Description DEBUG number 0 INFO number 1 ERROR number 2 <static, readonly> methodTypes :number Method types: the supported RPC types Type: number Properties: Name Type Default Description UNARY number 0 CLIENT_STREAMING number 1 SERVER_STREAMING number 2 BIDI_STREAMING number 3 <static> propagate :number Propagation flags: these can be bitwise or-ed to form the propagation option for calls. Users are encouraged to write propagation masks as deltas from the default. i.e. write grpc.propagate.DEFAULTS & ~grpc.propagate.DEADLINE to disable deadline propagation. Type: number Properties: Name Type Default Description DEADLINE number 1 CENSUS_STATS_CONTEXT number 2 CENSUS_TRACING_CONTEXT number 4 CANCELLATION number 8 DEFAULTS number 65535 <static, readonly> status :number Enum of status codes that gRPC can return Type: number Properties: Name Type Default Description OK number 0 Not an error; returned on success CANCELLED number 1 The operation was cancelled (typically by the caller). UNKNOWN number 2 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. INVALID_ARGUMENT number 3 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). DEADLINE_EXCEEDED number 4 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. NOT_FOUND number 5 Some requested entity (e.g., file or directory) was not found. ALREADY_EXISTS number 6 Some entity that we attempted to create (e.g., file or directory) already exists. PERMISSION_DENIED number 7 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). RESOURCE_EXHAUSTED number 8 Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. FAILED_PRECONDITION number 9 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. A litmus test that may help a service implementor in deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE: Use UNAVAILABLE if the client can retry just the failing call. Use ABORTED if the client should retry at a higher-level (e.g., restarting a read-modify-write sequence). 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. 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. ABORTED number 10 The operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc. See litmus test above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE. OUT_OF_RANGE number 11 Operation was attempted past the valid range. E.g., seeking or reading past end of file. 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. 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. UNIMPLEMENTED number 12 Operation is not implemented or not supported/enabled in this service. INTERNAL number 13 Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. UNAVAILABLE number 14 The service is currently unavailable. This is a most likely a transient condition and may be corrected by retrying with a backoff. See litmus test above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE. DATA_LOSS number 15 Unrecoverable data loss or corruption. UNAUTHENTICATED number 16 The request does not have valid authentication credentials for the operation. <static, readonly> writeFlags :number Write flags: these can be bitwise or-ed to form write options that modify how data is written. Type: number Properties: Name Type Default Description BUFFER_HINT number 1 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. NO_COMPRESS number 2 Force compression to be disabled for a particular write <inner> defaultLoadOptions Default options for loading proto files into gRPC Methods <static> closeClient(client_obj) Parameters: Name Type Description client_obj grpc.Client The client to close <static> loadObject(value [, options]) Load a ProtoBuf.js object as a gRPC object. Parameters: Name Type Argument Description value Object The ProtoBuf.js reflection object to load options Object <optional> Options to apply to the loaded file Properties Name Type Argument Default Description binaryAsBase64 bool <optional> false deserialize bytes values as base64 strings instead of Buffers longsAsStrings bool <optional> true deserialize long values as strings instead of objects enumsAsStrings bool <optional> true deserialize enum values as strings instead of numbers. Only works with Protobuf.js 6 values. deprecatedArgumentOrder bool <optional> false 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. protobufjsVersion number | string <optional> 'detect' 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. Returns: The resulting gRPC object. Type Object.<string, *> <static> setLogger(logger) 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. Parameters: Name Type Description logger Console A Console-like object. <static> setLogVerbosity(verbosity) Sets the logger verbosity for gRPC module logging. The options are members of the grpc.logVerbosity map. Parameters: Name Type Description verbosity Number The minimum severity to log <inner> getClientChannel(client) Return the underlying channel object for the specified client Parameters: Name Type Description client grpc.Client The client See: grpc.Client#getChannel Returns: The channel Type Channel <inner> makeGenericClientConstructor(methods, serviceName, class_options) 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 Client request methods, depending on requestSerialize and responseSerialize, with the method, serialize, and deserialize arguments predefined. Parameters: Name Type Description methods grpc~ServiceDefinition An object mapping method names to method attributes serviceName string The fully qualified name of the service class_options Object An options object. Properties Name Type Argument Default Description deprecatedArgumentOrder boolean <optional> false 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. Returns: New client constructor, which is a subclass of grpc.Client, and has the same arguments as that constructor. Type function <inner> waitForClientReady(client, deadline, callback) 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. Parameters: Name Type Description client grpc.Client The client to wait on deadline grpc~Deadline When to stop waiting for a connection. Pass Infinity to wait forever. callback function The callback to call when done attempting to connect. See: grpc.Client#waitForReady Type Definitions ChannelOptions Type: Object.<string, (string|number)> CoreMetadata Metadata representation as passed to and the native addon Type: object Deadline 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. Type: number | Date deserialize(data) A deserialization function Parameters: Name Type Description data Buffer The byte sequence to deserialize Returns: The data deserialized as a value Type * Listener A set of interceptor functions triggered by responses Type: object Properties: Name Type Argument Description onReceiveMetadata MetadataListener <optional> A function triggered by response metadata. onReceiveMessage MessageListener <optional> A function triggered by a response message. onReceiveStatus StatusListener <optional> A function triggered by a response status. MethodDefinition An object that completely defines a service method signature. Type: Object Properties: Name Type Description path string The method's URL path requestStream boolean Indicates whether the method accepts a stream of requests responseStream boolean Indicates whether the method returns a stream of responses requestSerialize grpc~serialize Serialization function for request values responseSerialize grpc~serialize Serialization function for response values requestDeserialize grpc~deserialize Deserialization function for request data responseDeserialize grpc~deserialize Deserialization function for repsonse data PackageDefinition An object that defines a package hierarchy with multiple services Type: Object.<string, (grpc~ServiceDefinition|grpc~ProtobufTypeDefinition)> ProtobufTypeDefinition An object that defines a protobuf type Type: object Requester Type: object serialize(value) A serialization function Parameters: Name Type Description value * The value to serialize Returns: The value serialized as a byte sequence Type Buffer ServiceDefinition An object that completely defines a service. Type: Object.<string, grpc~MethodDefinition> ServiceError Describes how a request has failed. The member message will be the same as details in grpc~StatusObject, and code and metadata are the same as in that object. Type: Error Properties: Name Type Description code number The error code, a key of grpc.status that is not grpc.status.OK metadata grpc.Metadata Trailing metadata sent with the status, if applicable StatusObject Represents the status of a completed request. If code is grpc.status.OK, then the request has completed successfully. Otherwise, the request has failed, details will contain a description of the error. Either way, metadata contains the trailing response metadata sent by the server when it finishes processing the call. Type: object Properties: Name Type Description code number The error code, a key of grpc.status details string Human-readable description of the status metadata grpc.Metadata Trailing metadata sent with the status, if applicable × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc.Channel.html":{"id":"grpc.Channel.html","title":"Class: Channel","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: Channel grpc. Channel new Channel(target, credentials, options) This constructor API is almost identical to the Client constructor, except that some of the options for the Client constructor are not valid here. Parameters: Name Type Description target string The address of the server to connect to credentials grpc.ChannelCredentials Channel credentials to use when connecting options grpc~ChannelOptions A map of channel options that will be passed to the core. The available options are listed in this document. Methods close() Close the channel. This has the same functionality as the existing grpc.Client#close createCall(method, deadline, host, parentCall, propagateFlags) Create a call object. Call is an opaque type used by the grpc.Client and grpc.Server classes. This function is called by the gRPC library when starting a request. Implementers should return an instance of Call that is returned from calling createCall on an instance of the provided Channel class. Parameters: Name Type Description method string The full method string to request deadline grpc~Deadline The call deadline host string | null A host string override for making the request parentCall grpc~Call | null A server call to propagate some information from propagateFlags number | null A bitwise combination of elements of grpc.propagate that indicates what information to propagate from parentCall Returns: Type grpc~Call getConnectivityState(tryToConnect) Get the channel's current connectivity state. Parameters: Name Type Description tryToConnect boolean If true, the channel will start connecting if it is idle. Otherwise, idle channels will only start connecting when a call starts. Returns: The current connectivity state Type grpc.connectivityState getTarget() Return the target that this channel connects to Returns: The target Type string watchConnectivityState(currentState, deadline, callback) Watch for connectivity state changes. Parameters: Name Type Description currentState grpc.ConnectivityState The state to watch for transitions from. This should always be populated by calling getConnectivityState immediately before. deadline grpc~Deadline A deadline for waiting for a state change callback grpc.Channel~watchConnectivityStateCallback Called with no error when the state changes, or with an error if the deadline passes without a state change Type Definitions watchConnectivityStateCallback(error) Parameters: Name Type Argument Description error Error <nullable> × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc.Client.html":{"id":"grpc.Client.html","title":"Class: Client","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: Client grpc. Client new Client(address, credentials, options) A generic gRPC client. Primarily useful as a base class for generated clients Parameters: Name Type Description address string Server address to connect to credentials grpc.credentials~ChannelCredentials Credentials to use to connect to the server options Object Options to apply to channel creation. Any of the channel arguments can be used here in addition to specific client options. Properties Name Type Argument Description interceptors Array.<grpc~Interceptor> <optional> Interceptors to apply to each request interceptor_providers Array.<grpc~InterceptorProvider> <optional> Interceptor providers to apply interceptors to each request depending on the method definition. At most one of the interceptors and interceptor_providers options may be set. callInvocationTransformer grpc.Client~callInvocationTransformer <optional> channelOverride grpc.Channel <optional> Channel to use instead of constructing a new one. If set, the address, credentials, channel arguments options, and channelFactoryOverride option will all be ignored. channelFactoryOverride grpc.Client~channelFactory Function to use instead of the Channel constructor when creating the Client's channel. Methods close() Close this client. getChannel() Return the underlying channel object for the specified client Returns: The channel Type Channel makeBidiStreamRequest(path, serialize, deserialize [, metadata] [, options]) Make a bidirectional stream request with this method on the given channel. Parameters: Name Type Argument Description path string The path of the method to request serialize grpc~serialize The serialization function for inputs deserialize grpc~deserialize The deserialization function for outputs metadata grpc.Metadata <optional> Array of metadata key/value pairs to add to the call options grpc.Client~CallOptions <optional> Options map Returns: An event emitter for stream related events Type grpc~ClientDuplexStream makeClientStreamRequest(path, serialize, deserialize [, metadata] [, options], callback) Make a client stream request to the given method, using the given serialize and deserialize functions, with the given argument. Parameters: Name Type Argument Description path string The path of the method to request serialize grpc~serialize The serialization function for inputs deserialize grpc~deserialize The deserialization function for outputs metadata grpc.Metadata <optional> Array of metadata key/value pairs to add to the call options grpc.Client~CallOptions <optional> Options map callback grpc.Client~requestCallback The callback for when the response is received Returns: An event emitter for stream related events Type grpc~ClientWritableStream makeServerStreamRequest(path, serialize, deserialize, argument [, metadata] [, options]) Make a server stream request to the given method, with the given serialize and deserialize function, using the given argument Parameters: Name Type Argument Description path string The path of the method to request serialize grpc~serialize The serialization function for inputs deserialize grpc~deserialize The deserialization function for outputs argument * The argument to the call. Should be serializable with serialize metadata grpc.Metadata <optional> Array of metadata key/value pairs to add to the call options grpc.Client~CallOptions <optional> Options map Returns: An event emitter for stream related events Type grpc~ClientReadableStream makeUnaryRequest(path, serialize, deserialize, argument [, metadata] [, options], callback) Make a unary request to the given method, using the given serialize and deserialize functions, with the given argument. Parameters: Name Type Argument Description path string The path of the method to request serialize grpc~serialize The serialization function for inputs deserialize grpc~deserialize The deserialization function for outputs argument * The argument to the call. Should be serializable with serialize metadata grpc.Metadata <optional> Metadata to add to the call options grpc.Client~CallOptions <optional> Options map callback grpc.Client~requestCallback The callback for when the response is received Returns: An event emitter for stream related events Type grpc~ClientUnaryCall waitForReady(deadline, callback) 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. Parameters: Name Type Description deadline grpc~Deadline When to stop waiting for a connection. callback function The callback to call when done attempting to connect. <inner> callInvocationTransformer(callProperties) Call invocation transformer. Has access to the full call properties before a call is processed and can modify most of those properties. Some modifications will have no effect or may cause problems. Parameters: Name Type Description callProperties grpc.Client~CallProperties The original call properties Returns: The modified call properties. Type grpc.Client~CallProperties <inner> channelFactory(target, credentials, options) A function that functionally replaces the Channel constructor. Parameters: Name Type Description target string The address of the server to connect to credentials grpc.ChannelCredentials Channel credentials to use when connecting options grpc~ChannelOptions A map of channel options that will be passed to the core. The available options are listed in this document. Returns: This can either be an actual channel object, or an object with the same API. Type grpc.Channel Type Definitions Call Any client call type Type: grpc~ClientUnaryCall | grpc~ClientReadableStream | grpc~ClientWritableStream | grpc~ClientDuplexStream CallOptions Options that can be set on a call. Type: Object Properties: Name Type Description deadline grpc~Deadline The deadline for the entire call to complete. host string Server hostname to set on the call. Only meaningful if different from the server address used to construct the client. parent grpc.Client~Call Parent call. Used in servers when making a call as part of the process of handling a call. Used to propagate some information automatically, as specified by propagate_flags. propagate_flags number Indicates which properties of a parent call should propagate to this call. Bitwise combination of flags in grpc.propagate. credentials grpc.credentials~CallCredentials The credentials that should be used to make this particular call. CallProperties Properties of a call, for use with a grpc.Client~callInvocationTransformer. Type: Object Properties: Name Type Description argument * The call argument. Only preset if the method is unary or server streaming. metadata grpc.Metadata The request metadata call grpc~Call The call object that will be returned by the client method channel grpc.Channel The channel that will be used to make a request methodDefinition grpc~MethodDefinition The MethodDefinition object that describes this method options grpc.Client~CallOptions The call options passed when making this request callback grpc.Client~requestCallback The callback that will handle the response. Only present if this method is unary or client streaming. requestCallback(error, value) Parameters: Name Type Argument Description error grpc~ServiceError <nullable> The error, if the call failed value * The response value, if the call succeeded × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc.credentials.html":{"id":"grpc.credentials.html","title":"Namespace: credentials","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Namespace: credentials grpc. credentials Credentials module This module contains factory methods for two different credential types: CallCredentials and ChannelCredentials. ChannelCredentials are things like SSL credentials that can be used to secure a connection, and are used to construct a Client object. CallCredentials genrally modify metadata, so they can be attached to an individual method call. CallCredentials can be composed with other CallCredentials to create CallCredentials. ChannelCredentials can be composed with CallCredentials to create ChannelCredentials. No combined credential can have more than one ChannelCredentials. For example, to create a client secured with SSL that uses Google default application credentials to authenticate: Example var channel_creds = credentials.createSsl(root_certs); (new GoogleAuth()).getApplicationDefault(function(err, credential) { var call_creds = credentials.createFromGoogleCredential(credential); var combined_creds = credentials.combineChannelCredentials( channel_creds, call_creds); var client = new Client(address, combined_creds); }); Classes CallCredentials ChannelCredentials Methods <static> combineCallCredentials(credentials) Combine any number of CallCredentials into a single CallCredentials object Parameters: Name Type Argument Description credentials grpc.credentials~CallCredentials <repeatable> The CallCredentials to compose Returns: A credentials object that combines all of the input credentials Type grpc.credentials~CallCredentials <static> combineChannelCredentials(channel_credential, credentials) Combine a ChannelCredentials with any number of CallCredentials into a single ChannelCredentials object. Parameters: Name Type Argument Description channel_credential grpc.credentials~ChannelCredentials The ChannelCredentials to start with credentials grpc.credentials~CallCredentials <repeatable> The CallCredentials to compose Returns: A credentials object that combines all of the input credentials Type grpc.credentials~ChannelCredentials <static> createFromGoogleCredential(google_credential) Create a gRPC credential from a Google credential object. Parameters: Name Type Description google_credential external:GoogleCredential The Google credential object to use Returns: The resulting credentials object Type grpc.credentials~CallCredentials <static> createFromMetadataGenerator(metadata_generator) Create a gRPC credentials object from a metadata generation function. This function gets the service URL and a callback as parameters. The error passed to the callback can optionally have a 'code' value attached to it, which corresponds to a status code that this library uses. Parameters: Name Type Description metadata_generator grpc.credentials~generateMetadata The function that generates metadata Returns: The credentials object Type grpc.credentials~CallCredentials <static> createInsecure() Create an insecure credentials object. This is used to create a channel that does not use SSL. This cannot be composed with anything. Returns: The insecure credentials object Type grpc.credentials~ChannelCredentials <static> createSsl( [root_certs] [, private_key] [, cert_chain]) Create an SSL Credentials object. If using a client-side certificate, both the second and third arguments must be passed. Additional peer verification options can be passed in the fourth argument as described below. Parameters: Name Type Argument Description root_certs Buffer <optional> The root certificate data private_key Buffer <optional> The client certificate private key, if applicable cert_chain Buffer <optional> The client certificate cert chain, if applicable verify_options.checkServerIdentity function Optional callback receiving the expected hostname and peer certificate for additional verification. The callback should return an Error if verification fails and otherwise return undefined. Returns: The SSL Credentials object Type grpc.credentials~ChannelCredentials Type Definitions generateMetadata(params, callback) Parameters: Name Type Description params Object Parameters that can modify metadata generation Properties Name Type Description service_url string The URL of the service that the call is going to callback grpc.credentials~metadataCallback metadataCallback(error, metadata) Parameters: Name Type Description error Error The error, if getting metadata failed metadata grpc.Metadata The metadata × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc.credentials-CallCredentials.html":{"id":"grpc.credentials-CallCredentials.html","title":"Class: CallCredentials","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: CallCredentials grpc.credentials~ CallCredentials new CallCredentials() This cannot be constructed directly. Instead, instances of this class should be created using the factory functions in grpc.credentials × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc.credentials-ChannelCredentials.html":{"id":"grpc.credentials-ChannelCredentials.html","title":"Class: ChannelCredentials","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: ChannelCredentials grpc.credentials~ ChannelCredentials new ChannelCredentials() This cannot be constructed directly. Instead, instances of this class should be created using the factory functions in grpc.credentials × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc.Metadata.html":{"id":"grpc.Metadata.html","title":"Class: Metadata","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: Metadata grpc. Metadata new Metadata( [options]) Class for storing metadata. Keys are normalized to lowercase ASCII. Parameters: Name Type Argument Description options Object <optional> Boolean options for the beginning of the call. These options only have any effect when passed at the beginning of a client request. Properties Name Type Argument Default Description idempotentRequest boolean <optional> false Signal that the request is idempotent waitForReady boolean <optional> true Signal that the call should not return UNAVAILABLE before it has started. cacheableRequest boolean <optional> false Signal that the call is cacheable. GRPC is free to use GET verb. corked boolean <optional> false Signal that the initial metadata should be corked. Example var metadata = new metadata_module.Metadata(); metadata.set('key1', 'value1'); metadata.add('key1', 'value2'); metadata.get('key1') // returns ['value1', 'value2'] Methods add(key, value) Adds the given value for the given key. Normalizes the key. Parameters: Name Type Description key String The key to add to. value String | Buffer The value to add. Must be a buffer if and only if the normalized key ends with '-bin' clone() Clone the metadata object. Returns: The new cloned object Type grpc.Metadata get(key) Gets a list of all values associated with the key. Normalizes the key. Parameters: Name Type Description key String The key to get Returns: The values associated with that key Type Array.<(String|Buffer)> getMap() Get a map of each key to a single associated value. This reflects the most common way that people will want to see metadata. Returns: A key/value mapping of the metadata Type Object.<String, (String|Buffer)> remove(key) Remove the given key and any associated values. Normalizes the key. Parameters: Name Type Description key String The key to remove set(key, value) Sets the given value for the given key, replacing any other values associated with that key. Normalizes the key. Parameters: Name Type Description key String The key to set value String | Buffer The value to set. Must be a buffer if and only if the normalized key ends with '-bin' setOptions(options) Set options on the metadata object Parameters: Name Type Description options Object Boolean options for the beginning of the call. These options only have any effect when passed at the beginning of a client request. Properties Name Type Argument Default Description idempotentRequest boolean <optional> false Signal that the request is idempotent waitForReady boolean <optional> true Signal that the call should not return UNAVAILABLE before it has started. cacheableRequest boolean <optional> false Signal that the call is cacheable. GRPC is free to use GET verb. corked boolean <optional> false Signal that the initial metadata should be corked. × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc.Server.html":{"id":"grpc.Server.html","title":"Class: Server","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: Server grpc. Server new Server( [options]) Constructs a server object that stores request handlers and delegates incoming requests to those handlers Parameters: Name Type Argument Description options Object <optional> Options that should be passed to the internal server implementation. The available options are listed in this document. Example var server = new grpc.Server(); server.addProtoService(protobuf_service_descriptor, service_implementation); server.bind('address:port', server_credential); server.start(); Members addProtoService Add a proto service to the server, with a corresponding implementation Deprecated: Use grpc.Server#addService instead Methods addService(service, implementation) Add a service to the server, with a corresponding implementation. Parameters: Name Type Description service grpc~ServiceDefinition The service descriptor implementation Object.<String, grpc.Server~handleCall> Map of method names to method implementation for the provided service. bind(port, creds) Binds the server to the given port, with SSL disabled if creds is an insecure credentials object Parameters: Name Type Description port string The port that the server should bind on, in the format "address:port" creds grpc.ServerCredentials Server credential object to be used for SSL. Pass an insecure credentials object for an insecure port. Returns: The bound port number. Negative if binding the port failed. Type number bindAsync(port, creds) Binds the server to the given port, with SSL disabled if creds is an insecure credentials object. Provides the result asynchronously. Parameters: Name Type Description port string The port that the server should bind on, in the format "address:port" creds grpc.ServerCredentials Server credential object to be used for SSL. Pass an insecure credentials object for an insecure port. forceShutdown() Forcibly shuts down the server. The server will stop receiving new calls and cancel all pending calls. When it returns, the server has shut down. This method is idempotent with itself and tryShutdown, and it will trigger any outstanding tryShutdown callbacks. register(name, handler, serialize, deserialize, type) Registers a handler to handle the named method. Fails if there already is a handler for the given method. Returns true on success Parameters: Name Type Description name string The name of the method that the provided function should handle/respond to. handler grpc.Server~handleCall Function that takes a stream of request values and returns a stream of response values serialize grpc~serialize Serialization function for responses deserialize grpc~deserialize Deserialization function for requests type 'unary' | 'client_stream' | 'server_stream' | 'bidi' The streaming type of method that this handles Returns: True if the handler was set. False if a handler was already set for that name. Type boolean start() Start the server and begin handling requests tryShutdown(callback) Gracefully shuts down the server. The server will stop receiving new calls, and any pending calls will complete. The callback will be called when all pending calls have completed and the server is fully shut down. This method is idempotent with itself and forceShutdown. Parameters: Name Type Description callback function The shutdown complete callback Type Definitions bindCallback( [error], port) Called with the result of attempting to bind a port Parameters: Name Type Argument Description error Error <optional> If non-null, indicates that binding the port failed. port number The bound port number. If binding the port fails, this will be negative to match the output of bind. handleBidiStreamingCall(call) User provided method to handle bidirectional streaming calls on the server. Parameters: Name Type Description call grpc~ServerDuplexStream The call object handleCall Unified type for application handlers for all types of calls Type: grpc.Server~handleUnaryCall | grpc.Server~handleClientStreamingCall | grpc.Server~handleServerStreamingCall | grpc.Server~handleBidiStreamingCall handleClientStreamingCall(call, callback) User provided method to handle client streaming methods on the server. Parameters: Name Type Description call grpc~ServerReadableStream The call object callback grpc.Server~sendUnaryData The callback to call to respond to the request handleServerStreamingCall(call) User provided method to handle server streaming methods on the server. Parameters: Name Type Description call grpc~ServerWritableStream The call object handleUnaryCall(call, callback) User-provided method to handle unary requests on a server Parameters: Name Type Description call grpc~ServerUnaryCall The call object callback grpc.Server~sendUnaryData The callback to call to respond to the request sendUnaryData(error, value [, trailer] [, flags]) Callback function passed to server handlers that handle methods with unary responses. Parameters: Name Type Argument Description error grpc~ServiceError An error, if the call failed value * The response value. Must be a valid argument to the responseSerialize method of the method that is being handled trailer grpc.Metadata <optional> Trailing metadata to send, if applicable flags grpc.writeFlags <optional> Flags to modify writing the response × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc.ServerCredentials.html":{"id":"grpc.ServerCredentials.html","title":"Class: ServerCredentials","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: ServerCredentials grpc. ServerCredentials new ServerCredentials() ServerCredentials factories Methods <static> createInsecure() Create insecure server credentials Returns: Type grpc.ServerCredentials <static> createSsl(rootCerts, keyCertPairs [, checkClientCertificate]) Create SSL server credentials Parameters: Name Type Argument Default Description rootCerts Buffer <nullable> Root CA certificates for validating client certificates keyCertPairs Array.<grpc.ServerCredentials~keyCertPair> A list of private key and certificate chain pairs to be used for authenticating the server checkClientCertificate boolean <optional> false Indicates that the server should request and verify the client's certificates Returns: Type grpc.ServerCredentials Type Definitions keyCertPair A private key and certificate pair Type: Object Properties: Name Type Description private_key Buffer The server's private key cert_chain Buffer The server's certificate chain × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc-Call.html":{"id":"grpc-Call.html","title":"Class: Call","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: Call grpc~ Call new Call() × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc-ClientDuplexStream.html":{"id":"grpc-ClientDuplexStream.html","title":"Class: ClientDuplexStream","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: ClientDuplexStream grpc~ ClientDuplexStream new ClientDuplexStream(call) A stream that the client can read from or write to. Used for calls with duplex streaming. Parameters: Name Type Description call InterceptingCall Exposes gRPC request operations, processed by an interceptor stack. Extends external:Duplex Methods cancel() Cancel the ongoing call. Results in the call ending with a CANCELLED status, unless it has already ended with some other status. getPeer() Get the endpoint this call/stream is connected to. Returns: The URI of the endpoint Type string write(message, flags, callback) Write a message to the request stream. If serializing the argument fails, the call will be cancelled and the stream will end with an error. Parameters: Name Type Description message * The message to write. Must be a valid argument to the serialize function of the corresponding method flags grpc.writeFlags Flags to modify how the message is written callback function Callback for when this chunk of data is flushed Returns: As defined for Writable Type boolean Events metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc-ClientReadableStream.html":{"id":"grpc-ClientReadableStream.html","title":"Class: ClientReadableStream","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: ClientReadableStream grpc~ ClientReadableStream new ClientReadableStream(call) A stream that the client can read from. Used for calls that are streaming from the server side. Parameters: Name Type Description call InterceptingCall Exposes gRPC request operations, processed by an interceptor stack. Extends external:Readable Methods cancel() Cancel the ongoing call. Results in the call ending with a CANCELLED status, unless it has already ended with some other status. getPeer() Get the endpoint this call/stream is connected to. Returns: The URI of the endpoint Type string Events metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc-ClientUnaryCall.html":{"id":"grpc-ClientUnaryCall.html","title":"Class: ClientUnaryCall","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: ClientUnaryCall grpc~ ClientUnaryCall new ClientUnaryCall(call) An EventEmitter. Used for unary calls. Parameters: Name Type Description call grpc.internal~Call The call object associated with the request Extends external:EventEmitter Methods cancel() Cancel the ongoing call. Results in the call ending with a CANCELLED status, unless it has already ended with some other status. getPeer() Get the endpoint this call/stream is connected to. Returns: The URI of the endpoint Type string Events metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc-ClientWritableStream.html":{"id":"grpc-ClientWritableStream.html","title":"Class: ClientWritableStream","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: ClientWritableStream grpc~ ClientWritableStream new ClientWritableStream(call) A stream that the client can write to. Used for calls that are streaming from the client side. Parameters: Name Type Description call InterceptingCall Exposes gRPC request operations, processed by an interceptor stack. Extends external:Writable Methods cancel() Cancel the ongoing call. Results in the call ending with a CANCELLED status, unless it has already ended with some other status. getPeer() Get the endpoint this call/stream is connected to. Returns: The URI of the endpoint Type string write(message, flags, callback) Write a message to the request stream. If serializing the argument fails, the call will be cancelled and the stream will end with an error. Parameters: Name Type Description message * The message to write. Must be a valid argument to the serialize function of the corresponding method flags grpc.writeFlags Flags to modify how the message is written callback function Callback for when this chunk of data is flushed Returns: As defined for Writable Type boolean Events metadata Initial response metadata sent by the server when it starts processing the call Type: grpc.Metadata status Status of the call when it has completed. Type: grpc~StatusObject × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc-ServerDuplexStream.html":{"id":"grpc-ServerDuplexStream.html","title":"Class: ServerDuplexStream","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: ServerDuplexStream grpc~ ServerDuplexStream new ServerDuplexStream(call, metadata, serialize, deserialize) A stream that the server can read from or write to. Used for calls with duplex streaming. Parameters: Name Type Description call grpc.internal~Call Call object to proxy metadata grpc.Metadata The request metadata from the client serialize grpc~serialize Serialization function for requests deserialize grpc~deserialize Deserialization function for responses Extends external:Duplex Methods getPeer() Get the endpoint this call/stream is connected to. Returns: The URI of the endpoint Type string sendMetadata(responseMetadata) Send the initial metadata for a writable stream. Parameters: Name Type Description responseMetadata grpc.Metadata Metadata to send Events cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc-ServerReadableStream.html":{"id":"grpc-ServerReadableStream.html","title":"Class: ServerReadableStream","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: ServerReadableStream grpc~ ServerReadableStream new ServerReadableStream(call, metadata, deserialize) A stream that the server can read from. Used for calls that are streaming from the client side. Parameters: Name Type Description call grpc.internal~Call The call object to read data with metadata grpc.Metadata The request metadata from the client deserialize grpc~deserialize Deserialization function for reads Extends external:Readable Members cancelled :boolean Indicates if the call has been cancelled Type: boolean cancelled :boolean Indicates if the call has been cancelled Type: boolean metadata :grpc.Metadata The request metadata from the client Type: grpc.Metadata metadata :grpc.Metadata The request metadata from the client Type: grpc.Metadata Methods getPeer() Get the endpoint this call/stream is connected to. Returns: The URI of the endpoint Type string sendMetadata(responseMetadata) Send the initial metadata for a writable stream. Parameters: Name Type Description responseMetadata grpc.Metadata Metadata to send Events cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc-ServerUnaryCall.html":{"id":"grpc-ServerUnaryCall.html","title":"Class: ServerUnaryCall","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: ServerUnaryCall grpc~ ServerUnaryCall new ServerUnaryCall(call, metadata) An EventEmitter. Used for unary calls. Parameters: Name Type Description call grpc.internal~Call The call object associated with the request metadata grpc.Metadata The request metadata from the client Extends external:EventEmitter Members cancelled :boolean Indicates if the call has been cancelled Type: boolean metadata :grpc.Metadata The request metadata from the client Type: grpc.Metadata request :* The request message from the client Type: * Methods getPeer() Get the endpoint this call/stream is connected to. Returns: The URI of the endpoint Type string sendMetadata(responseMetadata) Send the initial metadata for a writable stream. Parameters: Name Type Description responseMetadata grpc.Metadata Metadata to send Events cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"grpc-ServerWritableStream.html":{"id":"grpc-ServerWritableStream.html","title":"Class: ServerWritableStream","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: ServerWritableStream grpc~ ServerWritableStream new ServerWritableStream(call, metadata, serialize) A stream that the server can write to. Used for calls that are streaming from the server side. Parameters: Name Type Description call grpc.internal~Call The call object to send data with metadata grpc.Metadata The request metadata from the client serialize grpc~serialize Serialization function for writes Extends external:Writable Members cancelled :boolean Indicates if the call has been cancelled Type: boolean metadata :grpc.Metadata The request metadata from the client Type: grpc.Metadata request :* The request message from the client Type: * Methods getPeer() Get the endpoint this call/stream is connected to. Returns: The URI of the endpoint Type string sendMetadata(responseMetadata) Send the initial metadata for a writable stream. Parameters: Name Type Description responseMetadata grpc.Metadata Metadata to send Events cancelled Emitted when the call has been cancelled. After this has been emitted, the call's cancelled property will be set to true. × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"module-src_client_interceptors.html":{"id":"module-src_client_interceptors.html","title":"Module: src/client_interceptors","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Module: src/client_interceptors Client Interceptors This module describes the interceptor framework for clients. An interceptor is a function which takes an options object and a nextCall function and returns an InterceptingCall: var interceptor = function(options, nextCall) { return new InterceptingCall(nextCall(options)); }The interceptor function must return an InterceptingCall object. Returning new InterceptingCall(nextCall(options)) will satisfy the contract (but provide no interceptor functionality). nextCall is a function which will generate the next interceptor in the chain. To implement interceptor functionality, create a requester and pass it to the InterceptingCall constructor: return new InterceptingCall(nextCall(options), requester); A requester is a POJO with zero or more of the following methods: start(metadata, listener, next) To continue, call next(metadata, listener). Listeners are described below. sendMessage(message, next) To continue, call next(message). halfClose(next) To continue, call next(). cancel(message, next) To continue, call next(). A listener is a POJO with one or more of the following methods: onReceiveMetadata(metadata, next) To continue, call next(metadata) onReceiveMessage(message, next) To continue, call next(message) onReceiveStatus(status, next) To continue, call next(status) A listener is provided by the requester's start method. The provided listener implements all the inbound interceptor methods, which can be called to short-circuit the gRPC call. Three usage patterns are supported for listeners: 1) Pass the listener along without modification: next(metadata, listener). In this case the interceptor declines to intercept any inbound operations. 2) Create a new listener with one or more inbound interceptor methods and pass it to next. In this case the interceptor will fire on the inbound operations implemented in the new listener. 3) Make direct inbound calls to the provided listener's methods. This short-circuits the interceptor stack. Do not modify the listener passed in. Either pass it along unmodified, ignore it, or call methods on it to short-circuit the call. To intercept errors, implement the onReceiveStatus method and test for status.code !== grpc.status.OK. To intercept trailers, examine status.metadata in the onReceiveStatus method. This is a trivial implementation of all interceptor methods: var interceptor = function(options, nextCall) { return new InterceptingCall(nextCall(options), { start: function(metadata, listener, next) { next(metadata, { onReceiveMetadata: function (metadata, next) { next(metadata); }, onReceiveMessage: function (message, next) { next(message); }, onReceiveStatus: function (status, next) { next(status); }, }); }, sendMessage: function(message, next) { next(message); }, halfClose: function(next) { next(); }, cancel: function(message, next) { next(); } }); }; This is an interceptor with a single method: var interceptor = function(options, nextCall) { return new InterceptingCall(nextCall(options), { sendMessage: function(message, next) { next(message); } }); }; Builders are provided for convenience: StatusBuilder, ListenerBuilder, and RequesterBuilder gRPC client operations use this mapping to interceptor methods: grpc.opType.SEND_INITIAL_METADATA -> start grpc.opType.SEND_MESSAGE -> sendMessage grpc.opType.SEND_CLOSE_FROM_CLIENT -> halfClose grpc.opType.RECV_INITIAL_METADATA -> onReceiveMetadata grpc.opType.RECV_MESSAGE -> onReceiveMessage grpc.opType.RECV_STATUS_ON_CLIENT -> onReceiveStatus Classes EndListener InterceptingCall InterceptingListener InterceptorConfigurationError ListenerBuilder RequesterBuilder StatusBuilder Methods <inner> getCall(channel, path [, options]) Get a call object built with the provided options. Parameters: Name Type Argument Description channel grpc.Channel path string options grpc.Client~CallOptions <optional> Options object. <inner> getInterceptingCall(method_definition, options, interceptors, channel, responder) Parameters: Name Type Description method_definition grpc~MethodDefinition options grpc.Client~CallOptions interceptors Array.<Interceptor> channel grpc.Channel responder function | EventEmitter <inner> getLastListener(method_definition, emitter [, callback]) Creates the last listener in an interceptor stack. Parameters: Name Type Argument Description method_definition grpc~MethodDefinition emitter EventEmitter callback function <optional> Returns: Type grpc~Listener <inner> resolveInterceptorProviders(providers, method_definition) Transforms a list of interceptor providers into interceptors. Parameters: Name Type Description providers Array.<InterceptorProvider> method_definition grpc~MethodDefinition Returns: Type null | Array.<Interceptor> × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"module-src_client_interceptors-EndListener.html":{"id":"module-src_client_interceptors-EndListener.html","title":"Class: EndListener","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: EndListener src/client_interceptors~ EndListener new EndListener() A dead-end listener used to terminate a call chain. Used when an interceptor creates a branch chain, when the branch returns the listener chain will terminate here. × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"module-src_client_interceptors-InterceptingCall.html":{"id":"module-src_client_interceptors-InterceptingCall.html","title":"Class: InterceptingCall","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: InterceptingCall src/client_interceptors~ InterceptingCall new InterceptingCall(next_call [, requester]) A chainable gRPC call proxy which will delegate to an optional requester object. By default, interceptor methods will chain to next_call. If a requester is provided which implements an interceptor method, that requester method will be executed as part of the chain. Parameters: Name Type Argument Description next_call InterceptingCall | null The next call in the chain requester grpc~Requester <optional> Interceptor methods to handle request operations. Methods cancel() Run a cancel operation through the interceptor chain cancelWithStatus(code, details) Run a cancelWithStatus operation through the interceptor chain. Parameters: Name Type Description code number details string getPeer() Pass a getPeer call down to the base gRPC call (should not be intercepted) Returns: Type object halfClose() Run a close operation through the interceptor chain recvMessageWithContext(context) For receiving streaming messages, we need to seed the base interceptor with the streaming context to create a RECV_MESSAGE batch. Parameters: Name Type Description context object Carries objects needed for streaming operations sendMessage(message) Pass a message through the interceptor chain. Parameters: Name Type Description message jspb.Message sendMessageWithContext(context, message) For streaming calls, we need to transparently pass the stream's context through the interceptor chain. Passes the context between InterceptingCalls but hides it from any requester implementations. Parameters: Name Type Description context object Carries objects needed for streaming operations. message jspb.Message The message to send. start(metadata, listener) Starts a call through the outbound interceptor chain and adds an element to the reciprocal inbound listener chain. Parameters: Name Type Description metadata grpc.Metadata The outgoing metadata. listener grpc~Listener An intercepting listener for inbound operations. × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"module-src_client_interceptors-InterceptingListener.html":{"id":"module-src_client_interceptors-InterceptingListener.html","title":"Class: InterceptingListener","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: InterceptingListener src/client_interceptors~ InterceptingListener new InterceptingListener(next_listener [, delegate]) A chain-able listener object which will delegate to a custom listener when appropriate. Parameters: Name Type Argument Description next_listener InterceptingListener | null The next InterceptingListener in the chain delegate grpc~Listener <optional> A custom listener object which may implement specific operations Methods onReceiveMessage(message) Inbound message receiver. Parameters: Name Type Description message jspb.Message onReceiveMetadata(metadata) Inbound metadata receiver. Parameters: Name Type Description metadata Metadata onReceiveStatus(status) Inbound status receiver. Parameters: Name Type Description status grpc~StatusObject recvMessageWithContext(context, message) When intercepting streaming message, we need to pass the streaming context transparently along the chain. Hides the context from the delegate listener methods. Parameters: Name Type Description context object Carries objects needed for streaming operations. message jspb.Message The message received. × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"module-src_client_interceptors-InterceptorConfigurationError.html":{"id":"module-src_client_interceptors-InterceptorConfigurationError.html","title":"Class: InterceptorConfigurationError","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: InterceptorConfigurationError src/client_interceptors~ InterceptorConfigurationError new InterceptorConfigurationError(message [, extra]) A custom error thrown when interceptor configuration fails. Parameters: Name Type Argument Description message string The error message extra object <optional> × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"module-src_client_interceptors-ListenerBuilder.html":{"id":"module-src_client_interceptors-ListenerBuilder.html","title":"Class: ListenerBuilder","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: ListenerBuilder src/client_interceptors~ ListenerBuilder new ListenerBuilder() A builder for listener interceptors. Methods build() Builds the call listener. Returns: Type grpc~Listener withOnReceiveMessage(on_receive_message) Adds an onReceiveMessage method to the builder. Parameters: Name Type Description on_receive_message MessageListener A listener method for receiving messages. Returns: Type ListenerBuilder withOnReceiveMetadata(on_receive_metadata) Adds an onReceiveMetadata method to the builder. Parameters: Name Type Description on_receive_metadata MetadataListener A listener method for receiving metadata. Returns: Type ListenerBuilder withOnReceiveStatus(on_receive_status) Adds an onReceiveStatus method to the builder. Parameters: Name Type Description on_receive_status StatusListener A listener method for receiving status. Returns: Type ListenerBuilder × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"module-src_client_interceptors-RequesterBuilder.html":{"id":"module-src_client_interceptors-RequesterBuilder.html","title":"Class: RequesterBuilder","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: RequesterBuilder src/client_interceptors~ RequesterBuilder new RequesterBuilder() A builder for the outbound methods of an interceptor. Methods build() Builds the requester's interceptor methods. Returns: Type grpc~Requester withCancel(cancel) Add a cancel requester to the builder. Parameters: Name Type Description cancel CancelRequester A requester method for handling cancel Returns: Type RequesterBuilder withHalfClose(half_close) Add a close requester to the builder. Parameters: Name Type Description half_close CloseRequester A requester method for handling client close. Returns: Type RequesterBuilder withSendMessage(send_message) Add a message requester to the builder. Parameters: Name Type Description send_message MessageRequester A requester method for handling messages. Returns: Type RequesterBuilder withStart(start) Add a metadata requester to the builder. Parameters: Name Type Description start MetadataRequester A requester method for handling metadata. Returns: Type RequesterBuilder × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "},"module-src_client_interceptors-StatusBuilder.html":{"id":"module-src_client_interceptors-StatusBuilder.html","title":"Class: StatusBuilder","body":" Documentation Namespaces grpcgrpc.credentials Modules src/client_interceptors Classes grpc.Channelgrpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~Callgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStreamsrc/client_interceptors~EndListenersrc/client_interceptors~InterceptingCallsrc/client_interceptors~InterceptingListenersrc/client_interceptors~InterceptorConfigurationErrorsrc/client_interceptors~ListenerBuildersrc/client_interceptors~RequesterBuildersrc/client_interceptors~StatusBuilder Events grpc~ClientDuplexStream#metadatagrpc~ClientDuplexStream#statusgrpc~ClientReadableStream#metadatagrpc~ClientReadableStream#statusgrpc~ClientUnaryCall#event:metadatagrpc~ClientUnaryCall#event:statusgrpc~ClientWritableStream#metadatagrpc~ClientWritableStream#statusgrpc~ServerDuplexStream~event:cancelledgrpc~ServerReadableStream~event:cancelledgrpc~ServerUnaryCall~event:cancelledgrpc~ServerWritableStream~event:cancelled Global CancelRequesterCloseRequestercreateStatusErrorgetClientInterceptorsgetMethodTypeGetPeerRequesterInterceptorInterceptorProviderloadPackageDefinitionMessageListenerMessageRequesterMetadataListenerMetadataRequesterNextCallStatusListener Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: StatusBuilder src/client_interceptors~ StatusBuilder new StatusBuilder() A builder for gRPC status objects. Methods build() Builds the status object. Returns: A gRPC status. Type grpc~StatusObject withCode(code) Adds a status code to the builder. Parameters: Name Type Description code number The status code. Returns: Type StatusBuilder withDetails(details) Adds details to the builder. Parameters: Name Type Description details string A status message. Returns: Type StatusBuilder withMetadata(metadata) Adds metadata to the builder. Parameters: Name Type Description metadata Metadata The gRPC status metadata. Returns: Type StatusBuilder × Search results Close Documentation generated by JSDoc 3.5.5 on 2019-07-15T16:38:16-07:00 using the DocStrap template. "}}
- </script>
- <script type="text/javascript">
- $(document).ready(function() {
- Searcher.init();
- });
- $(window).on("message", function(msg) {
- var msgData = msg.originalEvent.data;
- if (msgData.msgid != "docstrap.quicksearch.start") {
- return;
- }
- var results = Searcher.search(msgData.searchTerms);
- window.parent.postMessage({"results": results, "msgid": "docstrap.quicksearch.done"}, "*");
- });
- </script>
- </body>
- </html>
|
