| 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">
- {"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 Externals DuplexEventEmitterGoogleCredentialReadableWritable Classes Classes Client CallCredentials ChannelCredentials Metadata Server ServerCredentials ClientDuplexStream ClientReadableStream ClientUnaryCall ClientWritableStream ServerDuplexStream ServerReadableStream ServerUnaryCall ServerWritableStream 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"namespaces.list.html":{"id":"namespaces.list.html","title":"Namespaces","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 Externals DuplexEventEmitterGoogleCredentialReadableWritable Namespaces Classes Client CallCredentials ChannelCredentials Metadata Server ServerCredentials ClientDuplexStream ClientReadableStream ClientUnaryCall ClientWritableStream ServerDuplexStream ServerReadableStream ServerUnaryCall ServerWritableStream 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"externals.list.html":{"id":"externals.list.html","title":"Externals","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 Externals DuplexEventEmitterGoogleCredentialReadableWritable Externals Classes Client CallCredentials ChannelCredentials Metadata Server ServerCredentials ClientDuplexStream ClientReadableStream ClientUnaryCall ClientWritableStream ServerDuplexStream ServerReadableStream ServerUnaryCall ServerWritableStream 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 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 SOURCE Clone the grpc Git Repository. Run npm install --build-from-source from the repository root. 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 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"external-Duplex.html":{"id":"external-Duplex.html","title":"External: Duplex","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"external-EventEmitter.html":{"id":"external-EventEmitter.html","title":"External: EventEmitter","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"external-GoogleCredential.html":{"id":"external-GoogleCredential.html","title":"External: GoogleCredential","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"external-Readable.html":{"id":"external-Readable.html","title":"External: Readable","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"external-Writable.html":{"id":"external-Writable.html","title":"External: Writable","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"grpc.html":{"id":"grpc.html","title":"Namespace: grpc","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 Externals DuplexEventEmitterGoogleCredentialReadableWritable Namespace: grpc grpc Classes Client Metadata Server ServerCredentials 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> logVerbosity :number Type: number Properties: Name Type Default Description DEBUG number 0 INFO number 1 ERROR number 2 <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> load(filename [, format] [, options]) Load a gRPC object from a .proto file. Parameters: Name Type Argument Description filename string | Object The file to load format string <optional> The file format to expect. Must be either 'proto' or 'json'. Defaults to 'proto' options Object <optional> Options to apply to the loaded file Properties Name Type Argument Default Description convertFieldsToCamelCase bool <optional> false Load this file with field names in camel case instead of their original case 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 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. Returns: The resulting gRPC object Type Object.<string, *> <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 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 * 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 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"grpc.Client.html":{"id":"grpc.Client.html","title":"Class: Client","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 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 Methods close() Close this client. getChannel() Return the underlying channel object for the specified client Returns: The channel Type Channel makeBidiStreamRequest(method, serialize, deserialize [, metadata] [, options]) Make a bidirectional stream request with this method on the given channel. Parameters: Name Type Argument Description method string The name 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(method, 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 method string The name 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 to for when the response is received Returns: An event emitter for stream related events Type grpc~ClientWritableStream makeServerStreamRequest(method, 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 method string The name 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(method, 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 method string The name 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 to 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. 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. 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"grpc.credentials.html":{"id":"grpc.credentials.html","title":"Namespace: credentials","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 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. 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 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"grpc.credentials-CallCredentials.html":{"id":"grpc.credentials-CallCredentials.html","title":"Class: CallCredentials","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"grpc.credentials-ChannelCredentials.html":{"id":"grpc.credentials-ChannelCredentials.html","title":"Class: ChannelCredentials","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"grpc.Metadata.html":{"id":"grpc.Metadata.html","title":"Class: Metadata","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: Metadata grpc. Metadata new Metadata() Class for storing metadata. Keys are normalized to lowercase ASCII. 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' × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"grpc.Server.html":{"id":"grpc.Server.html","title":"Class: Server","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 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 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. 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 string 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 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"grpc.ServerCredentials.html":{"id":"grpc.ServerCredentials.html","title":"Class: ServerCredentials","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 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 privateKey Buffer The server's private key certChain Buffer The server's certificate chain × Search results Close Documentation generated by JSDoc 3.5.5 on 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"grpc-ClientDuplexStream.html":{"id":"grpc-ClientDuplexStream.html","title":"Class: ClientDuplexStream","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: ClientDuplexStream grpc~ ClientDuplexStream new ClientDuplexStream(call [, serialize] [, deserialize]) A stream that the client can read from or write to. Used for calls with duplex streaming. Parameters: Name Type Argument Default Description call grpc.internal~Call Call object to proxy serialize grpc~serialize <optional> identity Serialization function for requests deserialize grpc~deserialize <optional> identity Deserialization function for responses 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"grpc-ClientReadableStream.html":{"id":"grpc-ClientReadableStream.html","title":"Class: ClientReadableStream","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: ClientReadableStream grpc~ ClientReadableStream new ClientReadableStream(call [, deserialize]) A stream that the client can read from. Used for calls that are streaming from the server side. Parameters: Name Type Argument Default Description call grpc.internal~Call The call object to read data with deserialize grpc~deserialize <optional> identity Deserialization function for reads 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"grpc-ClientUnaryCall.html":{"id":"grpc-ClientUnaryCall.html","title":"Class: ClientUnaryCall","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"grpc-ClientWritableStream.html":{"id":"grpc-ClientWritableStream.html","title":"Class: ClientWritableStream","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 Externals DuplexEventEmitterGoogleCredentialReadableWritable Class: ClientWritableStream grpc~ ClientWritableStream new ClientWritableStream(call [, serialize]) A stream that the client can write to. Used for calls that are streaming from the client side. Parameters: Name Type Argument Default Description call grpc.internal~Call The call object to send data with serialize grpc~serialize <optional> identity Serialization function for writes. 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"grpc-ServerDuplexStream.html":{"id":"grpc-ServerDuplexStream.html","title":"Class: ServerDuplexStream","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"grpc-ServerReadableStream.html":{"id":"grpc-ServerReadableStream.html","title":"Class: ServerReadableStream","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"grpc-ServerUnaryCall.html":{"id":"grpc-ServerUnaryCall.html","title":"Class: ServerUnaryCall","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 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 2018-01-16T12:05:13-05:00 using the DocStrap template. "},"grpc-ServerWritableStream.html":{"id":"grpc-ServerWritableStream.html","title":"Class: ServerWritableStream","body":" Documentation Namespaces grpcgrpc.credentials Classes grpc.Clientgrpc.credentials~CallCredentialsgrpc.credentials~ChannelCredentialsgrpc.Metadatagrpc.Servergrpc.ServerCredentialsgrpc~ClientDuplexStreamgrpc~ClientReadableStreamgrpc~ClientUnaryCallgrpc~ClientWritableStreamgrpc~ServerDuplexStreamgrpc~ServerReadableStreamgrpc~ServerUnaryCallgrpc~ServerWritableStream 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 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 2018-01-16T12:05:13-05: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>
|
