gRPC C#
| RpcException Events |
The RpcException type exposes the following members.
Events| + + | Name | Description |
|---|---|---|
 | SerializeObjectState | Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.) |
See AlsogRPC C#
| ChannelOptionsCensus Field |
Enable census for tracing and stats collection
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ChannelOptionsDefaultAuthority Field |
Default authority for calls.
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ChannelOptionsHttp2InitialSequenceNumber Field |
Initial sequence number for http2 transports
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ChannelOptionsMaxConcurrentStreams Field |
Maximum number of concurrent incoming streams to allow on a http2 connection
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ChannelOptionsMaxMessageLength Field |
Maximum message length that the channel can receive
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ChannelOptionsPrimaryUserAgentString Field |
Primary user agent: goes at the start of the user-agent metadata
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ChannelOptionsSecondaryUserAgentString Field |
Secondary user agent: goes at the end of the user-agent metadata
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ChannelOptionsSslTargetNameOverride Field |
Override SSL target check. Only to be used for testing.
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ContextPropagationOptionsDefault Field |
+ The context propagation options that will be used by default.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxField Value
Type: ContextPropagationOptionsSee AlsogRPC C#
| MetadataBinaryHeaderSuffix Field |
+ All binary headers should have this suffix.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MetadataEmpty Field |
+ An read-only instance of metadata containing no entries.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
gRPC C#
| StatusDefaultCancelled Field |
+ Default result of a cancelled RPC. StatusCode=Cancelled, empty details message.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| StatusDefaultSuccess Field |
+ Default result of a successful RPC. StatusCode=OK, empty details message.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| VersionInfoCurrentVersion Field |
+ Current version of gRPC
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| WriteOptionsDefault Field |
+ Default write options.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ChannelOptions Fields |
The ChannelOptions type exposes the following members.
Fields| + + | Name | Description |
|---|---|---|
  | Census | Enable census for tracing and stats collection |
| DefaultAuthority | Default authority for calls. |
| Http2InitialSequenceNumber | Initial sequence number for http2 transports |
| MaxConcurrentStreams | Maximum number of concurrent incoming streams to allow on a http2 connection |
| MaxMessageLength | Maximum message length that the channel can receive |
| PrimaryUserAgentString | Primary user agent: goes at the start of the user-agent metadata |
| SecondaryUserAgentString | Secondary user agent: goes at the end of the user-agent metadata |
| SslTargetNameOverride | Override SSL target check. Only to be used for testing. |
See AlsogRPC C#
| ContextPropagationOptions Fields |
The ContextPropagationOptions type exposes the following members.
FieldsSee AlsogRPC C#
| Metadata Fields |
The Metadata type exposes the following members.
Fields| + + | Name | Description |
|---|---|---|
| BinaryHeaderSuffix |
+ All binary headers should have this suffix.
+ |
| Empty |
+ An read-only instance of metadata containing no entries.
+ |
See AlsogRPC C#
| ServerPort Fields |
The ServerPort type exposes the following members.
Fields| + + | Name | Description |
|---|---|---|
| PickUnused |
+ Pass this value as port to have the server choose an unused listening port for you.
+ Ports added to a server will contain the bound port in their BoundPort property.
+ |
See AlsogRPC C#
| Status Fields |
The Status type exposes the following members.
Fields| + + | Name | Description |
|---|---|---|
| DefaultCancelled |
+ Default result of a cancelled RPC. StatusCode=Cancelled, empty details message.
+ |
| DefaultSuccess |
+ Default result of a successful RPC. StatusCode=OK, empty details message.
+ |
See AlsogRPC C#
| VersionInfo Fields |
The VersionInfo type exposes the following members.
Fields| + + | Name | Description |
|---|---|---|
| CurrentVersion |
+ Current version of gRPC
+ |
See AlsogRPC C#
gRPC C#
| AuthInterceptorsFromAccessToken Method |
+ Creates OAuth2 interceptor that will use given access token as authorization.
+
Namespace: Grpc.Auth
Assembly: Grpc.Auth (in Grpc.Auth.dll) Version: 0.6.1.0
SyntaxParameters
- accessToken
- Type: SystemString
OAuth2 access token.
Return Value
Type: HeaderInterceptorThe header interceptor.
See AlsogRPC C#
| AuthInterceptorsFromCredential Method |
+ Creates interceptor that will obtain access token from any credential type that implements
+ ITokenAccess. (e.g. GoogleCredential).
+
Namespace: Grpc.Auth
Assembly: Grpc.Auth (in Grpc.Auth.dll) Version: 0.6.1.0
SyntaxParameters
- credential
- Type: ITokenAccess
The credential to use to obtain access tokens.
Return Value
Type: HeaderInterceptorThe header interceptor.
See AlsogRPC C#
| AsyncClientStreamingCallTRequest, TResponseDispose Method |
+ Provides means to cleanup after the call.
+ If the call has already finished normally (request stream has been completed and call result has been received), doesn't do anything.
+ Otherwise, requests cancellation of the call which should terminate all pending async operations associated with the call.
+ As a result, all resources being used by the call should be released eventually.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncClientStreamingCallTRequest, TResponseGetAwaiter Method |
+ Allows awaiting this object directly.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncClientStreamingCallTRequest, TResponseGetStatus Method |
+ Gets the call status if the call has already finished.
+ Throws InvalidOperationException otherwise.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncClientStreamingCallTRequest, TResponseGetTrailers Method |
+ Gets the call trailing metadata if the call has already finished.
+ Throws InvalidOperationException otherwise.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncDuplexStreamingCallTRequest, TResponseDispose Method |
+ Provides means to cleanup after the call.
+ If the call has already finished normally (request stream has been completed and response stream has been fully read), doesn't do anything.
+ Otherwise, requests cancellation of the call which should terminate all pending async operations associated with the call.
+ As a result, all resources being used by the call should be released eventually.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncDuplexStreamingCallTRequest, TResponseGetStatus Method |
+ Gets the call status if the call has already finished.
+ Throws InvalidOperationException otherwise.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncDuplexStreamingCallTRequest, TResponseGetTrailers Method |
+ Gets the call trailing metadata if the call has already finished.
+ Throws InvalidOperationException otherwise.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncServerStreamingCallTResponseDispose Method |
+ Provides means to cleanup after the call.
+ If the call has already finished normally (response stream has been fully read), doesn't do anything.
+ Otherwise, requests cancellation of the call which should terminate all pending async operations associated with the call.
+ As a result, all resources being used by the call should be released eventually.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncServerStreamingCallTResponseGetStatus Method |
+ Gets the call status if the call has already finished.
+ Throws InvalidOperationException otherwise.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncServerStreamingCallTResponseGetTrailers Method |
+ Gets the call trailing metadata if the call has already finished.
+ Throws InvalidOperationException otherwise.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncUnaryCallTResponseDispose Method |
+ Provides means to cleanup after the call.
+ If the call has already finished normally (request stream has been completed and call result has been received), doesn't do anything.
+ Otherwise, requests cancellation of the call which should terminate all pending async operations associated with the call.
+ As a result, all resources being used by the call should be released eventually.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncUnaryCallTResponseGetAwaiter Method |
+ Allows awaiting this object directly.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncUnaryCallTResponseGetStatus Method |
+ Gets the call status if the call has already finished.
+ Throws InvalidOperationException otherwise.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncUnaryCallTResponseGetTrailers Method |
+ Gets the call trailing metadata if the call has already finished.
+ Throws InvalidOperationException otherwise.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| CallInvocationDetailsTRequest, TResponseWithOptions Method |
+ Returns new instance of CallInvocationDetailsTRequest, TResponse with
+ Options set to the value provided. Values of all other fields are preserved.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic CallInvocationDetails<TRequest, TResponse> WithOptions( + CallOptions options +)
Parameters
- options
- Type: Grpc.CoreCallOptions
[Missing <param name="options"/> documentation for "M:Grpc.Core.CallInvocationDetails`2.WithOptions(Grpc.Core.CallOptions)"]
Return Value
Type: CallInvocationDetailsTRequest, TResponseSee AlsogRPC C#
| CallInvocationDetailsTRequest, TResponse Constructor (Channel, MethodTRequest, TResponse, CallOptions) |
+ Initializes a new instance of the CallInvocationDetailsTRequest, TResponse struct.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic CallInvocationDetails( + Channel channel, + Method<TRequest, TResponse> method, + CallOptions options +)
Parameters
- channel
- Type: Grpc.CoreChannel
Channel to use for this call. - method
- Type: Grpc.CoreMethodTRequest, TResponse
Method to call. - options
- Type: Grpc.CoreCallOptions
Call options.
See AlsogRPC C#
| CallInvocationDetailsTRequest, TResponse Constructor (Channel, MethodTRequest, TResponse, String, CallOptions) |
+ Initializes a new instance of the CallInvocationDetailsTRequest, TResponse struct.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic CallInvocationDetails( + Channel channel, + Method<TRequest, TResponse> method, + string host, + CallOptions options +)
Parameters
- channel
- Type: Grpc.CoreChannel
Channel to use for this call. - method
- Type: Grpc.CoreMethodTRequest, TResponse
Method to call. - host
- Type: SystemString
Host that contains the method. if null, default host will be used. - options
- Type: Grpc.CoreCallOptions
Call options.
See AlsogRPC C#
| CallInvocationDetailsTRequest, TResponse Constructor (Channel, String, String, MarshallerTRequest, MarshallerTResponse, CallOptions) |
+ Initializes a new instance of the CallInvocationDetailsTRequest, TResponse struct.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic CallInvocationDetails( + Channel channel, + string method, + string host, + Marshaller<TRequest> requestMarshaller, + Marshaller<TResponse> responseMarshaller, + CallOptions options +)
Parameters
- channel
- Type: Grpc.CoreChannel
Channel to use for this call. - method
- Type: SystemString
Qualified method name. - host
- Type: SystemString
Host that contains the method. - requestMarshaller
- Type: Grpc.CoreMarshallerTRequest
Request marshaller. - responseMarshaller
- Type: Grpc.CoreMarshallerTResponse
Response marshaller. - options
- Type: Grpc.CoreCallOptions
Call options.
See AlsogRPC C#
| CallOptionsWithCancellationToken Method |
+ Returns new instance of CallOptions with
+ CancellationToken set to the value provided. Values of all other fields are preserved.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- cancellationToken
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type: CallOptionsSee AlsogRPC C#
| CallOptionsWithDeadline Method |
+ Returns new instance of CallOptions with
+ Deadline set to the value provided. Values of all other fields are preserved.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| CallOptionsWithHeaders Method |
+ Returns new instance of CallOptions with
+ Headers set to the value provided. Values of all other fields are preserved.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| CallOptions Constructor |
+ Creates a new instance of CallOptions struct.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic CallOptions( + Metadata headers = null, + Nullable<DateTime> deadline = null, + CancellationToken cancellationToken = null, + WriteOptions writeOptions = null, + ContextPropagationToken propagationToken = null +)
Parameters
- headers (Optional)
- Type: Grpc.CoreMetadata
Headers to be sent with the call. - deadline (Optional)
- Type: SystemNullableDateTime
Deadline for the call to finish. null means no deadline. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
Can be used to request cancellation of the call. - writeOptions (Optional)
- Type: Grpc.CoreWriteOptions
Write options that will be used for this call. - propagationToken (Optional)
- Type: Grpc.CoreContextPropagationToken
Context propagation token obtained from ServerCallContext.
See AlsogRPC C#
| CallsAsyncClientStreamingCallTRequest, TResponse Method |
+ Invokes a client streaming call asynchronously.
+ In client streaming scenario, client sends a stream of requests and server responds with a single response.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic static AsyncClientStreamingCall<TRequest, TResponse> AsyncClientStreamingCall<TRequest, TResponse>( + CallInvocationDetails<TRequest, TResponse> call +) +where TRequest : class +where TResponse : class +
Parameters
- call
- Type: Grpc.CoreCallInvocationDetailsTRequest, TResponse
The call defintion.
Type Parameters
- TRequest
- Type of request messages.
- TResponse
- The of response message.
Return Value
Type: AsyncClientStreamingCallTRequest, TResponseAn awaitable call object providing access to the response.
See AlsogRPC C#
| CallsAsyncDuplexStreamingCallTRequest, TResponse Method |
+ Invokes a duplex streaming call asynchronously.
+ In duplex streaming scenario, client sends a stream of requests and server responds with a stream of responses.
+ The response stream is completely independent and both side can be sending messages at the same time.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic static AsyncDuplexStreamingCall<TRequest, TResponse> AsyncDuplexStreamingCall<TRequest, TResponse>( + CallInvocationDetails<TRequest, TResponse> call +) +where TRequest : class +where TResponse : class +
Parameters
- call
- Type: Grpc.CoreCallInvocationDetailsTRequest, TResponse
The call definition.
Type Parameters
- TRequest
- Type of request messages.
- TResponse
- Type of reponse messages.
Return Value
Type: AsyncDuplexStreamingCallTRequest, TResponseA call object providing access to the asynchronous request and response streams.
See AlsogRPC C#
| CallsAsyncServerStreamingCallTRequest, TResponse Method |
+ Invokes a server streaming call asynchronously.
+ In server streaming scenario, client sends on request and server responds with a stream of responses.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic static AsyncServerStreamingCall<TResponse> AsyncServerStreamingCall<TRequest, TResponse>( + CallInvocationDetails<TRequest, TResponse> call, + TRequest req +) +where TRequest : class +where TResponse : class +
Parameters
- call
- Type: Grpc.CoreCallInvocationDetailsTRequest, TResponse
The call defintion. - req
- Type: TRequest
Request message.
Type Parameters
- TRequest
- Type of request message.
- TResponse
- The of response messages.
Return Value
Type: AsyncServerStreamingCallTResponseA call object providing access to the asynchronous response stream.
See AlsogRPC C#
| CallsAsyncUnaryCallTRequest, TResponse Method |
+ Invokes a simple remote call asynchronously.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic static AsyncUnaryCall<TResponse> AsyncUnaryCall<TRequest, TResponse>( + CallInvocationDetails<TRequest, TResponse> call, + TRequest req +) +where TRequest : class +where TResponse : class +
Parameters
- call
- Type: Grpc.CoreCallInvocationDetailsTRequest, TResponse
The call defintion. - req
- Type: TRequest
Request message.
Type Parameters
- TRequest
- Type of request message.
- TResponse
- The of response message.
Return Value
Type: AsyncUnaryCallTResponseAn awaitable call object providing access to the response.
See AlsogRPC C#
| CallsBlockingUnaryCallTRequest, TResponse Method |
+ Invokes a simple remote call in a blocking fashion.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic static TResponse BlockingUnaryCall<TRequest, TResponse>( + CallInvocationDetails<TRequest, TResponse> call, + TRequest req +) +where TRequest : class +where TResponse : class +
Parameters
- call
- Type: Grpc.CoreCallInvocationDetailsTRequest, TResponse
The call defintion. - req
- Type: TRequest
Request message.
Type Parameters
- TRequest
- Type of request message.
- TResponse
- The of response message.
Return Value
Type: TResponseThe response.
See AlsogRPC C#
| ChannelOption Constructor (String, Int32) |
+ Creates a channel option with an integer value.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- name
- Type: SystemString
Name. - intValue
- Type: SystemInt32
Integer value.
See AlsogRPC C#
| ChannelOption Constructor (String, String) |
+ Creates a channel option with a string value.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- name
- Type: SystemString
Name. - stringValue
- Type: SystemString
String value.
See AlsogRPC C#
| ChannelConnectAsync Method |
+ Allows explicitly requesting channel to connect without starting an RPC.
+ Returned task completes once state Ready was seen. If the deadline is reached,
+ or channel enters the FatalFailure state, the task is cancelled.
+ There is no need to call this explicitly unless your use case requires that.
+ Starting an RPC on a new channel will request connection implicitly.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- deadline (Optional)
- Type: SystemNullableDateTime
The deadline. null indicates no deadline.
Return Value
Type: TaskSee AlsogRPC C#
| ChannelShutdownAsync Method |
+ Waits until there are no more active calls for this channel and then cleans up
+ resources used by this channel.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ChannelWaitForStateChangedAsync Method |
+ Returned tasks completes once channel state has become different from
+ given lastObservedState.
+ If deadline is reached or and error occurs, returned task is cancelled.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic Task WaitForStateChangedAsync( + ChannelState lastObservedState, + Nullable<DateTime> deadline = null +)
Parameters
- lastObservedState
- Type: Grpc.CoreChannelState
[Missing <param name="lastObservedState"/> documentation for "M:Grpc.Core.Channel.WaitForStateChangedAsync(Grpc.Core.ChannelState,System.Nullable{System.DateTime})"]
- deadline (Optional)
- Type: SystemNullableDateTime
[Missing <param name="deadline"/> documentation for "M:Grpc.Core.Channel.WaitForStateChangedAsync(Grpc.Core.ChannelState,System.Nullable{System.DateTime})"]
Return Value
Type: TaskSee AlsogRPC C#
| Channel Constructor (String, Credentials, IEnumerableChannelOption) |
+ Creates a channel that connects to a specific host.
+ Port will default to 80 for an unsecure channel and to 443 for a secure channel.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic Channel( + string target, + Credentials credentials, + IEnumerable<ChannelOption> options = null +)
Parameters
- target
- Type: SystemString
Target of the channel. - credentials
- Type: Grpc.CoreCredentials
Credentials to secure the channel. - options (Optional)
- Type: System.Collections.GenericIEnumerableChannelOption
Channel options.
See AlsogRPC C#
| Channel Constructor (String, Int32, Credentials, IEnumerableChannelOption) |
+ Creates a channel that connects to a specific host and port.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic Channel( + string host, + int port, + Credentials credentials, + IEnumerable<ChannelOption> options = null +)
Parameters
- host
- Type: SystemString
The name or IP address of the host. - port
- Type: SystemInt32
The port. - credentials
- Type: Grpc.CoreCredentials
Credentials to secure the channel. - options (Optional)
- Type: System.Collections.GenericIEnumerableChannelOption
Channel options.
See AlsogRPC C#
| ClientBaseCreateCallTRequest, TResponse Method |
+ Creates a new call to given method.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxprotected CallInvocationDetails<TRequest, TResponse> CreateCall<TRequest, TResponse>( + Method<TRequest, TResponse> method, + CallOptions options +) +where TRequest : class +where TResponse : class +
Parameters
- method
- Type: Grpc.CoreMethodTRequest, TResponse
The method to invoke. - options
- Type: Grpc.CoreCallOptions
The call options.
Type Parameters
- TRequest
- Request message type.
- TResponse
- Response message type.
Return Value
Type: CallInvocationDetailsTRequest, TResponseThe call invocation details.
See AlsogRPC C#
| ClientBase Constructor |
+ Initializes a new instance of ClientBase class.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- channel
- Type: Grpc.CoreChannel
The channel to use for remote call invocation.
See AlsogRPC C#
| ContextPropagationOptions Constructor |
+ Creates new context propagation options.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic ContextPropagationOptions( + bool propagateDeadline = true, + bool propagateCancellation = true +)
Parameters
- propagateDeadline (Optional)
- Type: SystemBoolean
If set to true parent call's deadline will be propagated to the child call. - propagateCancellation (Optional)
- Type: SystemBoolean
If set to true parent call's cancellation token will be propagated to the child call.
See AlsogRPC C#
| Credentials Constructor |
Initializes a new instance of the Credentials class
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| GrpcEnvironmentSetLogger Method |
+ Sets the application-wide logger that should be used by gRPC.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- customLogger
- Type: Grpc.Core.LoggingILogger
[Missing <param name="customLogger"/> documentation for "M:Grpc.Core.GrpcEnvironment.SetLogger(Grpc.Core.Logging.ILogger)"]
See AlsogRPC C#
gRPC C#
| IClientStreamWriterTCompleteAsync Method |
+ Completes/closes the stream. Can only be called once there is no pending write. No writes should follow calling this.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| KeyCertificatePair Constructor |
+ Creates a new certificate chain - private key pair.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- certificateChain
- Type: SystemString
PEM encoded certificate chain. - privateKey
- Type: SystemString
PEM encoded private key.
See AlsogRPC C#
| ConsoleLoggerDebug Method |
Logs a message with severity Debug.
Namespace: Grpc.Core.Logging
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- message
- Type: SystemString
[Missing <param name="message"/> documentation for "M:Grpc.Core.Logging.ConsoleLogger.Debug(System.String,System.Object[])"]
- formatArgs
- Type: SystemObject
[Missing <param name="formatArgs"/> documentation for "M:Grpc.Core.Logging.ConsoleLogger.Debug(System.String,System.Object[])"]
Implements
ILoggerDebug(String, Object)See AlsogRPC C#
| ConsoleLoggerError Method (Exception, String, Object) |
Logs a message and an associated exception with severity Error.
Namespace: Grpc.Core.Logging
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic void Error( + Exception exception, + string message, + params Object[] formatArgs +)
Parameters
- exception
- Type: SystemException
[Missing <param name="exception"/> documentation for "M:Grpc.Core.Logging.ConsoleLogger.Error(System.Exception,System.String,System.Object[])"]
- message
- Type: SystemString
[Missing <param name="message"/> documentation for "M:Grpc.Core.Logging.ConsoleLogger.Error(System.Exception,System.String,System.Object[])"]
- formatArgs
- Type: SystemObject
[Missing <param name="formatArgs"/> documentation for "M:Grpc.Core.Logging.ConsoleLogger.Error(System.Exception,System.String,System.Object[])"]
Implements
ILoggerError(Exception, String, Object)See AlsogRPC C#
| ConsoleLoggerError Method (String, Object) |
Logs a message with severity Error.
Namespace: Grpc.Core.Logging
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- message
- Type: SystemString
[Missing <param name="message"/> documentation for "M:Grpc.Core.Logging.ConsoleLogger.Error(System.String,System.Object[])"]
- formatArgs
- Type: SystemObject
[Missing <param name="formatArgs"/> documentation for "M:Grpc.Core.Logging.ConsoleLogger.Error(System.String,System.Object[])"]
Implements
ILoggerError(String, Object)See AlsogRPC C#
| ConsoleLoggerForTypeT Method |
+ Returns a logger associated with the specified type.
+
Namespace: Grpc.Core.Logging
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxType Parameters
- T
[Missing <typeparam name="T"/> documentation for "M:Grpc.Core.Logging.ConsoleLogger.ForType``1"]
Return Value
Type: ILoggerImplements
ILoggerForTypeTSee AlsogRPC C#
| ConsoleLoggerInfo Method |
Logs a message with severity Info.
Namespace: Grpc.Core.Logging
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- message
- Type: SystemString
[Missing <param name="message"/> documentation for "M:Grpc.Core.Logging.ConsoleLogger.Info(System.String,System.Object[])"]
- formatArgs
- Type: SystemObject
[Missing <param name="formatArgs"/> documentation for "M:Grpc.Core.Logging.ConsoleLogger.Info(System.String,System.Object[])"]
Implements
ILoggerInfo(String, Object)See AlsogRPC C#
| ConsoleLoggerWarning Method (Exception, String, Object) |
Logs a message and an associated exception with severity Warning.
Namespace: Grpc.Core.Logging
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic void Warning( + Exception exception, + string message, + params Object[] formatArgs +)
Parameters
- exception
- Type: SystemException
[Missing <param name="exception"/> documentation for "M:Grpc.Core.Logging.ConsoleLogger.Warning(System.Exception,System.String,System.Object[])"]
- message
- Type: SystemString
[Missing <param name="message"/> documentation for "M:Grpc.Core.Logging.ConsoleLogger.Warning(System.Exception,System.String,System.Object[])"]
- formatArgs
- Type: SystemObject
[Missing <param name="formatArgs"/> documentation for "M:Grpc.Core.Logging.ConsoleLogger.Warning(System.Exception,System.String,System.Object[])"]
Implements
ILoggerWarning(Exception, String, Object)See AlsogRPC C#
| ConsoleLoggerWarning Method (String, Object) |
Logs a message with severity Warning.
Namespace: Grpc.Core.Logging
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- message
- Type: SystemString
[Missing <param name="message"/> documentation for "M:Grpc.Core.Logging.ConsoleLogger.Warning(System.String,System.Object[])"]
- formatArgs
- Type: SystemObject
[Missing <param name="formatArgs"/> documentation for "M:Grpc.Core.Logging.ConsoleLogger.Warning(System.String,System.Object[])"]
Implements
ILoggerWarning(String, Object)See AlsogRPC C#
| ConsoleLogger Constructor |
Creates a console logger not associated to any specific type.
Namespace: Grpc.Core.Logging
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ILoggerDebug Method |
Logs a message with severity Debug.
Namespace: Grpc.Core.Logging
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- message
- Type: SystemString
[Missing <param name="message"/> documentation for "M:Grpc.Core.Logging.ILogger.Debug(System.String,System.Object[])"]
- formatArgs
- Type: SystemObject
[Missing <param name="formatArgs"/> documentation for "M:Grpc.Core.Logging.ILogger.Debug(System.String,System.Object[])"]
See AlsogRPC C#
| ILoggerError Method (Exception, String, Object) |
Logs a message and an associated exception with severity Error.
Namespace: Grpc.Core.Logging
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- exception
- Type: SystemException
[Missing <param name="exception"/> documentation for "M:Grpc.Core.Logging.ILogger.Error(System.Exception,System.String,System.Object[])"]
- message
- Type: SystemString
[Missing <param name="message"/> documentation for "M:Grpc.Core.Logging.ILogger.Error(System.Exception,System.String,System.Object[])"]
- formatArgs
- Type: SystemObject
[Missing <param name="formatArgs"/> documentation for "M:Grpc.Core.Logging.ILogger.Error(System.Exception,System.String,System.Object[])"]
See AlsogRPC C#
| ILoggerError Method (String, Object) |
Logs a message with severity Error.
Namespace: Grpc.Core.Logging
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- message
- Type: SystemString
[Missing <param name="message"/> documentation for "M:Grpc.Core.Logging.ILogger.Error(System.String,System.Object[])"]
- formatArgs
- Type: SystemObject
[Missing <param name="formatArgs"/> documentation for "M:Grpc.Core.Logging.ILogger.Error(System.String,System.Object[])"]
See AlsogRPC C#
| ILoggerForTypeT Method |
Returns a logger associated with the specified type.
Namespace: Grpc.Core.Logging
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxType Parameters
- T
[Missing <typeparam name="T"/> documentation for "M:Grpc.Core.Logging.ILogger.ForType``1"]
Return Value
Type: ILoggerSee AlsogRPC C#
| ILoggerInfo Method |
Logs a message with severity Info.
Namespace: Grpc.Core.Logging
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- message
- Type: SystemString
[Missing <param name="message"/> documentation for "M:Grpc.Core.Logging.ILogger.Info(System.String,System.Object[])"]
- formatArgs
- Type: SystemObject
[Missing <param name="formatArgs"/> documentation for "M:Grpc.Core.Logging.ILogger.Info(System.String,System.Object[])"]
See AlsogRPC C#
| ILoggerWarning Method (Exception, String, Object) |
Logs a message and an associated exception with severity Warning.
Namespace: Grpc.Core.Logging
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- exception
- Type: SystemException
[Missing <param name="exception"/> documentation for "M:Grpc.Core.Logging.ILogger.Warning(System.Exception,System.String,System.Object[])"]
- message
- Type: SystemString
[Missing <param name="message"/> documentation for "M:Grpc.Core.Logging.ILogger.Warning(System.Exception,System.String,System.Object[])"]
- formatArgs
- Type: SystemObject
[Missing <param name="formatArgs"/> documentation for "M:Grpc.Core.Logging.ILogger.Warning(System.Exception,System.String,System.Object[])"]
See AlsogRPC C#
| ILoggerWarning Method (String, Object) |
Logs a message with severity Warning.
Namespace: Grpc.Core.Logging
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- message
- Type: SystemString
[Missing <param name="message"/> documentation for "M:Grpc.Core.Logging.ILogger.Warning(System.String,System.Object[])"]
- formatArgs
- Type: SystemObject
[Missing <param name="formatArgs"/> documentation for "M:Grpc.Core.Logging.ILogger.Warning(System.String,System.Object[])"]
See AlsogRPC C#
| MarshallerT Constructor |
+ Initializes a new marshaller.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- serializer
- Type: SystemFuncT, Byte
Function that will be used to serialize messages. - deserializer
- Type: SystemFuncByte, T
Function that will be used to deserialize messages.
See AlsogRPC C#
| MarshallersCreateT Method |
+ Creates a marshaller from specified serializer and deserializer.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic static Marshaller<T> Create<T>( + Func<T, byte[]> serializer, + Func<byte[], T> deserializer +) +
Parameters
- serializer
- Type: SystemFuncT, Byte
[Missing <param name="serializer"/> documentation for "M:Grpc.Core.Marshallers.Create``1(System.Func{``0,System.Byte[]},System.Func{System.Byte[],``0})"]
- deserializer
- Type: SystemFuncByte, T
[Missing <param name="deserializer"/> documentation for "M:Grpc.Core.Marshallers.Create``1(System.Func{``0,System.Byte[]},System.Func{System.Byte[],``0})"]
Type Parameters
- T
[Missing <typeparam name="T"/> documentation for "M:Grpc.Core.Marshallers.Create``1(System.Func{``0,System.Byte[]},System.Func{System.Byte[],``0})"]
Return Value
Type: MarshallerTSee AlsogRPC C#
| MetadataAdd Method (MetadataEntry) |
[Missing <summary> documentation for "M:Grpc.Core.Metadata.Add(Grpc.Core.Metadata.Entry)"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- item
- Type: Grpc.CoreMetadataEntry
[Missing <param name="item"/> documentation for "M:Grpc.Core.Metadata.Add(Grpc.Core.Metadata.Entry)"]
Implements
ICollectionTAdd(T)See AlsogRPC C#
| MetadataAdd Method (String, Byte) |
[Missing <summary> documentation for "M:Grpc.Core.Metadata.Add(System.String,System.Byte[])"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- key
- Type: SystemString
[Missing <param name="key"/> documentation for "M:Grpc.Core.Metadata.Add(System.String,System.Byte[])"]
- valueBytes
- Type: SystemByte
[Missing <param name="valueBytes"/> documentation for "M:Grpc.Core.Metadata.Add(System.String,System.Byte[])"]
See AlsogRPC C#
| MetadataAdd Method (String, String) |
[Missing <summary> documentation for "M:Grpc.Core.Metadata.Add(System.String,System.String)"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- key
- Type: SystemString
[Missing <param name="key"/> documentation for "M:Grpc.Core.Metadata.Add(System.String,System.String)"]
- value
- Type: SystemString
[Missing <param name="value"/> documentation for "M:Grpc.Core.Metadata.Add(System.String,System.String)"]
See AlsogRPC C#
| MetadataClear Method |
[Missing <summary> documentation for "M:Grpc.Core.Metadata.Clear"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MetadataContains Method |
[Missing <summary> documentation for "M:Grpc.Core.Metadata.Contains(Grpc.Core.Metadata.Entry)"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- item
- Type: Grpc.CoreMetadataEntry
[Missing <param name="item"/> documentation for "M:Grpc.Core.Metadata.Contains(Grpc.Core.Metadata.Entry)"]
Return Value
Type: BooleanImplements
ICollectionTContains(T)See AlsogRPC C#
| MetadataCopyTo Method |
[Missing <summary> documentation for "M:Grpc.Core.Metadata.CopyTo(Grpc.Core.Metadata.Entry[],System.Int32)"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- array
- Type: Grpc.CoreMetadataEntry
[Missing <param name="array"/> documentation for "M:Grpc.Core.Metadata.CopyTo(Grpc.Core.Metadata.Entry[],System.Int32)"]
- arrayIndex
- Type: SystemInt32
[Missing <param name="arrayIndex"/> documentation for "M:Grpc.Core.Metadata.CopyTo(Grpc.Core.Metadata.Entry[],System.Int32)"]
Implements
ICollectionTCopyTo(T, Int32)See AlsogRPC C#
| MetadataEntryToString Method |
+ Returns a String that represents the current MetadataEntry.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MetadataEntry Constructor (String, Byte) |
+ Initializes a new instance of the MetadataEntry struct with a binary value.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- key
- Type: SystemString
Metadata key, needs to have suffix indicating a binary valued metadata entry. - valueBytes
- Type: SystemByte
Value bytes.
See AlsogRPC C#
| MetadataEntry Constructor (String, String) |
+ Initializes a new instance of the MetadataEntry struct holding an ASCII value.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- key
- Type: SystemString
Metadata key, must not use suffix indicating a binary valued metadata entry. - value
- Type: SystemString
Value string. Only ASCII characters are allowed.
See AlsogRPC C#
| MetadataGetEnumerator Method |
[Missing <summary> documentation for "M:Grpc.Core.Metadata.GetEnumerator"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MetadataIndexOf Method |
[Missing <summary> documentation for "M:Grpc.Core.Metadata.IndexOf(Grpc.Core.Metadata.Entry)"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- item
- Type: Grpc.CoreMetadataEntry
[Missing <param name="item"/> documentation for "M:Grpc.Core.Metadata.IndexOf(Grpc.Core.Metadata.Entry)"]
Return Value
Type: Int32Implements
IListTIndexOf(T)See AlsogRPC C#
| MetadataInsert Method |
[Missing <summary> documentation for "M:Grpc.Core.Metadata.Insert(System.Int32,Grpc.Core.Metadata.Entry)"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- index
- Type: SystemInt32
[Missing <param name="index"/> documentation for "M:Grpc.Core.Metadata.Insert(System.Int32,Grpc.Core.Metadata.Entry)"]
- item
- Type: Grpc.CoreMetadataEntry
[Missing <param name="item"/> documentation for "M:Grpc.Core.Metadata.Insert(System.Int32,Grpc.Core.Metadata.Entry)"]
Implements
IListTInsert(Int32, T)See AlsogRPC C#
| MetadataRemove Method |
[Missing <summary> documentation for "M:Grpc.Core.Metadata.Remove(Grpc.Core.Metadata.Entry)"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- item
- Type: Grpc.CoreMetadataEntry
[Missing <param name="item"/> documentation for "M:Grpc.Core.Metadata.Remove(Grpc.Core.Metadata.Entry)"]
Return Value
Type: BooleanImplements
ICollectionTRemove(T)See AlsogRPC C#
| MetadataRemoveAt Method |
[Missing <summary> documentation for "M:Grpc.Core.Metadata.RemoveAt(System.Int32)"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- index
- Type: SystemInt32
[Missing <param name="index"/> documentation for "M:Grpc.Core.Metadata.RemoveAt(System.Int32)"]
Implements
IListTRemoveAt(Int32)See AlsogRPC C#
| Metadata Constructor |
+ Initializes a new instance of Metadata.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MethodTRequest, TResponse Constructor |
+ Initializes a new instance of the Method class.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic Method( + MethodType type, + string serviceName, + string name, + Marshaller<TRequest> requestMarshaller, + Marshaller<TResponse> responseMarshaller +)
Parameters
- type
- Type: Grpc.CoreMethodType
Type of method. - serviceName
- Type: SystemString
Name of service this method belongs to. - name
- Type: SystemString
Unqualified name of the method. - requestMarshaller
- Type: Grpc.CoreMarshallerTRequest
Marshaller used for request messages. - responseMarshaller
- Type: Grpc.CoreMarshallerTResponse
Marshaller used for response messages.
See AlsogRPC C#
| RpcException Constructor (Status) |
+ Creates a new RpcException associated with given status.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- status
- Type: Grpc.CoreStatus
Resulting status of a call.
See AlsogRPC C#
| RpcException Constructor (Status, String) |
+ Creates a new RpcException associated with given status and message.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- status
- Type: Grpc.CoreStatus
Resulting status of a call. - message
- Type: SystemString
The exception message.
See AlsogRPC C#
| ServerCallContextCreatePropagationToken Method |
+ Creates a propagation token to be used to propagate call context to a child call.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic ContextPropagationToken CreatePropagationToken( + ContextPropagationOptions options = null +)
Parameters
- options (Optional)
- Type: Grpc.CoreContextPropagationOptions
[Missing <param name="options"/> documentation for "M:Grpc.Core.ServerCallContext.CreatePropagationToken(Grpc.Core.ContextPropagationOptions)"]
Return Value
Type: ContextPropagationTokenSee AlsogRPC C#
| ServerCallContextWriteResponseHeadersAsync Method |
+ Asynchronously sends response headers for the current call to the client. This method may only be invoked once for each call and needs to be invoked
+ before any response messages are written. Writing the first response message implicitly sends empty response headers if WriteResponseHeadersAsync haven't
+ been called yet.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- responseHeaders
- Type: Grpc.CoreMetadata
The response headers to send.
Return Value
Type: TaskThe task that finished once response headers have been written.
See AlsogRPC C#
| ServerCredentials Constructor |
Initializes a new instance of the ServerCredentials class
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerPort Constructor |
+ Creates a new port on which server should listen.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- host
- Type: SystemString
the host - port
- Type: SystemInt32
the port. If zero, an unused port is chosen automatically. - credentials
- Type: Grpc.CoreServerCredentials
credentials to use to secure this port.
Return Value
Type:The port on which server will be listening.
See AlsogRPC C#
| ServerServiceDefinitionBuilderAddMethodTRequest, TResponse Method (MethodTRequest, TResponse, ClientStreamingServerMethodTRequest, TResponse) |
+ Adds a definitions for a client streaming method.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic ServerServiceDefinitionBuilder AddMethod<TRequest, TResponse>( + Method<TRequest, TResponse> method, + ClientStreamingServerMethod<TRequest, TResponse> handler +) +where TRequest : class +where TResponse : class +
Parameters
- method
- Type: Grpc.CoreMethodTRequest, TResponse
The method. - handler
- Type: Grpc.CoreClientStreamingServerMethodTRequest, TResponse
The method handler.
Type Parameters
- TRequest
- The request message class.
- TResponse
- The response message class.
Return Value
Type: ServerServiceDefinitionBuilderThis builder instance.
See AlsogRPC C#
| ServerServiceDefinitionBuilderAddMethodTRequest, TResponse Method (MethodTRequest, TResponse, DuplexStreamingServerMethodTRequest, TResponse) |
+ Adds a definitions for a bidirectional streaming method.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic ServerServiceDefinitionBuilder AddMethod<TRequest, TResponse>( + Method<TRequest, TResponse> method, + DuplexStreamingServerMethod<TRequest, TResponse> handler +) +where TRequest : class +where TResponse : class +
Parameters
- method
- Type: Grpc.CoreMethodTRequest, TResponse
The method. - handler
- Type: Grpc.CoreDuplexStreamingServerMethodTRequest, TResponse
The method handler.
Type Parameters
- TRequest
- The request message class.
- TResponse
- The response message class.
Return Value
Type: ServerServiceDefinitionBuilderThis builder instance.
See AlsogRPC C#
| ServerServiceDefinitionBuilderAddMethodTRequest, TResponse Method (MethodTRequest, TResponse, ServerStreamingServerMethodTRequest, TResponse) |
+ Adds a definitions for a server streaming method.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic ServerServiceDefinitionBuilder AddMethod<TRequest, TResponse>( + Method<TRequest, TResponse> method, + ServerStreamingServerMethod<TRequest, TResponse> handler +) +where TRequest : class +where TResponse : class +
Parameters
- method
- Type: Grpc.CoreMethodTRequest, TResponse
The method. - handler
- Type: Grpc.CoreServerStreamingServerMethodTRequest, TResponse
The method handler.
Type Parameters
- TRequest
- The request message class.
- TResponse
- The response message class.
Return Value
Type: ServerServiceDefinitionBuilderThis builder instance.
See AlsogRPC C#
| ServerServiceDefinitionBuilderAddMethodTRequest, TResponse Method (MethodTRequest, TResponse, UnaryServerMethodTRequest, TResponse) |
+ Adds a definitions for a single request - single response method.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic ServerServiceDefinitionBuilder AddMethod<TRequest, TResponse>( + Method<TRequest, TResponse> method, + UnaryServerMethod<TRequest, TResponse> handler +) +where TRequest : class +where TResponse : class +
Parameters
- method
- Type: Grpc.CoreMethodTRequest, TResponse
The method. - handler
- Type: Grpc.CoreUnaryServerMethodTRequest, TResponse
The method handler.
Type Parameters
- TRequest
- The request message class.
- TResponse
- The response message class.
Return Value
Type: ServerServiceDefinitionBuilderThis builder instance.
See AlsogRPC C#
| ServerServiceDefinitionBuilderBuild Method |
+ Creates an immutable ServerServiceDefinition from this builder.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerServiceDefinitionBuilder Constructor |
+ Creates a new instance of builder.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- serviceName
- Type: SystemString
The service name.
See AlsogRPC C#
| ServerServiceDefinitionCreateBuilder Method |
+ Creates a new builder object for ServerServiceDefinition.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- serviceName
- Type: SystemString
The service name.
Return Value
Type: ServerServiceDefinitionBuilderThe builder object.
See AlsogRPC C#
| ServerKillAsync Method |
+ Requests server shutdown while cancelling all the in-progress calls.
+ The returned task finishes when shutdown procedure is complete.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerServerPortCollectionAdd Method (ServerPort) |
+ Adds a new port on which server should listen.
+ Only call this before Start().
+
The port on which server will be listening.
Return Value
Type: Int32The port on which server will be listening.
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- serverPort
- Type: Grpc.CoreServerPort
[Missing <param name="serverPort"/> documentation for "M:Grpc.Core.Server.ServerPortCollection.Add(Grpc.Core.ServerPort)"]
Return Value
Type: Int32See AlsogRPC C#
| ServerServerPortCollectionAdd Method (String, Int32, ServerCredentials) |
+ Adds a new port on which server should listen.
+
The port on which server will be listening.
Return Value
Type: Int32The port on which server will be listening.
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- host
- Type: SystemString
the host - port
- Type: SystemInt32
the port. If zero, an unused port is chosen automatically. - credentials
- Type: Grpc.CoreServerCredentials
credentials to use to secure this port.
Return Value
Type: Int32See AlsogRPC C#
| ServerServerPortCollectionGetEnumerator Method |
+ Gets enumerator for this collection.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerServiceDefinitionCollectionAdd Method |
+ Adds a service definition to the server. This is how you register
+ handlers for a service with the server. Only call this before Start().
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- serviceDefinition
- Type: Grpc.CoreServerServiceDefinition
[Missing <param name="serviceDefinition"/> documentation for "M:Grpc.Core.Server.ServiceDefinitionCollection.Add(Grpc.Core.ServerServiceDefinition)"]
See AlsogRPC C#
| ServerServiceDefinitionCollectionGetEnumerator Method |
+ Gets enumerator for this collection.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerShutdownAsync Method |
+ Requests server shutdown and when there are no more calls being serviced,
+ cleans up used resources. The returned task finishes when shutdown procedure
+ is complete.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerStart Method |
+ Starts the server.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| Server Constructor |
+ Create a new server.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- options (Optional)
- Type: System.Collections.GenericIEnumerableChannelOption
Channel options.
See AlsogRPC C#
| SslCredentials Constructor |
+ Creates client-side SSL credentials loaded from
+ disk file pointed to by the GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment variable.
+ If that fails, gets the roots certificates from a well known place on disk.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| SslCredentials Constructor (String) |
+ Creates client-side SSL credentials from
+ a string containing PEM encoded root certificates.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- rootCertificates
- Type: SystemString
[Missing <param name="rootCertificates"/> documentation for "M:Grpc.Core.SslCredentials.#ctor(System.String)"]
See AlsogRPC C#
| SslCredentials Constructor (String, KeyCertificatePair) |
+ Creates client-side SSL credentials.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic SslCredentials( + string rootCertificates, + KeyCertificatePair keyCertificatePair +)
Parameters
- rootCertificates
- Type: SystemString
string containing PEM encoded server root certificates. - keyCertificatePair
- Type: Grpc.CoreKeyCertificatePair
a key certificate pair.
See AlsogRPC C#
| SslServerCredentials Constructor (IEnumerableKeyCertificatePair) |
+ Creates server-side SSL credentials.
+ This constructor should be use if you do not wish to autheticate client
+ using client root certificates.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- keyCertificatePairs
- Type: System.Collections.GenericIEnumerableKeyCertificatePair
Key-certificates to use.
See AlsogRPC C#
| SslServerCredentials Constructor (IEnumerableKeyCertificatePair, String, Boolean) |
+ Creates server-side SSL credentials.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic SslServerCredentials( + IEnumerable<KeyCertificatePair> keyCertificatePairs, + string rootCertificates, + bool forceClientAuth +)
Parameters
- keyCertificatePairs
- Type: System.Collections.GenericIEnumerableKeyCertificatePair
Key-certificates to use. - rootCertificates
- Type: SystemString
PEM encoded client root certificates used to authenticate client. - forceClientAuth
- Type: SystemBoolean
If true, client will be rejected unless it proves its unthenticity using against rootCertificates.
See AlsogRPC C#
gRPC C#
| Status Constructor |
+ Creates a new instance of Status.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- statusCode
- Type: Grpc.CoreStatusCode
Status code. - detail
- Type: SystemString
Detail.
See AlsogRPC C#
| AsyncStreamExtensionsForEachAsyncT Method |
+ Reads the entire stream and executes an async action for each element.
+
Namespace: Grpc.Core.Utils
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic static Task ForEachAsync<T>( + this IAsyncStreamReader<T> streamReader, + Func<T, Task> asyncAction +) +where T : class +
Parameters
- streamReader
- Type: Grpc.CoreIAsyncStreamReaderT
[Missing <param name="streamReader"/> documentation for "M:Grpc.Core.Utils.AsyncStreamExtensions.ForEachAsync``1(Grpc.Core.IAsyncStreamReader{``0},System.Func{``0,System.Threading.Tasks.Task})"]
- asyncAction
- Type: SystemFuncT, Task
[Missing <param name="asyncAction"/> documentation for "M:Grpc.Core.Utils.AsyncStreamExtensions.ForEachAsync``1(Grpc.Core.IAsyncStreamReader{``0},System.Func{``0,System.Threading.Tasks.Task})"]
Type Parameters
- T
[Missing <typeparam name="T"/> documentation for "M:Grpc.Core.Utils.AsyncStreamExtensions.ForEachAsync``1(Grpc.Core.IAsyncStreamReader{``0},System.Func{``0,System.Threading.Tasks.Task})"]
Return Value
Type: TaskUsage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type IAsyncStreamReaderT. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).See AlsogRPC C#
| AsyncStreamExtensionsToListAsyncT Method |
+ Reads the entire stream and creates a list containing all the elements read.
+
Namespace: Grpc.Core.Utils
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic static Task<List<T>> ToListAsync<T>( + this IAsyncStreamReader<T> streamReader +) +where T : class +
Parameters
- streamReader
- Type: Grpc.CoreIAsyncStreamReaderT
[Missing <param name="streamReader"/> documentation for "M:Grpc.Core.Utils.AsyncStreamExtensions.ToListAsync``1(Grpc.Core.IAsyncStreamReader{``0})"]
Type Parameters
- T
[Missing <typeparam name="T"/> documentation for "M:Grpc.Core.Utils.AsyncStreamExtensions.ToListAsync``1(Grpc.Core.IAsyncStreamReader{``0})"]
Return Value
Type: TaskListTUsage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type IAsyncStreamReaderT. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).See AlsogRPC C#
| AsyncStreamExtensionsWriteAllAsyncT Method (IClientStreamWriterT, IEnumerableT, Boolean) |
+ Writes all elements from given enumerable to the stream.
+ Completes the stream afterwards unless close = false.
+
Namespace: Grpc.Core.Utils
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic static Task WriteAllAsync<T>( + this IClientStreamWriter<T> streamWriter, + IEnumerable<T> elements, + bool complete = true +) +where T : class +
Parameters
- streamWriter
- Type: Grpc.CoreIClientStreamWriterT
[Missing <param name="streamWriter"/> documentation for "M:Grpc.Core.Utils.AsyncStreamExtensions.WriteAllAsync``1(Grpc.Core.IClientStreamWriter{``0},System.Collections.Generic.IEnumerable{``0},System.Boolean)"]
- elements
- Type: System.Collections.GenericIEnumerableT
[Missing <param name="elements"/> documentation for "M:Grpc.Core.Utils.AsyncStreamExtensions.WriteAllAsync``1(Grpc.Core.IClientStreamWriter{``0},System.Collections.Generic.IEnumerable{``0},System.Boolean)"]
- complete (Optional)
- Type: SystemBoolean
[Missing <param name="complete"/> documentation for "M:Grpc.Core.Utils.AsyncStreamExtensions.WriteAllAsync``1(Grpc.Core.IClientStreamWriter{``0},System.Collections.Generic.IEnumerable{``0},System.Boolean)"]
Type Parameters
- T
[Missing <typeparam name="T"/> documentation for "M:Grpc.Core.Utils.AsyncStreamExtensions.WriteAllAsync``1(Grpc.Core.IClientStreamWriter{``0},System.Collections.Generic.IEnumerable{``0},System.Boolean)"]
Return Value
Type: TaskUsage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type IClientStreamWriterT. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).See AlsogRPC C#
| AsyncStreamExtensionsWriteAllAsyncT Method (IServerStreamWriterT, IEnumerableT) |
+ Writes all elements from given enumerable to the stream.
+
Namespace: Grpc.Core.Utils
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic static Task WriteAllAsync<T>( + this IServerStreamWriter<T> streamWriter, + IEnumerable<T> elements +) +where T : class +
Parameters
- streamWriter
- Type: Grpc.CoreIServerStreamWriterT
[Missing <param name="streamWriter"/> documentation for "M:Grpc.Core.Utils.AsyncStreamExtensions.WriteAllAsync``1(Grpc.Core.IServerStreamWriter{``0},System.Collections.Generic.IEnumerable{``0})"]
- elements
- Type: System.Collections.GenericIEnumerableT
[Missing <param name="elements"/> documentation for "M:Grpc.Core.Utils.AsyncStreamExtensions.WriteAllAsync``1(Grpc.Core.IServerStreamWriter{``0},System.Collections.Generic.IEnumerable{``0})"]
Type Parameters
- T
[Missing <typeparam name="T"/> documentation for "M:Grpc.Core.Utils.AsyncStreamExtensions.WriteAllAsync``1(Grpc.Core.IServerStreamWriter{``0},System.Collections.Generic.IEnumerable{``0})"]
Return Value
Type: TaskUsage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type IServerStreamWriterT. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).See AlsogRPC C#
| BenchmarkUtilRunBenchmark Method |
+ Runs a simple benchmark preceded by warmup phase.
+
Namespace: Grpc.Core.Utils
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic static void RunBenchmark( + int warmupIterations, + int benchmarkIterations, + Action action +)
Parameters
- warmupIterations
- Type: SystemInt32
[Missing <param name="warmupIterations"/> documentation for "M:Grpc.Core.Utils.BenchmarkUtil.RunBenchmark(System.Int32,System.Int32,System.Action)"]
- benchmarkIterations
- Type: SystemInt32
[Missing <param name="benchmarkIterations"/> documentation for "M:Grpc.Core.Utils.BenchmarkUtil.RunBenchmark(System.Int32,System.Int32,System.Action)"]
- action
- Type: SystemAction
[Missing <param name="action"/> documentation for "M:Grpc.Core.Utils.BenchmarkUtil.RunBenchmark(System.Int32,System.Int32,System.Action)"]
See AlsogRPC C#
| PreconditionsCheckArgument Method (Boolean) |
+ Throws ArgumentException if condition is false.
+
Namespace: Grpc.Core.Utils
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- condition
- Type: SystemBoolean
The condition.
See AlsogRPC C#
| PreconditionsCheckArgument Method (Boolean, String) |
+ Throws ArgumentException with given message if condition is false.
+
Namespace: Grpc.Core.Utils
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- condition
- Type: SystemBoolean
The condition. - errorMessage
- Type: SystemString
The error message.
See AlsogRPC C#
| PreconditionsCheckNotNullT Method (T) |
+ Throws ArgumentNullException if reference is null.
+
Namespace: Grpc.Core.Utils
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- reference
- Type: T
The reference.
Type Parameters
- T
[Missing <typeparam name="T"/> documentation for "M:Grpc.Core.Utils.Preconditions.CheckNotNull``1(``0)"]
Return Value
Type: TSee AlsogRPC C#
| PreconditionsCheckNotNullT Method (T, String) |
+ Throws ArgumentNullException if reference is null.
+
Namespace: Grpc.Core.Utils
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- reference
- Type: T
The reference. - paramName
- Type: SystemString
The parameter name.
Type Parameters
- T
[Missing <typeparam name="T"/> documentation for "M:Grpc.Core.Utils.Preconditions.CheckNotNull``1(``0,System.String)"]
Return Value
Type: TSee AlsogRPC C#
| PreconditionsCheckState Method (Boolean) |
+ Throws InvalidOperationException if condition is false.
+
Namespace: Grpc.Core.Utils
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- condition
- Type: SystemBoolean
The condition.
See AlsogRPC C#
| PreconditionsCheckState Method (Boolean, String) |
+ Throws InvalidOperationException with given message if condition is false.
+
Namespace: Grpc.Core.Utils
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- condition
- Type: SystemBoolean
The condition. - errorMessage
- Type: SystemString
The error message.
See AlsogRPC C#
| WriteOptions Constructor |
+ Initializes a new instance of WriteOptions class.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxParameters
- flags (Optional)
- Type: Grpc.CoreWriteFlags
The write flags.
See AlsogRPC C#
| AuthInterceptors Methods |
The AuthInterceptors type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
 | FromAccessToken |
+ Creates OAuth2 interceptor that will use given access token as authorization.
+ |
| FromCredential |
+ Creates interceptor that will obtain access token from any credential type that implements
+ ITokenAccess. (e.g. GoogleCredential).
+ |
See AlsogRPC C#
| AsyncClientStreamingCallTRequest, TResponse Methods |
The AsyncClientStreamingCallTRequest, TResponse generic type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Dispose |
+ Provides means to cleanup after the call.
+ If the call has already finished normally (request stream has been completed and call result has been received), doesn't do anything.
+ Otherwise, requests cancellation of the call which should terminate all pending async operations associated with the call.
+ As a result, all resources being used by the call should be released eventually.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetAwaiter |
+ Allows awaiting this object directly.
+ |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetStatus |
+ Gets the call status if the call has already finished.
+ Throws InvalidOperationException otherwise.
+ |
| GetTrailers |
+ Gets the call trailing metadata if the call has already finished.
+ Throws InvalidOperationException otherwise.
+ |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| AsyncDuplexStreamingCallTRequest, TResponse Methods |
The AsyncDuplexStreamingCallTRequest, TResponse generic type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Dispose |
+ Provides means to cleanup after the call.
+ If the call has already finished normally (request stream has been completed and response stream has been fully read), doesn't do anything.
+ Otherwise, requests cancellation of the call which should terminate all pending async operations associated with the call.
+ As a result, all resources being used by the call should be released eventually.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetStatus |
+ Gets the call status if the call has already finished.
+ Throws InvalidOperationException otherwise.
+ |
| GetTrailers |
+ Gets the call trailing metadata if the call has already finished.
+ Throws InvalidOperationException otherwise.
+ |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| AsyncServerStreamingCallTResponse Methods |
The AsyncServerStreamingCallTResponse generic type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Dispose |
+ Provides means to cleanup after the call.
+ If the call has already finished normally (response stream has been fully read), doesn't do anything.
+ Otherwise, requests cancellation of the call which should terminate all pending async operations associated with the call.
+ As a result, all resources being used by the call should be released eventually.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetStatus |
+ Gets the call status if the call has already finished.
+ Throws InvalidOperationException otherwise.
+ |
| GetTrailers |
+ Gets the call trailing metadata if the call has already finished.
+ Throws InvalidOperationException otherwise.
+ |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| AsyncUnaryCallTResponse Methods |
The AsyncUnaryCallTResponse generic type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Dispose |
+ Provides means to cleanup after the call.
+ If the call has already finished normally (request stream has been completed and call result has been received), doesn't do anything.
+ Otherwise, requests cancellation of the call which should terminate all pending async operations associated with the call.
+ As a result, all resources being used by the call should be released eventually.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetAwaiter |
+ Allows awaiting this object directly.
+ |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetStatus |
+ Gets the call status if the call has already finished.
+ Throws InvalidOperationException otherwise.
+ |
| GetTrailers |
+ Gets the call trailing metadata if the call has already finished.
+ Throws InvalidOperationException otherwise.
+ |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| CallInvocationDetailsTRequest, TResponse Methods |
The CallInvocationDetailsTRequest, TResponse generic type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Indicates whether this instance and a specified object are equal. (Inherited from ValueType.) |
| GetHashCode | Returns the hash code for this instance. (Inherited from ValueType.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns the fully qualified type name of this instance. (Inherited from ValueType.) |
| WithOptions |
+ Returns new instance of CallInvocationDetailsTRequest, TResponse with
+ Options set to the value provided. Values of all other fields are preserved.
+ |
See AlsogRPC C#
| CallOptions Methods |
The CallOptions type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Indicates whether this instance and a specified object are equal. (Inherited from ValueType.) |
| GetHashCode | Returns the hash code for this instance. (Inherited from ValueType.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns the fully qualified type name of this instance. (Inherited from ValueType.) |
| WithCancellationToken |
+ Returns new instance of CallOptions with
+ CancellationToken set to the value provided. Values of all other fields are preserved.
+ |
| WithDeadline |
+ Returns new instance of CallOptions with
+ Deadline set to the value provided. Values of all other fields are preserved.
+ |
| WithHeaders |
+ Returns new instance of CallOptions with
+ Headers set to the value provided. Values of all other fields are preserved.
+ |
See AlsogRPC C#
| Calls Methods |
The Calls type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| AsyncClientStreamingCallTRequest, TResponse |
+ Invokes a client streaming call asynchronously.
+ In client streaming scenario, client sends a stream of requests and server responds with a single response.
+ |
| AsyncDuplexStreamingCallTRequest, TResponse |
+ Invokes a duplex streaming call asynchronously.
+ In duplex streaming scenario, client sends a stream of requests and server responds with a stream of responses.
+ The response stream is completely independent and both side can be sending messages at the same time.
+ |
| AsyncServerStreamingCallTRequest, TResponse |
+ Invokes a server streaming call asynchronously.
+ In server streaming scenario, client sends on request and server responds with a stream of responses.
+ |
| AsyncUnaryCallTRequest, TResponse |
+ Invokes a simple remote call asynchronously.
+ |
| BlockingUnaryCallTRequest, TResponse |
+ Invokes a simple remote call in a blocking fashion.
+ |
See AlsogRPC C#
| Channel Methods |
The Channel type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| ConnectAsync |
+ Allows explicitly requesting channel to connect without starting an RPC.
+ Returned task completes once state Ready was seen. If the deadline is reached,
+ or channel enters the FatalFailure state, the task is cancelled.
+ There is no need to call this explicitly unless your use case requires that.
+ Starting an RPC on a new channel will request connection implicitly.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ShutdownAsync |
+ Waits until there are no more active calls for this channel and then cleans up
+ resources used by this channel.
+ |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| WaitForStateChangedAsync |
+ Returned tasks completes once channel state has become different from
+ given lastObservedState.
+ If deadline is reached or and error occurs, returned task is cancelled.
+ |
See AlsogRPC C#
| ChannelOption Methods |
The ChannelOption type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| ClientBase Methods |
The ClientBase type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| CreateCallTRequest, TResponse |
+ Creates a new call to given method.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| ContextPropagationOptions Methods |
The ContextPropagationOptions type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| ContextPropagationToken Methods |
The ContextPropagationToken type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| Credentials Methods |
The Credentials type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| GrpcEnvironment Methods |
The GrpcEnvironment type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetLogger |
+ Sets the application-wide logger that should be used by gRPC.
+ |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| IAsyncStreamReaderT Methods |
The IAsyncStreamReaderT generic type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
| MoveNext | (Inherited from IAsyncEnumeratorT.) |
Extension Methods| + + | Name | Description |
|---|---|---|
 | ForEachAsyncT |
+ Reads the entire stream and executes an async action for each element.
+ (Defined by AsyncStreamExtensions.) |
| ToListAsyncT |
+ Reads the entire stream and creates a list containing all the elements read.
+ (Defined by AsyncStreamExtensions.) |
See AlsogRPC C#
| IAsyncStreamWriterT Methods |
The IAsyncStreamWriterT generic type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| WriteAsync |
+ Writes a single asynchronously. Only one write can be pending at a time.
+ |
See AlsogRPC C#
| IClientStreamWriterT Methods |
The IClientStreamWriterT generic type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| CompleteAsync |
+ Completes/closes the stream. Can only be called once there is no pending write. No writes should follow calling this.
+ |
| WriteAsync |
+ Writes a single asynchronously. Only one write can be pending at a time.
+ (Inherited from IAsyncStreamWriterT.) |
Extension Methods| + + | Name | Description |
|---|---|---|
| WriteAllAsyncT |
+ Writes all elements from given enumerable to the stream.
+ Completes the stream afterwards unless close = false.
+ (Defined by AsyncStreamExtensions.) |
See AlsogRPC C#
| IServerStreamWriterT Methods |
The IServerStreamWriterT generic type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| WriteAsync |
+ Writes a single asynchronously. Only one write can be pending at a time.
+ (Inherited from IAsyncStreamWriterT.) |
Extension Methods| + + | Name | Description |
|---|---|---|
| WriteAllAsyncT |
+ Writes all elements from given enumerable to the stream.
+ (Defined by AsyncStreamExtensions.) |
See AlsogRPC C#
| KeyCertificatePair Methods |
The KeyCertificatePair type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| ConsoleLogger Methods |
The ConsoleLogger type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Debug | Logs a message with severity Debug. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Error(String, Object) | Logs a message with severity Error. |
| Error(Exception, String, Object) | Logs a message and an associated exception with severity Error. |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| ForTypeT |
+ Returns a logger associated with the specified type.
+ |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Info | Logs a message with severity Info. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Warning(String, Object) | Logs a message with severity Warning. |
| Warning(Exception, String, Object) | Logs a message and an associated exception with severity Warning. |
See AlsogRPC C#
| ILogger Methods |
The ILogger type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Debug | Logs a message with severity Debug. |
| Error(String, Object) | Logs a message with severity Error. |
| Error(Exception, String, Object) | Logs a message and an associated exception with severity Error. |
| ForTypeT | Returns a logger associated with the specified type. |
| Info | Logs a message with severity Info. |
| Warning(String, Object) | Logs a message with severity Warning. |
| Warning(Exception, String, Object) | Logs a message and an associated exception with severity Warning. |
See AlsogRPC C#
| MarshallerT Methods |
The MarshallerT generic type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Indicates whether this instance and a specified object are equal. (Inherited from ValueType.) |
| GetHashCode | Returns the hash code for this instance. (Inherited from ValueType.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns the fully qualified type name of this instance. (Inherited from ValueType.) |
See AlsogRPC C#
gRPC C#
| Metadata Methods |
The Metadata type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Add(MetadataEntry) | |
| Add(String, Byte) | |
| Add(String, String) | |
| Clear | |
| Contains | |
| CopyTo | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetEnumerator | |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IndexOf | |
| Insert | |
| Remove | |
| RemoveAt | |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| Entry Methods |
The MetadataEntry type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Indicates whether this instance and a specified object are equal. (Inherited from ValueType.) |
| GetHashCode | Returns the hash code for this instance. (Inherited from ValueType.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString |
+ Returns a String that represents the current MetadataEntry.
+ (Overrides ValueTypeToString.) |
See AlsogRPC C#
| MethodTRequest, TResponse Methods |
The MethodTRequest, TResponse generic type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| RpcException Methods |
The RpcException type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetBaseException | When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetObjectData | When overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception.) |
| GetType | Gets the runtime type of the current instance. (Inherited from Exception.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Creates and returns a string representation of the current exception. (Inherited from Exception.) |
See AlsogRPC C#
| Server Methods |
The Server type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| KillAsync |
+ Requests server shutdown while cancelling all the in-progress calls.
+ The returned task finishes when shutdown procedure is complete.
+ |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ShutdownAsync |
+ Requests server shutdown and when there are no more calls being serviced,
+ cleans up used resources. The returned task finishes when shutdown procedure
+ is complete.
+ |
| Start |
+ Starts the server.
+ |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| ServerCallContext Methods |
The ServerCallContext type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| CreatePropagationToken |
+ Creates a propagation token to be used to propagate call context to a child call.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| WriteResponseHeadersAsync |
+ Asynchronously sends response headers for the current call to the client. This method may only be invoked once for each call and needs to be invoked
+ before any response messages are written. Writing the first response message implicitly sends empty response headers if WriteResponseHeadersAsync haven't
+ been called yet.
+ |
See AlsogRPC C#
| ServerCredentials Methods |
The ServerCredentials type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| ServerPort Methods |
The ServerPort type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| ServerServiceDefinition Methods |
The ServerServiceDefinition type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| CreateBuilder |
+ Creates a new builder object for ServerServiceDefinition.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| Builder Methods |
The ServerServiceDefinitionBuilder type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| AddMethodTRequest, TResponse(MethodTRequest, TResponse, ClientStreamingServerMethodTRequest, TResponse) |
+ Adds a definitions for a client streaming method.
+ |
| AddMethodTRequest, TResponse(MethodTRequest, TResponse, DuplexStreamingServerMethodTRequest, TResponse) |
+ Adds a definitions for a bidirectional streaming method.
+ |
| AddMethodTRequest, TResponse(MethodTRequest, TResponse, ServerStreamingServerMethodTRequest, TResponse) |
+ Adds a definitions for a server streaming method.
+ |
| AddMethodTRequest, TResponse(MethodTRequest, TResponse, UnaryServerMethodTRequest, TResponse) |
+ Adds a definitions for a single request - single response method.
+ |
| Build |
+ Creates an immutable ServerServiceDefinition from this builder.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| ServerPortCollection Methods |
The ServerServerPortCollection type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Add(ServerPort) |
+ Adds a new port on which server should listen.
+ Only call this before Start().
+ Return ValueType:The port on which server will be listening. |
| Add(String, Int32, ServerCredentials) |
+ Adds a new port on which server should listen.
+ Return ValueType:The port on which server will be listening. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetEnumerator |
+ Gets enumerator for this collection.
+ |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| ServiceDefinitionCollection Methods |
The ServerServiceDefinitionCollection type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Add |
+ Adds a service definition to the server. This is how you register
+ handlers for a service with the server. Only call this before Start().
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetEnumerator |
+ Gets enumerator for this collection.
+ |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| SslCredentials Methods |
The SslCredentials type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| SslServerCredentials Methods |
The SslServerCredentials type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| Status Methods |
The Status type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Indicates whether this instance and a specified object are equal. (Inherited from ValueType.) |
| GetHashCode | Returns the hash code for this instance. (Inherited from ValueType.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | (Overrides ValueTypeToString.) |
See AlsogRPC C#
| AsyncStreamExtensions Methods |
The AsyncStreamExtensions type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| ForEachAsyncT |
+ Reads the entire stream and executes an async action for each element.
+ |
| ToListAsyncT |
+ Reads the entire stream and creates a list containing all the elements read.
+ |
| WriteAllAsyncT(IServerStreamWriterT, IEnumerableT) |
+ Writes all elements from given enumerable to the stream.
+ |
| WriteAllAsyncT(IClientStreamWriterT, IEnumerableT, Boolean) |
+ Writes all elements from given enumerable to the stream.
+ Completes the stream afterwards unless close = false.
+ |
See AlsogRPC C#
| BenchmarkUtil Methods |
The BenchmarkUtil type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| RunBenchmark |
+ Runs a simple benchmark preceded by warmup phase.
+ |
See AlsogRPC C#
| Preconditions Methods |
Methods| + + | Name | Description |
|---|---|---|
| CheckArgument(Boolean) |
+ Throws ArgumentException if condition is false.
+ |
| CheckArgument(Boolean, String) |
+ Throws ArgumentException with given message if condition is false.
+ |
| CheckNotNullT(T) |
+ Throws ArgumentNullException if reference is null.
+ |
| CheckNotNullT(T, String) |
+ Throws ArgumentNullException if reference is null.
+ |
| CheckState(Boolean) |
+ Throws InvalidOperationException if condition is false.
+ |
| CheckState(Boolean, String) |
+ Throws InvalidOperationException with given message if condition is false.
+ |
See AlsogRPC C#
| WriteOptions Methods |
The WriteOptions type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsogRPC C#
| Grpc.Auth Namespace |
Provides OAuth2 based authentication for gRPC. Grpc.Auth currently consists of a set of very lightweight wrappers and uses C# Google.Apis.Auth library.
Classes| + + | Class | Description |
|---|---|---|
 | AuthInterceptors |
+ Factory methods to create authorization interceptors. Interceptors created can be registered with gRPC client classes (autogenerated client stubs that
+ inherit from ClientBase).
+ |
gRPC C#
| Grpc.Core Namespace |
Main namespace for gRPC C# functionality. Contains concepts representing both client side and server side gRPC logic.
+
+
Classes| + + | Class | Description |
|---|---|---|
| AsyncClientStreamingCallTRequest, TResponse |
+ Return type for client streaming calls.
+ |
| AsyncDuplexStreamingCallTRequest, TResponse |
+ Return type for bidirectional streaming calls.
+ |
| AsyncServerStreamingCallTResponse |
+ Return type for server streaming calls.
+ |
| AsyncUnaryCallTResponse |
+ Return type for single request - single response call.
+ |
| Calls |
+ Helper methods for generated clients to make RPC calls.
+ Most users will use this class only indirectly and will be
+ making calls using client object generated from protocol
+ buffer definition files.
+ |
| Channel |
+ Represents a gRPC channel. Channels are an abstraction of long-lived connections to remote servers.
+ More client objects can reuse the same channel. Creating a channel is an expensive operation compared to invoking
+ a remote call so in general you should reuse a single channel for as many calls as possible.
+ |
| ChannelOption |
+ Channel option specified when creating a channel.
+ Corresponds to grpc_channel_args from grpc/grpc.h.
+ |
| ChannelOptions |
+ Defines names of supported channel options.
+ |
| ClientBase |
+ Base class for client-side stubs.
+ |
| ContextPropagationOptions |
+ Options for ContextPropagationToken.
+ |
| ContextPropagationToken |
+ Token for propagating context of server side handlers to child calls.
+ In situations when a backend is making calls to another backend,
+ it makes sense to propagate properties like deadline and cancellation
+ token of the server call to the child call.
+ The gRPC native layer provides some other contexts (like tracing context) that
+ are not accessible to explicitly C# layer, but this token still allows propagating them.
+ |
| Credentials |
+ Client-side credentials. Used for creation of a secure channel.
+ |
| GrpcEnvironment |
+ Encapsulates initialization and shutdown of gRPC library.
+ |
| KeyCertificatePair |
+ Key certificate pair (in PEM encoding).
+ |
| Marshallers |
+ Utilities for creating marshallers.
+ |
| Metadata |
+ A collection of metadata entries that can be exchanged during a call.
+ gRPC supports these types of metadata:
+
|
| MethodTRequest, TResponse |
+ A description of a remote method.
+ |
| RpcException |
+ Thrown when remote procedure call fails. Every RpcException is associated with a resulting Status of the call.
+ |
| Server |
+ gRPC server. A single server can server arbitrary number of services and can listen on more than one ports.
+ |
| ServerServerPortCollection |
+ Collection of server ports.
+ |
| ServerServiceDefinitionCollection |
+ Collection of service definitions.
+ |
| ServerCallContext |
+ Context for a server-side call.
+ |
| ServerCredentials |
+ Server side credentials.
+ |
| ServerPort |
+ A port exposed by a server.
+ |
| ServerServiceDefinition |
+ Mapping of method names to server call handlers.
+ Normally, the ServerServiceDefinition objects will be created by the BindService factory method
+ that is part of the autogenerated code for a protocol buffers service definition.
+ |
| ServerServiceDefinitionBuilder |
+ Builder class for ServerServiceDefinition.
+ |
| SslCredentials |
+ Client-side SSL credentials.
+ |
| SslServerCredentials |
+ Server-side SSL credentials.
+ |
| VersionInfo |
+ Provides info about current version of gRPC.
+ |
| WriteOptions |
+ Options for write operations.
+ |
Structures| + + | Structure | Description |
|---|---|---|
 | CallInvocationDetailsTRequest, TResponse |
+ Details about a client-side call to be invoked.
+ |
| CallOptions |
+ Options for calls made by client.
+ |
| MarshallerT |
+ Encapsulates the logic for serializing and deserializing messages.
+ |
| MetadataEntry |
+ Metadata entry
+ |
| Status |
+ Represents RPC result, which consists of StatusCode and an optional detail string.
+ |
Interfaces| + + | Interface | Description |
|---|---|---|
 | IAsyncStreamReaderT |
+ A stream of messages to be read.
+ |
| IAsyncStreamWriterT |
+ A writable stream of messages.
+ |
| IClientStreamWriterT |
+ Client-side writable stream of messages with Close capability.
+ |
| IHasWriteOptions |
+ Allows sharing write options between ServerCallContext and other objects.
+ |
| IMethod |
+ A non-generic representation of a remote method.
+ |
| IServerStreamWriterT |
+ A writable stream of messages that is used in server-side handlers.
+ |
Delegates| + + | Delegate | Description |
|---|---|---|
 | ClientStreamingServerMethodTRequest, TResponse |
+ Server-side handler for client streaming call.
+ |
| DuplexStreamingServerMethodTRequest, TResponse |
+ Server-side handler for bidi streaming call.
+ |
| HeaderInterceptor |
+ Interceptor for call headers.
+ |
| ServerStreamingServerMethodTRequest, TResponse |
+ Server-side handler for server streaming call.
+ |
| UnaryServerMethodTRequest, TResponse |
+ Server-side handler for unary call.
+ |
Enumerations| + + | Enumeration | Description |
|---|---|---|
 | ChannelOptionOptionType |
+ Type of ChannelOption.
+ |
| ChannelState |
+ Connectivity state of a channel.
+ Based on grpc_connectivity_state from grpc/grpc.h
+ |
| CompressionLevel |
+ Compression level based on grpc_compression_level from grpc/compression.h
+ |
| MethodType |
+ Method types supported by gRPC.
+ |
| StatusCode |
+ Result of a remote procedure call.
+ Based on grpc_status_code from grpc/status.h
+ |
| WriteFlags |
+ Flags for write operations.
+ |
See AlsoReference
[Grpc.Core.Channel]
[Grpc.Core.Server]
gRPC C#
| Grpc.Core.Logging Namespace |
Provides functionality to redirect gRPC logs to application-specified destination.
Classes| + + | Class | Description |
|---|---|---|
| ConsoleLogger | Logger that logs to System.Console. |
Interfaces| + + | Interface | Description |
|---|---|---|
| ILogger | For logging messages. |
gRPC C#
| Grpc.Core.Utils Namespace |
Various utilities for gRPC C#.
Classes| + + | Class | Description |
|---|---|---|
| AsyncStreamExtensions |
+ Extension methods that simplify work with gRPC streaming calls.
+ |
| BenchmarkUtil |
+ Utility methods to run microbenchmarks.
+ |
| Preconditions |
+ Utility methods to simplify checking preconditions in the code.
+ |
gRPC C#
| CallInvocationDetailsTRequest, TResponse Constructor |
Overload List| + + | Name | Description |
|---|---|---|
| CallInvocationDetailsTRequest, TResponse(Channel, MethodTRequest, TResponse, CallOptions) |
+ Initializes a new instance of the CallInvocationDetailsTRequest, TResponse struct.
+ |
| CallInvocationDetailsTRequest, TResponse(Channel, MethodTRequest, TResponse, String, CallOptions) |
+ Initializes a new instance of the CallInvocationDetailsTRequest, TResponse struct.
+ |
| CallInvocationDetailsTRequest, TResponse(Channel, String, String, MarshallerTRequest, MarshallerTResponse, CallOptions) |
+ Initializes a new instance of the CallInvocationDetailsTRequest, TResponse struct.
+ |
See AlsogRPC C#
| ChannelOption Constructor |
Overload List| + + | Name | Description |
|---|---|---|
| ChannelOption(String, Int32) |
+ Creates a channel option with an integer value.
+ |
| ChannelOption(String, String) |
+ Creates a channel option with a string value.
+ |
See AlsogRPC C#
| Channel Constructor |
Overload List| + + | Name | Description |
|---|---|---|
| Channel(String, Credentials, IEnumerableChannelOption) |
+ Creates a channel that connects to a specific host.
+ Port will default to 80 for an unsecure channel and to 443 for a secure channel.
+ |
| Channel(String, Int32, Credentials, IEnumerableChannelOption) |
+ Creates a channel that connects to a specific host and port.
+ |
See AlsogRPC C#
| ConsoleLoggerError Method |
Overload List| + + | Name | Description |
|---|---|---|
| Error(String, Object) | Logs a message with severity Error. |
| Error(Exception, String, Object) | Logs a message and an associated exception with severity Error. |
See AlsogRPC C#
| ConsoleLoggerWarning Method |
Overload List| + + | Name | Description |
|---|---|---|
| Warning(String, Object) | Logs a message with severity Warning. |
| Warning(Exception, String, Object) | Logs a message and an associated exception with severity Warning. |
See AlsogRPC C#
| ILoggerError Method |
Overload List| + + | Name | Description |
|---|---|---|
| Error(String, Object) | Logs a message with severity Error. |
| Error(Exception, String, Object) | Logs a message and an associated exception with severity Error. |
See AlsogRPC C#
| ILoggerWarning Method |
Overload List| + + | Name | Description |
|---|---|---|
| Warning(String, Object) | Logs a message with severity Warning. |
| Warning(Exception, String, Object) | Logs a message and an associated exception with severity Warning. |
See AlsogRPC C#
| MetadataAdd Method |
Overload List| + + | Name | Description |
|---|---|---|
| Add(MetadataEntry) | |
| Add(String, Byte) | |
| Add(String, String) |
See AlsogRPC C#
| Entry Constructor |
Overload List| + + | Name | Description |
|---|---|---|
| MetadataEntry(String, Byte) |
+ Initializes a new instance of the MetadataEntry struct with a binary value.
+ |
| MetadataEntry(String, String) |
+ Initializes a new instance of the MetadataEntry struct holding an ASCII value.
+ |
See AlsogRPC C#
| RpcException Constructor |
Overload List| + + | Name | Description |
|---|---|---|
| RpcException(Status) |
+ Creates a new RpcException associated with given status.
+ |
| RpcException(Status, String) |
+ Creates a new RpcException associated with given status and message.
+ |
See AlsogRPC C#
| BuilderAddMethod Method |
Overload List| + + | Name | Description |
|---|---|---|
| AddMethodTRequest, TResponse(MethodTRequest, TResponse, ClientStreamingServerMethodTRequest, TResponse) |
+ Adds a definitions for a client streaming method.
+ |
| AddMethodTRequest, TResponse(MethodTRequest, TResponse, DuplexStreamingServerMethodTRequest, TResponse) |
+ Adds a definitions for a bidirectional streaming method.
+ |
| AddMethodTRequest, TResponse(MethodTRequest, TResponse, ServerStreamingServerMethodTRequest, TResponse) |
+ Adds a definitions for a server streaming method.
+ |
| AddMethodTRequest, TResponse(MethodTRequest, TResponse, UnaryServerMethodTRequest, TResponse) |
+ Adds a definitions for a single request - single response method.
+ |
See AlsogRPC C#
| ServerPortCollectionAdd Method |
Overload List| + + | Name | Description |
|---|---|---|
| Add(ServerPort) |
+ Adds a new port on which server should listen.
+ Only call this before Start().
+ Return ValueType:The port on which server will be listening. |
| Add(String, Int32, ServerCredentials) |
+ Adds a new port on which server should listen.
+ Return ValueType:The port on which server will be listening. |
See AlsogRPC C#
| SslCredentials Constructor |
Overload List| + + | Name | Description |
|---|---|---|
| SslCredentials |
+ Creates client-side SSL credentials loaded from
+ disk file pointed to by the GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment variable.
+ If that fails, gets the roots certificates from a well known place on disk.
+ |
| SslCredentials(String) |
+ Creates client-side SSL credentials from
+ a string containing PEM encoded root certificates.
+ |
| SslCredentials(String, KeyCertificatePair) |
+ Creates client-side SSL credentials.
+ |
See AlsogRPC C#
| SslServerCredentials Constructor |
Overload List| + + | Name | Description |
|---|---|---|
| SslServerCredentials(IEnumerableKeyCertificatePair) |
+ Creates server-side SSL credentials.
+ This constructor should be use if you do not wish to autheticate client
+ using client root certificates.
+ |
| SslServerCredentials(IEnumerableKeyCertificatePair, String, Boolean) |
+ Creates server-side SSL credentials.
+ |
See AlsogRPC C#
| AsyncStreamExtensionsWriteAllAsync Method |
Overload List| + + | Name | Description |
|---|---|---|
| WriteAllAsyncT(IServerStreamWriterT, IEnumerableT) |
+ Writes all elements from given enumerable to the stream.
+ |
| WriteAllAsyncT(IClientStreamWriterT, IEnumerableT, Boolean) |
+ Writes all elements from given enumerable to the stream.
+ Completes the stream afterwards unless close = false.
+ |
See AlsogRPC C#
| PreconditionsCheckArgument Method |
Overload List| + + | Name | Description |
|---|---|---|
| CheckArgument(Boolean) |
+ Throws ArgumentException if condition is false.
+ |
| CheckArgument(Boolean, String) |
+ Throws ArgumentException with given message if condition is false.
+ |
See AlsogRPC C#
| PreconditionsCheckNotNull Method |
Overload List| + + | Name | Description |
|---|---|---|
| CheckNotNullT(T) |
+ Throws ArgumentNullException if reference is null.
+ |
| CheckNotNullT(T, String) |
+ Throws ArgumentNullException if reference is null.
+ |
See AlsogRPC C#
| PreconditionsCheckState Method |
Overload List| + + | Name | Description |
|---|---|---|
| CheckState(Boolean) |
+ Throws InvalidOperationException if condition is false.
+ |
| CheckState(Boolean, String) |
+ Throws InvalidOperationException with given message if condition is false.
+ |
See AlsogRPC C#
| AsyncClientStreamingCallTRequest, TResponseRequestStream Property |
+ Async stream to send streaming requests.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncClientStreamingCallTRequest, TResponseResponseAsync Property |
+ Asynchronous call result.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncClientStreamingCallTRequest, TResponseResponseHeadersAsync Property |
+ Asynchronous access to response headers.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncDuplexStreamingCallTRequest, TResponseRequestStream Property |
+ Async stream to send streaming requests.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncDuplexStreamingCallTRequest, TResponseResponseHeadersAsync Property |
+ Asynchronous access to response headers.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncDuplexStreamingCallTRequest, TResponseResponseStream Property |
+ Async stream to read streaming responses.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncServerStreamingCallTResponseResponseHeadersAsync Property |
+ Asynchronous access to response headers.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncServerStreamingCallTResponseResponseStream Property |
+ Async stream to read streaming responses.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncUnaryCallTResponseResponseAsync Property |
+ Asynchronous call result.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncUnaryCallTResponseResponseHeadersAsync Property |
+ Asynchronous access to response headers.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| CallInvocationDetailsTRequest, TResponseChannel Property |
+ Get channel associated with this call.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| CallInvocationDetailsTRequest, TResponseHost Property |
+ Get name of host.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| CallInvocationDetailsTRequest, TResponseMethod Property |
+ Gets name of method to be called.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| CallInvocationDetailsTRequest, TResponseOptions Property |
+ Gets the call options.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| CallInvocationDetailsTRequest, TResponseRequestMarshaller Property |
+ Gets marshaller used to serialize requests.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| CallInvocationDetailsTRequest, TResponseResponseMarshaller Property |
+ Gets marshaller used to deserialized responses.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| CallOptionsCancellationToken Property |
+ Token that can be used for cancelling the call.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxProperty Value
Type: CancellationTokenSee AlsogRPC C#
| CallOptionsDeadline Property |
+ Call deadline.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| CallOptionsHeaders Property |
+ Headers to send at the beginning of the call.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| CallOptionsPropagationToken Property |
+ Token for propagating parent call context.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxProperty Value
Type: ContextPropagationTokenSee AlsogRPC C#
| CallOptionsWriteOptions Property |
+ Write options that will be used for this call.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ChannelOptionIntValue Property |
+ Gets the integer value the ChannelOption.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ChannelOptionName Property |
+ Gets the name of the ChannelOption.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ChannelOptionStringValue Property |
+ Gets the string value the ChannelOption.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ChannelOptionType Property |
+ Gets the type of the ChannelOption.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxProperty Value
Type: ChannelOptionOptionTypeSee AlsogRPC C#
| ChannelResolvedTarget Property |
Resolved address of the remote endpoint in URI format.
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ChannelState Property |
+ Gets current connectivity state of this channel.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ChannelTarget Property |
The original target used to create the channel.
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ClientBaseChannel Property |
+ Channel associated with this client.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ClientBaseHeaderInterceptor Property |
+ Can be used to register a custom header (request metadata) interceptor.
+ The interceptor is invoked each time a new call on this client is started.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxProperty Value
Type: HeaderInterceptorSee AlsogRPC C#
| ClientBaseHost Property |
+ gRPC supports multiple "hosts" being served by a single server.
+ This property can be used to set the target host explicitly.
+ By default, this will be set to null with the meaning
+ "use default host".
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ContextPropagationOptionsIsPropagateCancellation Property |
true if parent call's cancellation token should be propagated to the child call.
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ContextPropagationOptionsIsPropagateDeadline Property |
true if parent call's deadline should be propagated to the child call.
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| CredentialsInsecure Property |
+ Returns instance of credential that provides no security and
+ will result in creating an unsecure channel with no encryption whatsoever.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| GrpcEnvironmentLogger Property |
+ Gets application-wide logger used by gRPC.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| IAsyncStreamWriterTWriteOptions Property |
+ Write options that will be used for the next write.
+ If null, default options will be used.
+ Once set, this property maintains its value across subsequent
+ writes.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| IHasWriteOptionsWriteOptions Property |
+ Gets or sets the write options.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| IMethodFullName Property |
+ Gets the fully qualified name of the method. On the server side, methods are dispatched
+ based on this name.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| IMethodName Property |
+ Gets the unqualified name of the method.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| IMethodServiceName Property |
+ Gets the name of the service to which this method belongs.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| IMethodType Property |
+ Gets the type of the method.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| KeyCertificatePairCertificateChain Property |
+ PEM encoded certificate chain.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| KeyCertificatePairPrivateKey Property |
+ PEM encoded private key.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
gRPC C#
gRPC C#
| MarshallersStringMarshaller Property |
+ Returns a marshaller for string type. This is useful for testing.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MetadataCount Property |
[Missing <summary> documentation for "P:Grpc.Core.Metadata.Count"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MetadataEntryIsBinary Property |
+ Returns true if this entry is a binary-value entry.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MetadataEntryKey Property |
+ Gets the metadata entry key.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MetadataEntryValue Property |
+ Gets the string value of this metadata entry.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MetadataEntryValueBytes Property |
+ Gets the binary value of this metadata entry.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MetadataIsReadOnly Property |
[Missing <summary> documentation for "P:Grpc.Core.Metadata.IsReadOnly"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MetadataItem Property |
[Missing <summary> documentation for "P:Grpc.Core.Metadata.Item(System.Int32)"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MethodTRequest, TResponseFullName Property |
+ Gets the fully qualified name of the method. On the server side, methods are dispatched
+ based on this name.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MethodTRequest, TResponseName Property |
+ Gets the unqualified name of the method.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MethodTRequest, TResponseRequestMarshaller Property |
+ Gets the marshaller used for request messages.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MethodTRequest, TResponseResponseMarshaller Property |
+ Gets the marshaller used for response messages.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MethodTRequest, TResponseServiceName Property |
+ Gets the name of the service to which this method belongs.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| MethodTRequest, TResponseType Property |
+ Gets the type of the method.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| RpcExceptionStatus Property |
+ Resulting status of the call.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerCallContextCancellationToken Property |
Cancellation token signals when call is cancelled.
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxProperty Value
Type: CancellationTokenSee AlsogRPC C#
| ServerCallContextDeadline Property |
Deadline for this RPC.
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerCallContextHost Property |
Name of host called in this RPC.
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerCallContextMethod Property |
Name of method called in this RPC.
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerCallContextPeer Property |
Address of the remote endpoint in URI format.
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerCallContextRequestHeaders Property |
Initial metadata sent by client.
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerCallContextResponseTrailers Property |
Trailers to send back to client after RPC finishes.
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerCallContextStatus Property |
Status to send back to client after RPC finishes.
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerCallContextWriteOptions Property |
+ Allows setting write options for the following write.
+ For streaming response calls, this property is also exposed as on IServerStreamWriter for convenience.
+ Both properties are backed by the same underlying value.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerCredentialsInsecure Property |
+ Returns instance of credential that provides no security and
+ will result in creating an unsecure server port with no encryption whatsoever.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerPortBoundPort Property |
[Missing <summary> documentation for "P:Grpc.Core.ServerPort.BoundPort"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxProperty Value
Type: Int32+ The port actually bound by the server. This is useful if you let server + pick port automatically. PickUnused
See AlsogRPC C#
| ServerPortCredentials Property |
[Missing <summary> documentation for "P:Grpc.Core.ServerPort.Credentials"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerPortHost Property |
[Missing <summary> documentation for "P:Grpc.Core.ServerPort.Host"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerPortPort Property |
[Missing <summary> documentation for "P:Grpc.Core.ServerPort.Port"]
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| ServerPorts Property |
+ Ports on which the server will listen once started. Register a port with this
+ server by adding its definition to this collection.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxProperty Value
Type: ServerServerPortCollectionSee AlsogRPC C#
| ServerServices Property |
+ Services that will be exported by the server once started. Register a service with this
+ server by adding its definition to this collection.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxProperty Value
Type: ServerServiceDefinitionCollectionSee AlsogRPC C#
| ServerShutdownTask Property |
+ To allow awaiting termination of the server.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| SslCredentialsKeyCertificatePair Property |
+ Client side key and certificate pair.
+ If null, client will not use key and certificate pair.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxProperty Value
Type: KeyCertificatePairSee AlsogRPC C#
| SslCredentialsRootCertificates Property |
+ PEM encoding of the server root certificates.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| SslServerCredentialsForceClientAuthentication Property |
+ If true, the authenticity of client check will be enforced.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| SslServerCredentialsKeyCertificatePairs Property |
+ Key-certificate pairs.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| SslServerCredentialsRootCertificates Property |
+ PEM encoded client root certificates.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| StatusDetail Property |
+ Gets the detail.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| StatusStatusCode Property |
+ Gets the gRPC status code. OK indicates success, all other values indicate an error.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| WriteOptionsFlags Property |
+ Gets the write flags.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxSee AlsogRPC C#
| AsyncClientStreamingCallTRequest, TResponse Properties |
The AsyncClientStreamingCallTRequest, TResponse generic type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
 | RequestStream |
+ Async stream to send streaming requests.
+ |
| ResponseAsync |
+ Asynchronous call result.
+ |
| ResponseHeadersAsync |
+ Asynchronous access to response headers.
+ |
See AlsogRPC C#
| AsyncDuplexStreamingCallTRequest, TResponse Properties |
The AsyncDuplexStreamingCallTRequest, TResponse generic type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| RequestStream |
+ Async stream to send streaming requests.
+ |
| ResponseHeadersAsync |
+ Asynchronous access to response headers.
+ |
| ResponseStream |
+ Async stream to read streaming responses.
+ |
See AlsogRPC C#
| AsyncServerStreamingCallTResponse Properties |
The AsyncServerStreamingCallTResponse generic type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| ResponseHeadersAsync |
+ Asynchronous access to response headers.
+ |
| ResponseStream |
+ Async stream to read streaming responses.
+ |
See AlsogRPC C#
| AsyncUnaryCallTResponse Properties |
The AsyncUnaryCallTResponse generic type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| ResponseAsync |
+ Asynchronous call result.
+ |
| ResponseHeadersAsync |
+ Asynchronous access to response headers.
+ |
See AlsogRPC C#
| CallInvocationDetailsTRequest, TResponse Properties |
The CallInvocationDetailsTRequest, TResponse generic type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| Channel |
+ Get channel associated with this call.
+ |
| Host |
+ Get name of host.
+ |
| Method |
+ Gets name of method to be called.
+ |
| Options |
+ Gets the call options.
+ |
| RequestMarshaller |
+ Gets marshaller used to serialize requests.
+ |
| ResponseMarshaller |
+ Gets marshaller used to deserialized responses.
+ |
See AlsogRPC C#
| CallOptions Properties |
The CallOptions type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| CancellationToken |
+ Token that can be used for cancelling the call.
+ |
| Deadline |
+ Call deadline.
+ |
| Headers |
+ Headers to send at the beginning of the call.
+ |
| PropagationToken |
+ Token for propagating parent call context.
+ |
| WriteOptions |
+ Write options that will be used for this call.
+ |
See AlsogRPC C#
| Channel Properties |
The Channel type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| ResolvedTarget | Resolved address of the remote endpoint in URI format. |
| State |
+ Gets current connectivity state of this channel.
+ |
| Target | The original target used to create the channel. |
See AlsogRPC C#
| ChannelOption Properties |
The ChannelOption type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| IntValue |
+ Gets the integer value the ChannelOption.
+ |
| Name |
+ Gets the name of the ChannelOption.
+ |
| StringValue |
+ Gets the string value the ChannelOption.
+ |
| Type |
+ Gets the type of the ChannelOption.
+ |
See AlsogRPC C#
| ClientBase Properties |
The ClientBase type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| Channel |
+ Channel associated with this client.
+ |
| HeaderInterceptor |
+ Can be used to register a custom header (request metadata) interceptor.
+ The interceptor is invoked each time a new call on this client is started.
+ |
| Host |
+ gRPC supports multiple "hosts" being served by a single server.
+ This property can be used to set the target host explicitly.
+ By default, this will be set to null with the meaning
+ "use default host".
+ |
See AlsogRPC C#
| ContextPropagationOptions Properties |
The ContextPropagationOptions type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| IsPropagateCancellation | true if parent call's cancellation token should be propagated to the child call. |
| IsPropagateDeadline | true if parent call's deadline should be propagated to the child call. |
See AlsogRPC C#
| Credentials Properties |
The Credentials type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| Insecure |
+ Returns instance of credential that provides no security and
+ will result in creating an unsecure channel with no encryption whatsoever.
+ |
See AlsogRPC C#
gRPC C#
| IAsyncStreamReaderT Properties |
The IAsyncStreamReaderT generic type exposes the following members.
PropertiesSee AlsogRPC C#
| IAsyncStreamWriterT Properties |
The IAsyncStreamWriterT generic type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| WriteOptions |
+ Write options that will be used for the next write.
+ If null, default options will be used.
+ Once set, this property maintains its value across subsequent
+ writes.
+ |
See AlsogRPC C#
| IClientStreamWriterT Properties |
The IClientStreamWriterT generic type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| WriteOptions |
+ Write options that will be used for the next write.
+ If null, default options will be used.
+ Once set, this property maintains its value across subsequent
+ writes.
+ (Inherited from IAsyncStreamWriterT.) |
See AlsogRPC C#
| IHasWriteOptions Properties |
The IHasWriteOptions type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| WriteOptions |
+ Gets or sets the write options.
+ |
See AlsogRPC C#
| IMethod Properties |
The IMethod type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| FullName |
+ Gets the fully qualified name of the method. On the server side, methods are dispatched
+ based on this name.
+ |
| Name |
+ Gets the unqualified name of the method.
+ |
| ServiceName |
+ Gets the name of the service to which this method belongs.
+ |
| Type |
+ Gets the type of the method.
+ |
See AlsogRPC C#
| IServerStreamWriterT Properties |
The IServerStreamWriterT generic type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| WriteOptions |
+ Write options that will be used for the next write.
+ If null, default options will be used.
+ Once set, this property maintains its value across subsequent
+ writes.
+ (Inherited from IAsyncStreamWriterT.) |
See AlsogRPC C#
| KeyCertificatePair Properties |
The KeyCertificatePair type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| CertificateChain |
+ PEM encoded certificate chain.
+ |
| PrivateKey |
+ PEM encoded private key.
+ |
See AlsogRPC C#
| MarshallerT Properties |
The MarshallerT generic type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| Deserializer |
+ Gets the deserializer function.
+ |
| Serializer |
+ Gets the serializer function.
+ |
See AlsogRPC C#
| Marshallers Properties |
The Marshallers type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| StringMarshaller |
+ Returns a marshaller for string type. This is useful for testing.
+ |
See AlsogRPC C#
| Metadata Properties |
The Metadata type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| Count | |
| IsReadOnly | |
| Item |
See AlsogRPC C#
| Entry Properties |
The MetadataEntry type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| IsBinary |
+ Returns true if this entry is a binary-value entry.
+ |
| Key |
+ Gets the metadata entry key.
+ |
| Value |
+ Gets the string value of this metadata entry.
+ |
| ValueBytes |
+ Gets the binary value of this metadata entry.
+ |
See AlsogRPC C#
| MethodTRequest, TResponse Properties |
The MethodTRequest, TResponse generic type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| FullName |
+ Gets the fully qualified name of the method. On the server side, methods are dispatched
+ based on this name.
+ |
| Name |
+ Gets the unqualified name of the method.
+ |
| RequestMarshaller |
+ Gets the marshaller used for request messages.
+ |
| ResponseMarshaller |
+ Gets the marshaller used for response messages.
+ |
| ServiceName |
+ Gets the name of the service to which this method belongs.
+ |
| Type |
+ Gets the type of the method.
+ |
See AlsogRPC C#
| RpcException Properties |
The RpcException type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| Data | Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.) |
| HelpLink | Gets or sets a link to the help file associated with this exception. (Inherited from Exception.) |
| HResult | Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.) |
| InnerException | Gets the Exception instance that caused the current exception. (Inherited from Exception.) |
| Message | Gets a message that describes the current exception. (Inherited from Exception.) |
| Source | Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.) |
| StackTrace | Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.) |
| Status |
+ Resulting status of the call.
+ |
| TargetSite | Gets the method that throws the current exception. (Inherited from Exception.) |
See AlsogRPC C#
| Server Properties |
The Server type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| Ports |
+ Ports on which the server will listen once started. Register a port with this
+ server by adding its definition to this collection.
+ |
| Services |
+ Services that will be exported by the server once started. Register a service with this
+ server by adding its definition to this collection.
+ |
| ShutdownTask |
+ To allow awaiting termination of the server.
+ |
See AlsogRPC C#
| ServerCallContext Properties |
The ServerCallContext type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| CancellationToken | Cancellation token signals when call is cancelled. |
| Deadline | Deadline for this RPC. |
| Host | Name of host called in this RPC. |
| Method | Name of method called in this RPC. |
| Peer | Address of the remote endpoint in URI format. |
| RequestHeaders | Initial metadata sent by client. |
| ResponseTrailers | Trailers to send back to client after RPC finishes. |
| Status | Status to send back to client after RPC finishes. |
| WriteOptions |
+ Allows setting write options for the following write.
+ For streaming response calls, this property is also exposed as on IServerStreamWriter for convenience.
+ Both properties are backed by the same underlying value.
+ |
See AlsogRPC C#
| ServerCredentials Properties |
The ServerCredentials type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| Insecure |
+ Returns instance of credential that provides no security and
+ will result in creating an unsecure server port with no encryption whatsoever.
+ |
See AlsogRPC C#
| ServerPort Properties |
The ServerPort type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| BoundPort | |
| Credentials | |
| Host | |
| Port |
See AlsogRPC C#
| SslCredentials Properties |
The SslCredentials type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| KeyCertificatePair |
+ Client side key and certificate pair.
+ If null, client will not use key and certificate pair.
+ |
| RootCertificates |
+ PEM encoding of the server root certificates.
+ |
See AlsogRPC C#
| SslServerCredentials Properties |
The SslServerCredentials type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| ForceClientAuthentication |
+ If true, the authenticity of client check will be enforced.
+ |
| KeyCertificatePairs |
+ Key-certificate pairs.
+ |
| RootCertificates |
+ PEM encoded client root certificates.
+ |
See AlsogRPC C#
| Status Properties |
The Status type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| Detail |
+ Gets the detail.
+ |
| StatusCode |
+ Gets the gRPC status code. OK indicates success, all other values indicate an error.
+ |
See AlsogRPC C#
gRPC C#
| Namespaces |
Namespaces| Namespace | Description |
|---|---|
| Grpc.Auth | Provides OAuth2 based authentication for gRPC. Grpc.Auth currently consists of a set of very lightweight wrappers and uses C# Google.Apis.Auth library. |
| Grpc.Core | Main namespace for gRPC C# functionality. Contains concepts representing both client side and server side gRPC logic.
+
+ |
| Grpc.Core.Logging | Provides functionality to redirect gRPC logs to application-specified destination. |
| Grpc.Core.Utils | Various utilities for gRPC C#. |
gRPC C#
| AuthInterceptors Class |
+ Factory methods to create authorization interceptors. Interceptors created can be registered with gRPC client classes (autogenerated client stubs that
+ inherit from ClientBase).
+
Inheritance HierarchyNamespace: Grpc.Auth
Assembly: Grpc.Auth (in Grpc.Auth.dll) Version: 0.6.1.0
SyntaxThe AuthInterceptors type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| FromAccessToken |
+ Creates OAuth2 interceptor that will use given access token as authorization.
+ |
| FromCredential |
+ Creates interceptor that will obtain access token from any credential type that implements
+ ITokenAccess. (e.g. GoogleCredential).
+ |
See AlsoReference
gRPC C#
| AsyncClientStreamingCallTRequest, TResponse Class |
+ Return type for client streaming calls.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxType Parameters
- TRequest
- Request message type for this call.
- TResponse
- Response message type for this call.
The AsyncClientStreamingCallTRequest, TResponse type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| RequestStream |
+ Async stream to send streaming requests.
+ |
| ResponseAsync |
+ Asynchronous call result.
+ |
| ResponseHeadersAsync |
+ Asynchronous access to response headers.
+ |
Methods| + + | Name | Description |
|---|---|---|
| Dispose |
+ Provides means to cleanup after the call.
+ If the call has already finished normally (request stream has been completed and call result has been received), doesn't do anything.
+ Otherwise, requests cancellation of the call which should terminate all pending async operations associated with the call.
+ As a result, all resources being used by the call should be released eventually.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetAwaiter |
+ Allows awaiting this object directly.
+ |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetStatus |
+ Gets the call status if the call has already finished.
+ Throws InvalidOperationException otherwise.
+ |
| GetTrailers |
+ Gets the call trailing metadata if the call has already finished.
+ Throws InvalidOperationException otherwise.
+ |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| AsyncDuplexStreamingCallTRequest, TResponse Class |
+ Return type for bidirectional streaming calls.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxType Parameters
- TRequest
- Request message type for this call.
- TResponse
- Response message type for this call.
The AsyncDuplexStreamingCallTRequest, TResponse type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| RequestStream |
+ Async stream to send streaming requests.
+ |
| ResponseHeadersAsync |
+ Asynchronous access to response headers.
+ |
| ResponseStream |
+ Async stream to read streaming responses.
+ |
Methods| + + | Name | Description |
|---|---|---|
| Dispose |
+ Provides means to cleanup after the call.
+ If the call has already finished normally (request stream has been completed and response stream has been fully read), doesn't do anything.
+ Otherwise, requests cancellation of the call which should terminate all pending async operations associated with the call.
+ As a result, all resources being used by the call should be released eventually.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetStatus |
+ Gets the call status if the call has already finished.
+ Throws InvalidOperationException otherwise.
+ |
| GetTrailers |
+ Gets the call trailing metadata if the call has already finished.
+ Throws InvalidOperationException otherwise.
+ |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| AsyncServerStreamingCallTResponse Class |
+ Return type for server streaming calls.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxType Parameters
- TResponse
- Response message type for this call.
The AsyncServerStreamingCallTResponse type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| ResponseHeadersAsync |
+ Asynchronous access to response headers.
+ |
| ResponseStream |
+ Async stream to read streaming responses.
+ |
Methods| + + | Name | Description |
|---|---|---|
| Dispose |
+ Provides means to cleanup after the call.
+ If the call has already finished normally (response stream has been fully read), doesn't do anything.
+ Otherwise, requests cancellation of the call which should terminate all pending async operations associated with the call.
+ As a result, all resources being used by the call should be released eventually.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetStatus |
+ Gets the call status if the call has already finished.
+ Throws InvalidOperationException otherwise.
+ |
| GetTrailers |
+ Gets the call trailing metadata if the call has already finished.
+ Throws InvalidOperationException otherwise.
+ |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| AsyncUnaryCallTResponse Class |
+ Return type for single request - single response call.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxType Parameters
- TResponse
- Response message type for this call.
The AsyncUnaryCallTResponse type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| ResponseAsync |
+ Asynchronous call result.
+ |
| ResponseHeadersAsync |
+ Asynchronous access to response headers.
+ |
Methods| + + | Name | Description |
|---|---|---|
| Dispose |
+ Provides means to cleanup after the call.
+ If the call has already finished normally (request stream has been completed and call result has been received), doesn't do anything.
+ Otherwise, requests cancellation of the call which should terminate all pending async operations associated with the call.
+ As a result, all resources being used by the call should be released eventually.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetAwaiter |
+ Allows awaiting this object directly.
+ |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetStatus |
+ Gets the call status if the call has already finished.
+ Throws InvalidOperationException otherwise.
+ |
| GetTrailers |
+ Gets the call trailing metadata if the call has already finished.
+ Throws InvalidOperationException otherwise.
+ |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| CallInvocationDetailsTRequest, TResponse Structure |
+ Details about a client-side call to be invoked.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxType Parameters
- TRequest
- Request message type for the call.
- TResponse
- Response message type for the call.
The CallInvocationDetailsTRequest, TResponse type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| CallInvocationDetailsTRequest, TResponse(Channel, MethodTRequest, TResponse, CallOptions) |
+ Initializes a new instance of the CallInvocationDetailsTRequest, TResponse struct.
+ |
| CallInvocationDetailsTRequest, TResponse(Channel, MethodTRequest, TResponse, String, CallOptions) |
+ Initializes a new instance of the CallInvocationDetailsTRequest, TResponse struct.
+ |
| CallInvocationDetailsTRequest, TResponse(Channel, String, String, MarshallerTRequest, MarshallerTResponse, CallOptions) |
+ Initializes a new instance of the CallInvocationDetailsTRequest, TResponse struct.
+ |
Properties| + + | Name | Description |
|---|---|---|
| Channel |
+ Get channel associated with this call.
+ |
| Host |
+ Get name of host.
+ |
| Method |
+ Gets name of method to be called.
+ |
| Options |
+ Gets the call options.
+ |
| RequestMarshaller |
+ Gets marshaller used to serialize requests.
+ |
| ResponseMarshaller |
+ Gets marshaller used to deserialized responses.
+ |
Methods| + + | Name | Description |
|---|---|---|
| Equals | Indicates whether this instance and a specified object are equal. (Inherited from ValueType.) |
| GetHashCode | Returns the hash code for this instance. (Inherited from ValueType.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns the fully qualified type name of this instance. (Inherited from ValueType.) |
| WithOptions |
+ Returns new instance of CallInvocationDetailsTRequest, TResponse with
+ Options set to the value provided. Values of all other fields are preserved.
+ |
See AlsoReference
gRPC C#
| CallOptions Structure |
+ Options for calls made by client.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe CallOptions type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| CallOptions |
+ Creates a new instance of CallOptions struct.
+ |
Properties| + + | Name | Description |
|---|---|---|
| CancellationToken |
+ Token that can be used for cancelling the call.
+ |
| Deadline |
+ Call deadline.
+ |
| Headers |
+ Headers to send at the beginning of the call.
+ |
| PropagationToken |
+ Token for propagating parent call context.
+ |
| WriteOptions |
+ Write options that will be used for this call.
+ |
Methods| + + | Name | Description |
|---|---|---|
| Equals | Indicates whether this instance and a specified object are equal. (Inherited from ValueType.) |
| GetHashCode | Returns the hash code for this instance. (Inherited from ValueType.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns the fully qualified type name of this instance. (Inherited from ValueType.) |
| WithCancellationToken |
+ Returns new instance of CallOptions with
+ CancellationToken set to the value provided. Values of all other fields are preserved.
+ |
| WithDeadline |
+ Returns new instance of CallOptions with
+ Deadline set to the value provided. Values of all other fields are preserved.
+ |
| WithHeaders |
+ Returns new instance of CallOptions with
+ Headers set to the value provided. Values of all other fields are preserved.
+ |
See AlsoReference
gRPC C#
| Calls Class |
+ Helper methods for generated clients to make RPC calls.
+ Most users will use this class only indirectly and will be
+ making calls using client object generated from protocol
+ buffer definition files.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe Calls type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| AsyncClientStreamingCallTRequest, TResponse |
+ Invokes a client streaming call asynchronously.
+ In client streaming scenario, client sends a stream of requests and server responds with a single response.
+ |
| AsyncDuplexStreamingCallTRequest, TResponse |
+ Invokes a duplex streaming call asynchronously.
+ In duplex streaming scenario, client sends a stream of requests and server responds with a stream of responses.
+ The response stream is completely independent and both side can be sending messages at the same time.
+ |
| AsyncServerStreamingCallTRequest, TResponse |
+ Invokes a server streaming call asynchronously.
+ In server streaming scenario, client sends on request and server responds with a stream of responses.
+ |
| AsyncUnaryCallTRequest, TResponse |
+ Invokes a simple remote call asynchronously.
+ |
| BlockingUnaryCallTRequest, TResponse |
+ Invokes a simple remote call in a blocking fashion.
+ |
See AlsoReference
gRPC C#
| Channel Class |
+ Represents a gRPC channel. Channels are an abstraction of long-lived connections to remote servers.
+ More client objects can reuse the same channel. Creating a channel is an expensive operation compared to invoking
+ a remote call so in general you should reuse a single channel for as many calls as possible.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe Channel type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| Channel(String, Credentials, IEnumerableChannelOption) |
+ Creates a channel that connects to a specific host.
+ Port will default to 80 for an unsecure channel and to 443 for a secure channel.
+ |
| Channel(String, Int32, Credentials, IEnumerableChannelOption) |
+ Creates a channel that connects to a specific host and port.
+ |
Properties| + + | Name | Description |
|---|---|---|
| ResolvedTarget | Resolved address of the remote endpoint in URI format. |
| State |
+ Gets current connectivity state of this channel.
+ |
| Target | The original target used to create the channel. |
Methods| + + | Name | Description |
|---|---|---|
| ConnectAsync |
+ Allows explicitly requesting channel to connect without starting an RPC.
+ Returned task completes once state Ready was seen. If the deadline is reached,
+ or channel enters the FatalFailure state, the task is cancelled.
+ There is no need to call this explicitly unless your use case requires that.
+ Starting an RPC on a new channel will request connection implicitly.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ShutdownAsync |
+ Waits until there are no more active calls for this channel and then cleans up
+ resources used by this channel.
+ |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| WaitForStateChangedAsync |
+ Returned tasks completes once channel state has become different from
+ given lastObservedState.
+ If deadline is reached or and error occurs, returned task is cancelled.
+ |
See AlsoReference
gRPC C#
| ChannelOption Class |
+ Channel option specified when creating a channel.
+ Corresponds to grpc_channel_args from grpc/grpc.h.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe ChannelOption type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| ChannelOption(String, Int32) |
+ Creates a channel option with an integer value.
+ |
| ChannelOption(String, String) |
+ Creates a channel option with a string value.
+ |
Properties| + + | Name | Description |
|---|---|---|
| IntValue |
+ Gets the integer value the ChannelOption.
+ |
| Name |
+ Gets the name of the ChannelOption.
+ |
| StringValue |
+ Gets the string value the ChannelOption.
+ |
| Type |
+ Gets the type of the ChannelOption.
+ |
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| ChannelOptionOptionType Enumeration |
+ Type of ChannelOption.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxMembers| + + | Member name | Value | Description |
|---|---|---|---|
| Integer | 0 | + Channel option with integer value. + | |
| String | 1 | + Channel option with string value. + |
See AlsoReference
gRPC C#
| ChannelOptions Class |
+ Defines names of supported channel options.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe ChannelOptions type exposes the following members.
Fields| + + | Name | Description |
|---|---|---|
| Census | Enable census for tracing and stats collection |
| DefaultAuthority | Default authority for calls. |
| Http2InitialSequenceNumber | Initial sequence number for http2 transports |
| MaxConcurrentStreams | Maximum number of concurrent incoming streams to allow on a http2 connection |
| MaxMessageLength | Maximum message length that the channel can receive |
| PrimaryUserAgentString | Primary user agent: goes at the start of the user-agent metadata |
| SecondaryUserAgentString | Secondary user agent: goes at the end of the user-agent metadata |
| SslTargetNameOverride | Override SSL target check. Only to be used for testing. |
See AlsoReference
gRPC C#
| ChannelState Enumeration |
+ Connectivity state of a channel.
+ Based on grpc_connectivity_state from grpc/grpc.h
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxMembers| + + | Member name | Value | Description |
|---|---|---|---|
| Idle | 0 | + Channel is idle + | |
| Connecting | 1 | + Channel is connecting + | |
| Ready | 2 | + Channel is ready for work + | |
| TransientFailure | 3 | + Channel has seen a failure but expects to recover + | |
| FatalFailure | 4 | + Channel has seen a failure that it cannot recover from + |
See AlsoReference
gRPC C#
| ClientBase Class |
+ Base class for client-side stubs.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe ClientBase type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| ClientBase |
+ Initializes a new instance of ClientBase class.
+ |
Properties| + + | Name | Description |
|---|---|---|
| Channel |
+ Channel associated with this client.
+ |
| HeaderInterceptor |
+ Can be used to register a custom header (request metadata) interceptor.
+ The interceptor is invoked each time a new call on this client is started.
+ |
| Host |
+ gRPC supports multiple "hosts" being served by a single server.
+ This property can be used to set the target host explicitly.
+ By default, this will be set to null with the meaning
+ "use default host".
+ |
Methods| + + | Name | Description |
|---|---|---|
| CreateCallTRequest, TResponse |
+ Creates a new call to given method.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| ClientStreamingServerMethodTRequest, TResponse Delegate |
+ Server-side handler for client streaming call.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic delegate Task<TResponse> ClientStreamingServerMethod<TRequest, TResponse>( + IAsyncStreamReader<TRequest> requestStream, + ServerCallContext context +) +where TRequest : class +where TResponse : class +
Parameters
- requestStream
- Type: Grpc.CoreIAsyncStreamReaderTRequest
- context
- Type: Grpc.CoreServerCallContext
Type Parameters
- TRequest
- Request message type for this method.
- TResponse
- Response message type for this method.
Return Value
Type: TaskTResponseSee AlsoReference
gRPC C#
| CompressionLevel Enumeration |
+ Compression level based on grpc_compression_level from grpc/compression.h
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxMembers| + + | Member name | Value | Description |
|---|---|---|---|
| None | 0 | + No compression. + | |
| Low | 1 | + Low compression. + | |
| Medium | 2 | + Medium compression. + | |
| High | 3 | + High compression. + |
See AlsoReference
gRPC C#
| ContextPropagationOptions Class |
+ Options for ContextPropagationToken.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe ContextPropagationOptions type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| ContextPropagationOptions |
+ Creates new context propagation options.
+ |
Properties| + + | Name | Description |
|---|---|---|
| IsPropagateCancellation | true if parent call's cancellation token should be propagated to the child call. |
| IsPropagateDeadline | true if parent call's deadline should be propagated to the child call. |
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
FieldsSee AlsoReference
gRPC C#
| ContextPropagationToken Class |
+ Token for propagating context of server side handlers to child calls.
+ In situations when a backend is making calls to another backend,
+ it makes sense to propagate properties like deadline and cancellation
+ token of the server call to the child call.
+ The gRPC native layer provides some other contexts (like tracing context) that
+ are not accessible to explicitly C# layer, but this token still allows propagating them.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe ContextPropagationToken type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| Credentials Class |
+ Client-side credentials. Used for creation of a secure channel.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe Credentials type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| Credentials | Initializes a new instance of the Credentials class |
Properties| + + | Name | Description |
|---|---|---|
| Insecure |
+ Returns instance of credential that provides no security and
+ will result in creating an unsecure channel with no encryption whatsoever.
+ |
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| DuplexStreamingServerMethodTRequest, TResponse Delegate |
+ Server-side handler for bidi streaming call.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic delegate Task DuplexStreamingServerMethod<TRequest, TResponse>( + IAsyncStreamReader<TRequest> requestStream, + IServerStreamWriter<TResponse> responseStream, + ServerCallContext context +) +where TRequest : class +where TResponse : class +
Parameters
- requestStream
- Type: Grpc.CoreIAsyncStreamReaderTRequest
- responseStream
- Type: Grpc.CoreIServerStreamWriterTResponse
- context
- Type: Grpc.CoreServerCallContext
Type Parameters
- TRequest
- Request message type for this method.
- TResponse
- Response message type for this method.
Return Value
Type: TaskSee AlsoReference
gRPC C#
| GrpcEnvironment Class |
+ Encapsulates initialization and shutdown of gRPC library.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe GrpcEnvironment type exposes the following members.
PropertiesMethods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetLogger |
+ Sets the application-wide logger that should be used by gRPC.
+ |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| HeaderInterceptor Delegate |
+ Interceptor for call headers.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic delegate void HeaderInterceptor( + IMethod method, + string authUri, + Metadata metadata +)
Parameters
- method
- Type: Grpc.CoreIMethod
- authUri
- Type: SystemString
- metadata
- Type: Grpc.CoreMetadata
See AlsoReference
gRPC C#
| IAsyncStreamReaderT Interface |
+ A stream of messages to be read.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxType Parameters
- T
- The message type.
The IAsyncStreamReaderT type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| Current | (Inherited from IAsyncEnumeratorT.) |
Methods| + + | Name | Description |
|---|---|---|
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
| MoveNext | (Inherited from IAsyncEnumeratorT.) |
Extension Methods| + + | Name | Description |
|---|---|---|
| ForEachAsyncT |
+ Reads the entire stream and executes an async action for each element.
+ (Defined by AsyncStreamExtensions.) |
| ToListAsyncT |
+ Reads the entire stream and creates a list containing all the elements read.
+ (Defined by AsyncStreamExtensions.) |
See AlsoReference
gRPC C#
| IAsyncStreamWriterT Interface |
+ A writable stream of messages.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe IAsyncStreamWriterT type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| WriteOptions |
+ Write options that will be used for the next write.
+ If null, default options will be used.
+ Once set, this property maintains its value across subsequent
+ writes.
+ |
Methods| + + | Name | Description |
|---|---|---|
| WriteAsync |
+ Writes a single asynchronously. Only one write can be pending at a time.
+ |
See AlsoReference
gRPC C#
| IClientStreamWriterT Interface |
+ Client-side writable stream of messages with Close capability.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxType Parameters
- T
- The message type.
The IClientStreamWriterT type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| WriteOptions |
+ Write options that will be used for the next write.
+ If null, default options will be used.
+ Once set, this property maintains its value across subsequent
+ writes.
+ (Inherited from IAsyncStreamWriterT.) |
Methods| + + | Name | Description |
|---|---|---|
| CompleteAsync |
+ Completes/closes the stream. Can only be called once there is no pending write. No writes should follow calling this.
+ |
| WriteAsync |
+ Writes a single asynchronously. Only one write can be pending at a time.
+ (Inherited from IAsyncStreamWriterT.) |
Extension Methods| + + | Name | Description |
|---|---|---|
| WriteAllAsyncT |
+ Writes all elements from given enumerable to the stream.
+ Completes the stream afterwards unless close = false.
+ (Defined by AsyncStreamExtensions.) |
See AlsoReference
gRPC C#
| IHasWriteOptions Interface |
+ Allows sharing write options between ServerCallContext and other objects.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe IHasWriteOptions type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| WriteOptions |
+ Gets or sets the write options.
+ |
See AlsoReference
gRPC C#
| IMethod Interface |
+ A non-generic representation of a remote method.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe IMethod type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| FullName |
+ Gets the fully qualified name of the method. On the server side, methods are dispatched
+ based on this name.
+ |
| Name |
+ Gets the unqualified name of the method.
+ |
| ServiceName |
+ Gets the name of the service to which this method belongs.
+ |
| Type |
+ Gets the type of the method.
+ |
See AlsoReference
gRPC C#
| IServerStreamWriterT Interface |
+ A writable stream of messages that is used in server-side handlers.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxType Parameters
- T
[Missing <typeparam name="T"/> documentation for "T:Grpc.Core.IServerStreamWriter`1"]
The IServerStreamWriterT type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| WriteOptions |
+ Write options that will be used for the next write.
+ If null, default options will be used.
+ Once set, this property maintains its value across subsequent
+ writes.
+ (Inherited from IAsyncStreamWriterT.) |
Methods| + + | Name | Description |
|---|---|---|
| WriteAsync |
+ Writes a single asynchronously. Only one write can be pending at a time.
+ (Inherited from IAsyncStreamWriterT.) |
Extension Methods| + + | Name | Description |
|---|---|---|
| WriteAllAsyncT |
+ Writes all elements from given enumerable to the stream.
+ (Defined by AsyncStreamExtensions.) |
See AlsoReference
gRPC C#
| KeyCertificatePair Class |
+ Key certificate pair (in PEM encoding).
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe KeyCertificatePair type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| KeyCertificatePair |
+ Creates a new certificate chain - private key pair.
+ |
Properties| + + | Name | Description |
|---|---|---|
| CertificateChain |
+ PEM encoded certificate chain.
+ |
| PrivateKey |
+ PEM encoded private key.
+ |
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| ConsoleLogger Class |
Logger that logs to System.Console.
Inheritance HierarchyNamespace: Grpc.Core.Logging
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe ConsoleLogger type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| ConsoleLogger | Creates a console logger not associated to any specific type. |
Methods| + + | Name | Description |
|---|---|---|
| Debug | Logs a message with severity Debug. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Error(String, Object) | Logs a message with severity Error. |
| Error(Exception, String, Object) | Logs a message and an associated exception with severity Error. |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| ForTypeT |
+ Returns a logger associated with the specified type.
+ |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Info | Logs a message with severity Info. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Warning(String, Object) | Logs a message with severity Warning. |
| Warning(Exception, String, Object) | Logs a message and an associated exception with severity Warning. |
See AlsoReference
gRPC C#
| ILogger Interface |
For logging messages.
Namespace: Grpc.Core.Logging
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe ILogger type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Debug | Logs a message with severity Debug. |
| Error(String, Object) | Logs a message with severity Error. |
| Error(Exception, String, Object) | Logs a message and an associated exception with severity Error. |
| ForTypeT | Returns a logger associated with the specified type. |
| Info | Logs a message with severity Info. |
| Warning(String, Object) | Logs a message with severity Warning. |
| Warning(Exception, String, Object) | Logs a message and an associated exception with severity Warning. |
See AlsoReference
gRPC C#
| MarshallerT Structure |
+ Encapsulates the logic for serializing and deserializing messages.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxType Parameters
- T
[Missing <typeparam name="T"/> documentation for "T:Grpc.Core.Marshaller`1"]
The MarshallerT type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| MarshallerT |
+ Initializes a new marshaller.
+ |
Properties| + + | Name | Description |
|---|---|---|
| Deserializer |
+ Gets the deserializer function.
+ |
| Serializer |
+ Gets the serializer function.
+ |
Methods| + + | Name | Description |
|---|---|---|
| Equals | Indicates whether this instance and a specified object are equal. (Inherited from ValueType.) |
| GetHashCode | Returns the hash code for this instance. (Inherited from ValueType.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns the fully qualified type name of this instance. (Inherited from ValueType.) |
See AlsoReference
gRPC C#
| Marshallers Class |
+ Utilities for creating marshallers.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe Marshallers type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| StringMarshaller |
+ Returns a marshaller for string type. This is useful for testing.
+ |
MethodsSee AlsoReference
gRPC C#
| Metadata Class |
+ A collection of metadata entries that can be exchanged during a call.
+ gRPC supports these types of metadata:
+
- Request headers - are sent by the client at the beginning of a remote call before any request messages are sent.
- Response headers - are sent by the server at the beginning of a remote call handler before any response messages are sent.
- Response trailers - are sent by the server at the end of a remote call along with resulting call status.
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe Metadata type exposes the following members.
ConstructorsProperties| + + | Name | Description |
|---|---|---|
| Count | |
| IsReadOnly | |
| Item |
Methods| + + | Name | Description |
|---|---|---|
| Add(MetadataEntry) | |
| Add(String, Byte) | |
| Add(String, String) | |
| Clear | |
| Contains | |
| CopyTo | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetEnumerator | |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IndexOf | |
| Insert | |
| Remove | |
| RemoveAt | |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| + + | Name | Description |
|---|---|---|
| BinaryHeaderSuffix |
+ All binary headers should have this suffix.
+ |
| Empty |
+ An read-only instance of metadata containing no entries.
+ |
See AlsoReference
gRPC C#
| MetadataEntry Structure |
+ Metadata entry
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe MetadataEntry type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| MetadataEntry(String, Byte) |
+ Initializes a new instance of the MetadataEntry struct with a binary value.
+ |
| MetadataEntry(String, String) |
+ Initializes a new instance of the MetadataEntry struct holding an ASCII value.
+ |
Properties| + + | Name | Description |
|---|---|---|
| IsBinary |
+ Returns true if this entry is a binary-value entry.
+ |
| Key |
+ Gets the metadata entry key.
+ |
| Value |
+ Gets the string value of this metadata entry.
+ |
| ValueBytes |
+ Gets the binary value of this metadata entry.
+ |
Methods| + + | Name | Description |
|---|---|---|
| Equals | Indicates whether this instance and a specified object are equal. (Inherited from ValueType.) |
| GetHashCode | Returns the hash code for this instance. (Inherited from ValueType.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString |
+ Returns a String that represents the current MetadataEntry.
+ (Overrides ValueTypeToString.) |
See AlsoReference
gRPC C#
| MethodType Enumeration |
+ Method types supported by gRPC.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxMembers| + + | Member name | Value | Description |
|---|---|---|---|
| Unary | 0 | Single request sent from client, single response received from server. | |
| ClientStreaming | 1 | Stream of request sent from client, single response received from server. | |
| ServerStreaming | 2 | Single request sent from client, stream of responses received from server. | |
| DuplexStreaming | 3 | Both server and client can stream arbitrary number of requests and responses simultaneously. |
See AlsoReference
gRPC C#
| MethodTRequest, TResponse Class |
+ A description of a remote method.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxType Parameters
- TRequest
- Request message type for this method.
- TResponse
- Response message type for this method.
The MethodTRequest, TResponse type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| MethodTRequest, TResponse |
+ Initializes a new instance of the Method class.
+ |
Properties| + + | Name | Description |
|---|---|---|
| FullName |
+ Gets the fully qualified name of the method. On the server side, methods are dispatched
+ based on this name.
+ |
| Name |
+ Gets the unqualified name of the method.
+ |
| RequestMarshaller |
+ Gets the marshaller used for request messages.
+ |
| ResponseMarshaller |
+ Gets the marshaller used for response messages.
+ |
| ServiceName |
+ Gets the name of the service to which this method belongs.
+ |
| Type |
+ Gets the type of the method.
+ |
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| RpcException Class |
+ Thrown when remote procedure call fails. Every RpcException is associated with a resulting Status of the call.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe RpcException type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| RpcException(Status) |
+ Creates a new RpcException associated with given status.
+ |
| RpcException(Status, String) |
+ Creates a new RpcException associated with given status and message.
+ |
Properties| + + | Name | Description |
|---|---|---|
| Data | Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.) |
| HelpLink | Gets or sets a link to the help file associated with this exception. (Inherited from Exception.) |
| HResult | Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.) |
| InnerException | Gets the Exception instance that caused the current exception. (Inherited from Exception.) |
| Message | Gets a message that describes the current exception. (Inherited from Exception.) |
| Source | Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.) |
| StackTrace | Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.) |
| Status |
+ Resulting status of the call.
+ |
| TargetSite | Gets the method that throws the current exception. (Inherited from Exception.) |
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetBaseException | When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetObjectData | When overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception.) |
| GetType | Gets the runtime type of the current instance. (Inherited from Exception.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Creates and returns a string representation of the current exception. (Inherited from Exception.) |
Events| + + | Name | Description |
|---|---|---|
| SerializeObjectState | Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.) |
See AlsoReference
gRPC C#
| Server Class |
+ gRPC server. A single server can server arbitrary number of services and can listen on more than one ports.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe Server type exposes the following members.
ConstructorsProperties| + + | Name | Description |
|---|---|---|
| Ports |
+ Ports on which the server will listen once started. Register a port with this
+ server by adding its definition to this collection.
+ |
| Services |
+ Services that will be exported by the server once started. Register a service with this
+ server by adding its definition to this collection.
+ |
| ShutdownTask |
+ To allow awaiting termination of the server.
+ |
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| KillAsync |
+ Requests server shutdown while cancelling all the in-progress calls.
+ The returned task finishes when shutdown procedure is complete.
+ |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ShutdownAsync |
+ Requests server shutdown and when there are no more calls being serviced,
+ cleans up used resources. The returned task finishes when shutdown procedure
+ is complete.
+ |
| Start |
+ Starts the server.
+ |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| ServerCallContext Class |
+ Context for a server-side call.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe ServerCallContext type exposes the following members.
Properties| + + | Name | Description |
|---|---|---|
| CancellationToken | Cancellation token signals when call is cancelled. |
| Deadline | Deadline for this RPC. |
| Host | Name of host called in this RPC. |
| Method | Name of method called in this RPC. |
| Peer | Address of the remote endpoint in URI format. |
| RequestHeaders | Initial metadata sent by client. |
| ResponseTrailers | Trailers to send back to client after RPC finishes. |
| Status | Status to send back to client after RPC finishes. |
| WriteOptions |
+ Allows setting write options for the following write.
+ For streaming response calls, this property is also exposed as on IServerStreamWriter for convenience.
+ Both properties are backed by the same underlying value.
+ |
Methods| + + | Name | Description |
|---|---|---|
| CreatePropagationToken |
+ Creates a propagation token to be used to propagate call context to a child call.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| WriteResponseHeadersAsync |
+ Asynchronously sends response headers for the current call to the client. This method may only be invoked once for each call and needs to be invoked
+ before any response messages are written. Writing the first response message implicitly sends empty response headers if WriteResponseHeadersAsync haven't
+ been called yet.
+ |
See AlsoReference
gRPC C#
| ServerCredentials Class |
+ Server side credentials.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe ServerCredentials type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| ServerCredentials | Initializes a new instance of the ServerCredentials class |
Properties| + + | Name | Description |
|---|---|---|
| Insecure |
+ Returns instance of credential that provides no security and
+ will result in creating an unsecure server port with no encryption whatsoever.
+ |
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| ServerPort Class |
+ A port exposed by a server.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe ServerPort type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| ServerPort |
+ Creates a new port on which server should listen.
+ |
Properties| + + | Name | Description |
|---|---|---|
| BoundPort | |
| Credentials | |
| Host | |
| Port |
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| + + | Name | Description |
|---|---|---|
| PickUnused |
+ Pass this value as port to have the server choose an unused listening port for you.
+ Ports added to a server will contain the bound port in their BoundPort property.
+ |
See AlsoReference
gRPC C#
| ServerServiceDefinition Class |
+ Mapping of method names to server call handlers.
+ Normally, the ServerServiceDefinition objects will be created by the BindService factory method
+ that is part of the autogenerated code for a protocol buffers service definition.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe ServerServiceDefinition type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| CreateBuilder |
+ Creates a new builder object for ServerServiceDefinition.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| ServerServiceDefinitionBuilder Class |
+ Builder class for ServerServiceDefinition.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe ServerServiceDefinitionBuilder type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| ServerServiceDefinitionBuilder |
+ Creates a new instance of builder.
+ |
Methods| + + | Name | Description |
|---|---|---|
| AddMethodTRequest, TResponse(MethodTRequest, TResponse, ClientStreamingServerMethodTRequest, TResponse) |
+ Adds a definitions for a client streaming method.
+ |
| AddMethodTRequest, TResponse(MethodTRequest, TResponse, DuplexStreamingServerMethodTRequest, TResponse) |
+ Adds a definitions for a bidirectional streaming method.
+ |
| AddMethodTRequest, TResponse(MethodTRequest, TResponse, ServerStreamingServerMethodTRequest, TResponse) |
+ Adds a definitions for a server streaming method.
+ |
| AddMethodTRequest, TResponse(MethodTRequest, TResponse, UnaryServerMethodTRequest, TResponse) |
+ Adds a definitions for a single request - single response method.
+ |
| Build |
+ Creates an immutable ServerServiceDefinition from this builder.
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| ServerStreamingServerMethodTRequest, TResponse Delegate |
+ Server-side handler for server streaming call.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic delegate Task ServerStreamingServerMethod<TRequest, TResponse>( + TRequest request, + IServerStreamWriter<TResponse> responseStream, + ServerCallContext context +) +where TRequest : class +where TResponse : class +
Parameters
- request
- Type: TRequest
- responseStream
- Type: Grpc.CoreIServerStreamWriterTResponse
- context
- Type: Grpc.CoreServerCallContext
Type Parameters
- TRequest
- Request message type for this method.
- TResponse
- Response message type for this method.
Return Value
Type: TaskSee AlsoReference
gRPC C#
| ServerServerPortCollection Class |
+ Collection of server ports.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe ServerServerPortCollection type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Add(ServerPort) |
+ Adds a new port on which server should listen.
+ Only call this before Start().
+ Return ValueType:The port on which server will be listening. |
| Add(String, Int32, ServerCredentials) |
+ Adds a new port on which server should listen.
+ Return ValueType:The port on which server will be listening. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetEnumerator |
+ Gets enumerator for this collection.
+ |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| ServerServiceDefinitionCollection Class |
+ Collection of service definitions.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe ServerServiceDefinitionCollection type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| Add |
+ Adds a service definition to the server. This is how you register
+ handlers for a service with the server. Only call this before Start().
+ |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetEnumerator |
+ Gets enumerator for this collection.
+ |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| SslCredentials Class |
+ Client-side SSL credentials.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe SslCredentials type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| SslCredentials |
+ Creates client-side SSL credentials loaded from
+ disk file pointed to by the GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment variable.
+ If that fails, gets the roots certificates from a well known place on disk.
+ |
| SslCredentials(String) |
+ Creates client-side SSL credentials from
+ a string containing PEM encoded root certificates.
+ |
| SslCredentials(String, KeyCertificatePair) |
+ Creates client-side SSL credentials.
+ |
Properties| + + | Name | Description |
|---|---|---|
| KeyCertificatePair |
+ Client side key and certificate pair.
+ If null, client will not use key and certificate pair.
+ |
| RootCertificates |
+ PEM encoding of the server root certificates.
+ |
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| SslServerCredentials Class |
+ Server-side SSL credentials.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe SslServerCredentials type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| SslServerCredentials(IEnumerableKeyCertificatePair) |
+ Creates server-side SSL credentials.
+ This constructor should be use if you do not wish to autheticate client
+ using client root certificates.
+ |
| SslServerCredentials(IEnumerableKeyCertificatePair, String, Boolean) |
+ Creates server-side SSL credentials.
+ |
Properties| + + | Name | Description |
|---|---|---|
| ForceClientAuthentication |
+ If true, the authenticity of client check will be enforced.
+ |
| KeyCertificatePairs |
+ Key-certificate pairs.
+ |
| RootCertificates |
+ PEM encoded client root certificates.
+ |
Methods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoReference
gRPC C#
| Status Structure |
+ Represents RPC result, which consists of StatusCode and an optional detail string.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe Status type exposes the following members.
ConstructorsProperties| + + | Name | Description |
|---|---|---|
| Detail |
+ Gets the detail.
+ |
| StatusCode |
+ Gets the gRPC status code. OK indicates success, all other values indicate an error.
+ |
Methods| + + | Name | Description |
|---|---|---|
| Equals | Indicates whether this instance and a specified object are equal. (Inherited from ValueType.) |
| GetHashCode | Returns the hash code for this instance. (Inherited from ValueType.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString |
+ Returns a String that represents the current Status.
+ (Overrides ValueTypeToString.) |
Fields| + + | Name | Description |
|---|---|---|
| DefaultCancelled |
+ Default result of a cancelled RPC. StatusCode=Cancelled, empty details message.
+ |
| DefaultSuccess |
+ Default result of a successful RPC. StatusCode=OK, empty details message.
+ |
See AlsoReference
gRPC C#
| StatusCode Enumeration |
+ Result of a remote procedure call.
+ Based on grpc_status_code from grpc/status.h
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxMembers| + + | Member name | Value | Description |
|---|---|---|---|
| OK | 0 | Not an error; returned on success. | |
| Cancelled | 1 | The operation was cancelled (typically by the caller). | |
| Unknown | 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. + | |
| InvalidArgument | 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). + | |
| DeadlineExceeded | 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. + | |
| NotFound | 5 | Some requested entity (e.g., file or directory) was not found. | |
| AlreadyExists | 6 | Some entity that we attempted to create (e.g., file or directory) already exists. | |
| PermissionDenied | 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). + | |
| Unauthenticated | 16 | The request does not have valid authentication credentials for the operation. | |
| ResourceExhausted | 8 | + Some resource has been exhausted, perhaps a per-user quota, or + perhaps the entire file system is out of space. + | |
| FailedPrecondition | 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. + | |
| Aborted | 10 | + The operation was aborted, typically due to a concurrency issue + like sequencer check failures, transaction aborts, etc. + | |
| OutOfRange | 11 | + Operation was attempted past the valid range. E.g., seeking or + reading past end of file. + | |
| Unimplemented | 12 | Operation is not implemented or not supported/enabled in this service. | |
| Internal | 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 | 14 | + The service is currently unavailable. This is a most likely a + transient condition and may be corrected by retrying with + a backoff. + | |
| DataLoss | 15 | Unrecoverable data loss or corruption. |
See AlsoReference
gRPC C#
| UnaryServerMethodTRequest, TResponse Delegate |
+ Server-side handler for unary call.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
Syntaxpublic delegate Task<TResponse> UnaryServerMethod<TRequest, TResponse>( + TRequest request, + ServerCallContext context +) +where TRequest : class +where TResponse : class +
Parameters
- request
- Type: TRequest
- context
- Type: Grpc.CoreServerCallContext
Type Parameters
- TRequest
- Request message type for this method.
- TResponse
- Response message type for this method.
Return Value
Type: TaskTResponseSee AlsoReference
gRPC C#
| AsyncStreamExtensions Class |
+ Extension methods that simplify work with gRPC streaming calls.
+
Inheritance HierarchyNamespace: Grpc.Core.Utils
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe AsyncStreamExtensions type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| ForEachAsyncT |
+ Reads the entire stream and executes an async action for each element.
+ |
| ToListAsyncT |
+ Reads the entire stream and creates a list containing all the elements read.
+ |
| WriteAllAsyncT(IServerStreamWriterT, IEnumerableT) |
+ Writes all elements from given enumerable to the stream.
+ |
| WriteAllAsyncT(IClientStreamWriterT, IEnumerableT, Boolean) |
+ Writes all elements from given enumerable to the stream.
+ Completes the stream afterwards unless close = false.
+ |
See AlsoReference
gRPC C#
| BenchmarkUtil Class |
+ Utility methods to run microbenchmarks.
+
Inheritance HierarchyNamespace: Grpc.Core.Utils
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe BenchmarkUtil type exposes the following members.
Methods| + + | Name | Description |
|---|---|---|
| RunBenchmark |
+ Runs a simple benchmark preceded by warmup phase.
+ |
See AlsoReference
gRPC C#
| Preconditions Class |
+ Utility methods to simplify checking preconditions in the code.
+
Inheritance HierarchyNamespace: Grpc.Core.Utils
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxMethods| + + | Name | Description |
|---|---|---|
| CheckArgument(Boolean) |
+ Throws ArgumentException if condition is false.
+ |
| CheckArgument(Boolean, String) |
+ Throws ArgumentException with given message if condition is false.
+ |
| CheckNotNullT(T) |
+ Throws ArgumentNullException if reference is null.
+ |
| CheckNotNullT(T, String) |
+ Throws ArgumentNullException if reference is null.
+ |
| CheckState(Boolean) |
+ Throws InvalidOperationException if condition is false.
+ |
| CheckState(Boolean, String) |
+ Throws InvalidOperationException with given message if condition is false.
+ |
See AlsoReference
gRPC C#
| VersionInfo Class |
+ Provides info about current version of gRPC.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe VersionInfo type exposes the following members.
Fields| + + | Name | Description |
|---|---|---|
| CurrentVersion |
+ Current version of gRPC
+ |
See AlsoReference
gRPC C#
| WriteFlags Enumeration |
+ Flags for write operations.
+
Namespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxMembers| + + | Member name | Value | Description |
|---|---|---|---|
| BufferHint | 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 write stream completion, but it need not buffer completely or at all. + | |
| NoCompress | 2 | + Force compression to be disabled for a particular write. + |
See AlsoReference
gRPC C#
| WriteOptions Class |
+ Options for write operations.
+
Inheritance HierarchyNamespace: Grpc.Core
Assembly: Grpc.Core (in Grpc.Core.dll) Version: 0.6.1.0
SyntaxThe WriteOptions type exposes the following members.
Constructors| + + | Name | Description |
|---|---|---|
| WriteOptions |
+ Initializes a new instance of WriteOptions class.
+ |
PropertiesMethods| + + | Name | Description |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
FieldsSee AlsoReference
If you are not redirected automatically, follow this link to the default topic.
+ + diff --git a/doc/ref/csharp/html/scripts/branding-Website.js b/doc/ref/csharp/html/scripts/branding-Website.js new file mode 100644 index 00000000000..06ab9808ccc --- /dev/null +++ b/doc/ref/csharp/html/scripts/branding-Website.js @@ -0,0 +1,624 @@ +//=============================================================================================================== +// System : Sandcastle Help File Builder +// File : branding-Website.js +// Author : Eric Woodruff (Eric@EWoodruff.us) +// Updated : 03/04/2015 +// Note : Copyright 2014-2015, Eric Woodruff, All rights reserved +// Portions Copyright 2014 Sam Harwell, All rights reserved +// +// This file contains the methods necessary to implement the lightweight TOC and search functionality. +// +// This code is published under the Microsoft Public License (Ms-PL). A copy of the license should be +// distributed with the code. It can also be found at the project website: https://GitHub.com/EWSoftware/SHFB. This +// notice, the author's name, and all copyright notices must remain intact in all applications, documentation, +// and source files. +// +// Date Who Comments +// ============================================================================================================== +// 05/04/2014 EFW Created the code based on a combination of the lightweight TOC code from Sam Harwell and +// the existing search code from SHFB. +//=============================================================================================================== + +// Width of the TOC +var tocWidth; + +// Search method (0 = To be determined, 1 = ASPX, 2 = PHP, anything else = client-side script +var searchMethod = 0; + +// Table of contents script + +// Initialize the TOC by restoring its width from the cookie if present +function InitializeToc() +{ + tocWidth = parseInt(GetCookie("TocWidth", "280")); + ResizeToc(); + $(window).resize(SetNavHeight) +} + +function SetNavHeight() +{ + $leftNav = $("#leftNav") + $topicContent = $("#TopicContent") + leftNavPadding = $leftNav.outerHeight() - $leftNav.height() + contentPadding = $topicContent.outerHeight() - $topicContent.height() + // want outer height of left navigation div to match outer height of content + leftNavHeight = $topicContent.outerHeight() - leftNavPadding + $leftNav.css("min-height", leftNavHeight + "px") +} + +// Increase the TOC width +function OnIncreaseToc() +{ + if(tocWidth < 1) + tocWidth = 280; + else + tocWidth += 100; + + if(tocWidth > 680) + tocWidth = 0; + + ResizeToc(); + SetCookie("TocWidth", tocWidth); +} + +// Reset the TOC to its default width +function OnResetToc() +{ + tocWidth = 0; + + ResizeToc(); + SetCookie("TocWidth", tocWidth); +} + +// Resize the TOC width +function ResizeToc() +{ + var toc = document.getElementById("leftNav"); + + if(toc) + { + // Set TOC width + toc.style.width = tocWidth + "px"; + + var leftNavPadding = 10; + + document.getElementById("TopicContent").style.marginLeft = (tocWidth + leftNavPadding) + "px"; + + // Position images + document.getElementById("TocResize").style.left = (tocWidth + leftNavPadding) + "px"; + + // Hide/show increase TOC width image + document.getElementById("ResizeImageIncrease").style.display = (tocWidth >= 680) ? "none" : ""; + + // Hide/show reset TOC width image + document.getElementById("ResizeImageReset").style.display = (tocWidth < 680) ? "none" : ""; + } + + SetNavHeight() +} + +// Toggle a TOC entry between its collapsed and expanded state +function Toggle(item) +{ + var isExpanded = $(item).hasClass("tocExpanded"); + + $(item).toggleClass("tocExpanded tocCollapsed"); + + if(isExpanded) + { + Collapse($(item).parent()); + } + else + { + var childrenLoaded = $(item).parent().attr("data-childrenloaded"); + + if(childrenLoaded) + { + Expand($(item).parent()); + } + else + { + var tocid = $(item).next().attr("tocid"); + + $.ajax({ + url: "../toc/" + tocid + ".xml", + async: true, + dataType: "xml", + success: function(data) + { + BuildChildren($(item).parent(), data); + } + }); + } + } +} + +// HTML encode a value for use on the page +function HtmlEncode(value) +{ + // Create an in-memory div, set it's inner text (which jQuery automatically encodes) then grab the encoded + // contents back out. The div never exists on the page. + return $('').text(value).html(); +} + +// Build the child entries of a TOC entry +function BuildChildren(tocDiv, data) +{ + var childLevel = +tocDiv.attr("data-toclevel") + 1; + var childTocLevel = childLevel >= 10 ? 10 : childLevel; + var elements = data.getElementsByTagName("HelpTOCNode"); + + var isRoot = true; + + if(data.getElementsByTagName("HelpTOC").length == 0) + { + // The first node is the root node of this group, don't show it again + isRoot = false; + } + + for(var i = elements.length - 1; i > 0 || (isRoot && i == 0); i--) + { + var childHRef, childId = elements[i].getAttribute("Url"); + + if(childId != null && childId.length > 5) + { + // The Url attribute has the form "html/{childId}.htm" + childHRef = childId.substring(5, childId.length); + childId = childId.substring(5, childId.lastIndexOf(".")); + } + else + { + // The Id attribute is in raw form. There is no URL (empty container node). In this case, we'll + // just ignore it and go nowhere. It's a rare case that isn't worth trying to get the first child. + // Instead, we'll just expand the node (see below). + childHRef = "#"; + childId = elements[i].getAttribute("Id"); + } + + var existingItem = null; + + tocDiv.nextAll().each(function() + { + if(!existingItem && $(this).children().last("a").attr("tocid") == childId) + { + existingItem = $(this); + } + }); + + if(existingItem != null) + { + // First move the children of the existing item + var existingChildLevel = +existingItem.attr("data-toclevel"); + var doneMoving = false; + var inserter = tocDiv; + + existingItem.nextAll().each(function() + { + if(!doneMoving && +$(this).attr("data-toclevel") > existingChildLevel) + { + inserter.after($(this)); + inserter = $(this); + $(this).attr("data-toclevel", +$(this).attr("data-toclevel") + childLevel - existingChildLevel); + + if($(this).hasClass("current")) + $(this).attr("class", "toclevel" + (+$(this).attr("data-toclevel") + " current")); + else + $(this).attr("class", "toclevel" + (+$(this).attr("data-toclevel"))); + } + else + { + doneMoving = true; + } + }); + + // Now move the existing item itself + tocDiv.after(existingItem); + existingItem.attr("data-toclevel", childLevel); + existingItem.attr("class", "toclevel" + childLevel); + } + else + { + var hasChildren = elements[i].getAttribute("HasChildren"); + var childTitle = HtmlEncode(elements[i].getAttribute("Title")); + var expander = ""; + + if(hasChildren) + expander = ""; + + var text = "" +
+ expander + "" +
+ childTitle + "
";
+
+ tocDiv.after(text);
+ }
+ }
+
+ tocDiv.attr("data-childrenloaded", true);
+}
+
+// Collapse a TOC entry
+function Collapse(tocDiv)
+{
+ // Hide all the TOC elements after item, until we reach one with a data-toclevel less than or equal to the
+ // current item's value.
+ var tocLevel = +tocDiv.attr("data-toclevel");
+ var done = false;
+
+ tocDiv.nextAll().each(function()
+ {
+ if(!done && +$(this).attr("data-toclevel") > tocLevel)
+ {
+ $(this).hide();
+ }
+ else
+ {
+ done = true;
+ }
+ });
+}
+
+// Expand a TOC entry
+function Expand(tocDiv)
+{
+ // Show all the TOC elements after item, until we reach one with a data-toclevel less than or equal to the
+ // current item's value
+ var tocLevel = +tocDiv.attr("data-toclevel");
+ var done = false;
+
+ tocDiv.nextAll().each(function()
+ {
+ if(done)
+ {
+ return;
+ }
+
+ var childTocLevel = +$(this).attr("data-toclevel");
+
+ if(childTocLevel == tocLevel + 1)
+ {
+ $(this).show();
+
+ if($(this).children("a").first().hasClass("tocExpanded"))
+ {
+ Expand($(this));
+ }
+ }
+ else if(childTocLevel > tocLevel + 1)
+ {
+ // Ignore this node, handled by recursive calls
+ }
+ else
+ {
+ done = true;
+ }
+ });
+}
+
+// This is called to prepare for dragging the sizer div
+function OnMouseDown(event)
+{
+ document.addEventListener("mousemove", OnMouseMove, true);
+ document.addEventListener("mouseup", OnMouseUp, true);
+ event.preventDefault();
+}
+
+// Resize the TOC as the sizer is dragged
+function OnMouseMove(event)
+{
+ tocWidth = (event.clientX > 700) ? 700 : (event.clientX < 100) ? 100 : event.clientX;
+
+ ResizeToc();
+}
+
+// Finish the drag operation when the mouse button is released
+function OnMouseUp(event)
+{
+ document.removeEventListener("mousemove", OnMouseMove, true);
+ document.removeEventListener("mouseup", OnMouseUp, true);
+
+ SetCookie("TocWidth", tocWidth);
+}
+
+// Search functions
+
+// Transfer to the search page from a topic
+function TransferToSearchPage()
+{
+ var searchText = document.getElementById("SearchTextBox").value.trim();
+
+ if(searchText.length != 0)
+ document.location.replace(encodeURI("../search.html?SearchText=" + searchText));
+}
+
+// Initiate a search when the search page loads
+function OnSearchPageLoad()
+{
+ var queryString = decodeURI(document.location.search);
+
+ if(queryString != "")
+ {
+ var idx, options = queryString.split(/[\?\=\&]/);
+
+ for(idx = 0; idx < options.length; idx++)
+ if(options[idx] == "SearchText" && idx + 1 < options.length)
+ {
+ document.getElementById("txtSearchText").value = options[idx + 1];
+ PerformSearch();
+ break;
+ }
+ }
+}
+
+// Perform a search using the best available method
+function PerformSearch()
+{
+ var searchText = document.getElementById("txtSearchText").value;
+ var sortByTitle = document.getElementById("chkSortByTitle").checked;
+ var searchResults = document.getElementById("searchResults");
+
+ if(searchText.length == 0)
+ {
+ searchResults.innerHTML = "Nothing found";
+ return;
+ }
+
+ searchResults.innerHTML = "Searching...";
+
+ // Determine the search method if not done already. The ASPX and PHP searches are more efficient as they
+ // run asynchronously server-side. If they can't be used, it defaults to the client-side script below which
+ // will work but has to download the index files. For large help sites, this can be inefficient.
+ if(searchMethod == 0)
+ searchMethod = DetermineSearchMethod();
+
+ if(searchMethod == 1)
+ {
+ $.ajax({
+ type: "GET",
+ url: encodeURI("SearchHelp.aspx?Keywords=" + searchText + "&SortByTitle=" + sortByTitle),
+ success: function(html)
+ {
+ searchResults.innerHTML = html;
+ }
+ });
+
+ return;
+ }
+
+ if(searchMethod == 2)
+ {
+ $.ajax({
+ type: "GET",
+ url: encodeURI("SearchHelp.php?Keywords=" + searchText + "&SortByTitle=" + sortByTitle),
+ success: function(html)
+ {
+ searchResults.innerHTML = html;
+ }
+ });
+
+ return;
+ }
+
+ // Parse the keywords
+ var keywords = ParseKeywords(searchText);
+
+ // Get the list of files. We'll be getting multiple files so we need to do this synchronously.
+ var fileList = [];
+
+ $.ajax({
+ type: "GET",
+ url: "fti/FTI_Files.json",
+ dataType: "json",
+ async: false,
+ success: function(data)
+ {
+ $.each(data, function(key, val)
+ {
+ fileList[key] = val;
+ });
+ }
+ });
+
+ var letters = [];
+ var wordDictionary = {};
+ var wordNotFound = false;
+
+ // Load the keyword files for each keyword starting letter
+ for(var idx = 0; idx < keywords.length && !wordNotFound; idx++)
+ {
+ var letter = keywords[idx].substring(0, 1);
+
+ if($.inArray(letter, letters) == -1)
+ {
+ letters.push(letter);
+
+ $.ajax({
+ type: "GET",
+ url: "fti/FTI_" + letter.charCodeAt(0) + ".json",
+ dataType: "json",
+ async: false,
+ success: function(data)
+ {
+ var wordCount = 0;
+
+ $.each(data, function(key, val)
+ {
+ wordDictionary[key] = val;
+ wordCount++;
+ });
+
+ if(wordCount == 0)
+ wordNotFound = true;
+ }
+ });
+ }
+ }
+
+ if(wordNotFound)
+ searchResults.innerHTML = "Nothing found";
+ else
+ searchResults.innerHTML = SearchForKeywords(keywords, fileList, wordDictionary, sortByTitle);
+}
+
+// Determine the search method by seeing if the ASPX or PHP search pages are present and working
+function DetermineSearchMethod()
+{
+ var method = 3;
+
+ try
+ {
+ $.ajax({
+ type: "GET",
+ url: "SearchHelp.aspx",
+ async: false,
+ success: function(html)
+ {
+ if(html.substring(0, 8) == "")
+ method = 1;
+ }
+ });
+
+ if(method == 3)
+ $.ajax({
+ type: "GET",
+ url: "SearchHelp.php",
+ async: false,
+ success: function(html)
+ {
+ if(html.substring(0, 8) == "")
+ method = 2;
+ }
+ });
+ }
+ catch(e)
+ {
+ }
+
+ return method;
+}
+
+// Split the search text up into keywords
+function ParseKeywords(keywords)
+{
+ var keywordList = [];
+ var checkWord;
+ var words = keywords.split(/\W+/);
+
+ for(var idx = 0; idx < words.length; idx++)
+ {
+ checkWord = words[idx].toLowerCase();
+
+ if(checkWord.length > 2)
+ {
+ var charCode = checkWord.charCodeAt(0);
+
+ if((charCode < 48 || charCode > 57) && $.inArray(checkWord, keywordList) == -1)
+ keywordList.push(checkWord);
+ }
+ }
+
+ return keywordList;
+}
+
+// Search for keywords and generate a block of HTML containing the results
+function SearchForKeywords(keywords, fileInfo, wordDictionary, sortByTitle)
+{
+ var matches = [], matchingFileIndices = [], rankings = [];
+ var isFirst = true;
+
+ for(var idx = 0; idx < keywords.length; idx++)
+ {
+ var word = keywords[idx];
+ var occurrences = wordDictionary[word];
+
+ // All keywords must be found
+ if(occurrences == null)
+ return "Nothing found";
+
+ matches[word] = occurrences;
+ var occurrenceIndices = [];
+
+ // Get a list of the file indices for this match. These are 64-bit numbers but JavaScript only does
+ // bit shifts on 32-bit values so we divide by 2^16 to get the same effect as ">> 16" and use floor()
+ // to truncate the result.
+ for(var ind in occurrences)
+ occurrenceIndices.push(Math.floor(occurrences[ind] / Math.pow(2, 16)));
+
+ if(isFirst)
+ {
+ isFirst = false;
+
+ for(var matchInd in occurrenceIndices)
+ matchingFileIndices.push(occurrenceIndices[matchInd]);
+ }
+ else
+ {
+ // After the first match, remove files that do not appear for all found keywords
+ for(var checkIdx = 0; checkIdx < matchingFileIndices.length; checkIdx++)
+ if($.inArray(matchingFileIndices[checkIdx], occurrenceIndices) == -1)
+ {
+ matchingFileIndices.splice(checkIdx, 1);
+ checkIdx--;
+ }
+ }
+ }
+
+ if(matchingFileIndices.length == 0)
+ return "Nothing found";
+
+ // Rank the files based on the number of times the words occurs
+ for(var fileIdx = 0; fileIdx < matchingFileIndices.length; fileIdx++)
+ {
+ // Split out the title, filename, and word count
+ var matchingIdx = matchingFileIndices[fileIdx];
+ var fileIndex = fileInfo[matchingIdx].split(/\0/);
+
+ var title = fileIndex[0];
+ var filename = fileIndex[1];
+ var wordCount = parseInt(fileIndex[2]);
+ var matchCount = 0;
+
+ for(var idx = 0; idx < keywords.length; idx++)
+ {
+ occurrences = matches[keywords[idx]];
+
+ for(var ind in occurrences)
+ {
+ var entry = occurrences[ind];
+
+ // These are 64-bit numbers but JavaScript only does bit shifts on 32-bit values so we divide
+ // by 2^16 to get the same effect as ">> 16" and use floor() to truncate the result.
+ if(Math.floor(entry / Math.pow(2, 16)) == matchingIdx)
+ matchCount += (entry & 0xFFFF);
+ }
+ }
+
+ rankings.push({ Filename: filename, PageTitle: title, Rank: matchCount * 1000 / wordCount });
+
+ if(rankings.length > 99)
+ break;
+ }
+
+ rankings.sort(function(x, y)
+ {
+ if(!sortByTitle)
+ return y.Rank - x.Rank;
+
+ return x.PageTitle.localeCompare(y.PageTitle);
+ });
+
+ // Format and return the results
+ var content = "- ";
+
+ for(var r in rankings)
+ content += "
- " + + rankings[r].PageTitle + " "; + + content += "
Omitted " + (matchingFileIndices.length - rankings.length) + " more results
"; + + return content; +} diff --git a/doc/ref/csharp/html/scripts/branding.js b/doc/ref/csharp/html/scripts/branding.js new file mode 100644 index 00000000000..9be90f3d478 --- /dev/null +++ b/doc/ref/csharp/html/scripts/branding.js @@ -0,0 +1,528 @@ +//=============================================================================================================== +// System : Sandcastle Help File Builder +// File : branding.js +// Author : Eric Woodruff (Eric@EWoodruff.us) +// Updated : 05/15/2014 +// Note : Copyright 2014, Eric Woodruff, All rights reserved +// Portions Copyright 2010-2014 Microsoft, All rights reserved +// +// This file contains the methods necessary to implement the language filtering, collapsible section, and +// copy to clipboard options. +// +// This code is published under the Microsoft Public License (Ms-PL). A copy of the license should be +// distributed with the code. It can also be found at the project website: https://GitHub.com/EWSoftware/SHFB. This +// notice, the author's name, and all copyright notices must remain intact in all applications, documentation, +// and source files. +// +// Date Who Comments +// ============================================================================================================== +// 05/04/2014 EFW Created the code based on the MS Help Viewer script +//=============================================================================================================== + +// The IDs of all code snippet sets on the same page are stored so that we can keep them in synch when a tab is +// selected. +var allTabSetIds = new Array(); + +// The IDs of language-specific text (LST) spans are used as dictionary keys so that we can get access to the +// spans and update them when the user changes to a different language tab. The values of the dictionary +// objects are pipe separated language-specific attributes (lang1=value|lang2=value|lang3=value). The language +// ID can be specific (cs, vb, cpp, etc.) or may be a neutral entry (nu) which specifies text common to multiple +// languages. If a language is not present and there is no neutral entry, the span is hidden for all languages +// to which it does not apply. +var allLSTSetIds = new Object(); + +// Help 1 persistence support. This code must appear inline. +var isHelp1; + +var curLoc = document.location + "."; + +if(curLoc.indexOf("mk:@MSITStore") == 0) +{ + isHelp1 = true; + curLoc = "ms-its:" + curLoc.substring(14, curLoc.length - 1); + document.location.replace(curLoc); +} +else + if(curLoc.indexOf("ms-its:") == 0) + isHelp1 = true; + else + isHelp1 = false; + +// The OnLoad method +function OnLoad(defaultLanguage) +{ + var defLang; + + if(typeof (defaultLanguage) == "undefined" || defaultLanguage == null || defaultLanguage == "") + defLang = "vb"; + else + defLang = defaultLanguage; + + // In MS Help Viewer, the transform the topic is ran through can move the footer. Move it back where it + // belongs if necessary. + try + { + var footer = document.getElementById("pageFooter") + + if(footer) + { + var footerParent = document.body; + + if(footer.parentElement != footerParent) + { + footer.parentElement.removeChild(footer); + footerParent.appendChild(footer); + } + } + } + catch(e) + { + } + + var language = GetCookie("CodeSnippetContainerLanguage", defLang); + + // If LST exists on the page, set the LST to show the user selected programming language + UpdateLST(language); + + // If code snippet groups exist, set the current language for them + if(allTabSetIds.length > 0) + { + var i = 0; + + while(i < allTabSetIds.length) + { + var tabCount = 1; + + // The tab count may vary so find the last one in this set + while(document.getElementById(allTabSetIds[i] + "_tab" + tabCount) != null) + tabCount++; + + tabCount--; + + // If not grouped, skip it + if(tabCount < 2) + { + // Disable the Copy Code link if in Chrome + if(navigator.userAgent.toLowerCase().indexOf("chrome") != -1) + document.getElementById(allTabSetIds[i] + "_copyCode").style.display = "none"; + } + else + SetCurrentLanguage(allTabSetIds[i], language, tabCount); + + i++; + } + } + + InitializeToc(); +} + +// This is just a place holder. The website script implements this function to initialize it's in-page TOC pane +function InitializeToc() +{ +} + +// This function executes in the OnLoad event and ChangeTab action on code snippets. The function parameter +// is the user chosen programming language. This function iterates through the "allLSTSetIds" dictionary object +// to update the node value of the LST span tag per the user's chosen programming language. +function UpdateLST(language) +{ + for(var lstMember in allLSTSetIds) + { + var devLangSpan = document.getElementById(lstMember); + + if(devLangSpan != null) + { + // There may be a carriage return before the LST span in the content so the replace function below + // is used to trim the whitespace at the end of the previous node of the current LST node. + if(devLangSpan.previousSibling != null && devLangSpan.previousSibling.nodeValue != null) + devLangSpan.previousSibling.nodeValue = devLangSpan.previousSibling.nodeValue.replace(/\s+$/, ""); + + var langs = allLSTSetIds[lstMember].split("|"); + var k = 0; + var keyValue; + + while(k < langs.length) + { + keyValue = langs[k].split("="); + + if(keyValue[0] == language) + { + devLangSpan.innerHTML = keyValue[1]; + + // Help 1 and MS Help Viewer workaround. Add a space if the following text element starts + // with a space to prevent things running together. + if(devLangSpan.parentNode != null && devLangSpan.parentNode.nextSibling != null) + { + if (devLangSpan.parentNode.nextSibling.nodeValue != null && + !devLangSpan.parentNode.nextSibling.nodeValue.substring(0, 1).match(/[.,);:!/?]/)) + { + devLangSpan.innerHTML = keyValue[1] + " "; + } + } + break; + } + + k++; + } + + // If not found, default to the neutral language. If there is no neutral language entry, clear the + // content to hide it. + if(k >= langs.length) + { + if(language != "nu") + { + k = 0; + + while(k < langs.length) + { + keyValue = langs[k].split("="); + + if(keyValue[0] == "nu") + { + devLangSpan.innerHTML = keyValue[1]; + + // Help 1 and MS Help Viewer workaround. Add a space if the following text element + // starts with a space to prevent things running together. + if(devLangSpan.parentNode != null && devLangSpan.parentNode.nextSibling != null) + { + if(devLangSpan.parentNode.nextSibling.nodeValue != null && + !devLangSpan.parentNode.nextSibling.nodeValue.substring(0, 1).match(/[.,);:!/?]/)) + { + devLangSpan.innerHTML = keyValue[1] + " "; + } + } + break; + } + + k++; + } + } + + if(k >= langs.length) + devLangSpan.innerHTML = ""; + } + } + } +} + +// Get the specified cookie. If not found, return the specified default value. +function GetCookie(cookieName, defaultValue) +{ + if(isHelp1) + { + try + { + var globals = Help1Globals; + + var value = globals.Load(cookieName); + + if(value == null) + value = defaultValue; + + return value; + } + catch(e) + { + return defaultValue; + } + } + + var cookie = document.cookie.split("; "); + + for(var i = 0; i < cookie.length; i++) + { + var crumb = cookie[i].split("="); + + if(cookieName == crumb[0]) + return unescape(crumb[1]) + } + + return defaultValue; +} + +// Set the specified cookie to the specified value +function SetCookie(name, value) +{ + if(isHelp1) + { + try + { + var globals = Help1Globals; + + globals.Save(name, value); + } + catch(e) + { + } + + return; + } + + var today = new Date(); + + today.setTime(today.getTime()); + + // Set the expiration time to be 60 days from now (in milliseconds) + var expires_date = new Date(today.getTime() + (60 * 1000 * 60 * 60 * 24)); + + document.cookie = name + "=" + escape(value) + ";expires=" + expires_date.toGMTString() + ";path=/"; +} + +// Add a language-specific text ID +function AddLanguageSpecificTextSet(lstId) +{ + var keyValue = lstId.split("?") + + allLSTSetIds[keyValue[0]] = keyValue[1]; +} + +// Add a language tab set ID +function AddLanguageTabSet(tabSetId) +{ + allTabSetIds.push(tabSetId); +} + +// Switch the active tab for all of other code snippets +function ChangeTab(tabSetId, language, snippetIdx, snippetCount) +{ + SetCookie("CodeSnippetContainerLanguage", language); + + SetActiveTab(tabSetId, snippetIdx, snippetCount); + + // If LST exists on the page, set the LST to show the user selected programming language + UpdateLST(language); + + var i = 0; + + while(i < allTabSetIds.length) + { + // We just care about other snippets + if(allTabSetIds[i] != tabSetId) + { + // Other tab sets may not have the same number of tabs + var tabCount = 1; + + while(document.getElementById(allTabSetIds[i] + "_tab" + tabCount) != null) + tabCount++; + + tabCount--; + + // If not grouped, skip it + if(tabCount > 1) + SetCurrentLanguage(allTabSetIds[i], language, tabCount); + } + + i++; + } +} + +// Sets the current language in the specified tab set +function SetCurrentLanguage(tabSetId, language, tabCount) +{ + var tabIndex = 1; + + while(tabIndex <= tabCount) + { + var tabTemp = document.getElementById(tabSetId + "_tab" + tabIndex); + + if(tabTemp != null && tabTemp.innerHTML.indexOf("'" + language + "'") != -1) + break; + + tabIndex++; + } + + if(tabIndex > tabCount) + { + // Select the first non-disabled tab + tabIndex = 1; + + if(document.getElementById(tabSetId + "_tab1").className == "codeSnippetContainerTabPhantom") + { + tabIndex++; + + while(tabIndex <= tabCount) + { + var tab = document.getElementById(tabSetId + "_tab" + tabIndex); + + if(tab.className != "codeSnippetContainerTabPhantom") + { + tab.className = "codeSnippetContainerTabActive"; + document.getElementById(tabSetId + "_code_Div" + j).style.display = "block"; + break; + } + + tabIndex++; + } + } + } + + SetActiveTab(tabSetId, tabIndex, tabCount); +} + +// Set the active tab within a tab set +function SetActiveTab(tabSetId, tabIndex, tabCount) +{ + var i = 1; + + while(i <= tabCount) + { + var tabTemp = document.getElementById(tabSetId + "_tab" + i); + + if(tabTemp.className == "codeSnippetContainerTabActive") + tabTemp.className = "codeSnippetContainerTab"; + else + if(tabTemp.className == "codeSnippetContainerTabPhantom") + tabTemp.style.display = "none"; + + var codeTemp = document.getElementById(tabSetId + "_code_Div" + i); + + if(codeTemp.style.display != "none") + codeTemp.style.display = "none"; + + i++; + } + + // Phantom tabs are shown or hidden as needed + if(document.getElementById(tabSetId + "_tab" + tabIndex).className != "codeSnippetContainerTabPhantom") + document.getElementById(tabSetId + "_tab" + tabIndex).className = "codeSnippetContainerTabActive"; + else + document.getElementById(tabSetId + "_tab" + tabIndex).style.display = "block"; + + document.getElementById(tabSetId + "_code_Div" + tabIndex).style.display = "block"; + + // Show copy code button if not in Chrome + if(navigator.userAgent.toLowerCase().indexOf("chrome") == -1) + document.getElementById(tabSetId + "_copyCode").style.display = "inline"; + else + document.getElementById(tabSetId + "_copyCode").style.display = "none"; +} + +// Copy the code from the active tab of the given tab set to the clipboard +function CopyToClipboard(tabSetId) +{ + var tabTemp, contentId; + var i = 1; + + do + { + contentId = tabSetId + "_code_Div" + i; + tabTemp = document.getElementById(contentId); + + if(tabTemp != null && tabTemp.style.display != "none") + break; + + i++; + + } while(tabTemp != null); + + if(tabTemp == null) + return; + + if(window.clipboardData) + { + try + { + window.clipboardData.setData("Text", document.getElementById(contentId).innerText); + } + catch(e) + { + alert("Permission denied. Enable copying to the clipboard."); + } + } + else if(window.netscape) + { + try + { + netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect"); + + var clip = Components.classes["@mozilla.org/widget/clipboard;1"].createInstance( + Components.interfaces.nsIClipboard); + + if(!clip) + return; + + var trans = Components.classes["@mozilla.org/widget/transferable;1"].createInstance( + Components.interfaces.nsITransferable); + + if(!trans) + return; + + trans.addDataFlavor("text/unicode"); + + var str = new Object(); + var len = new Object(); + var str = Components.classes["@mozilla.org/supports-string;1"].createInstance( + Components.interfaces.nsISupportsString); + + var copytext = document.getElementById(contentId).textContent; + + str.data = copytext; + trans.setTransferData("text/unicode", str, copytext.length * 2); + + var clipid = Components.interfaces.nsIClipboard; + + clip.setData(trans, null, clipid.kGlobalClipboard); + } + catch(e) + { + alert("Permission denied. Enter \"about:config\" in the address bar and double-click the \"signed.applets.codebase_principal_support\" setting to enable copying to the clipboard."); + } + } +} + +// Expand or collapse a section +function SectionExpandCollapse(togglePrefix) +{ + var image = document.getElementById(togglePrefix + "Toggle"); + var section = document.getElementById(togglePrefix + "Section"); + + if(image != null && section != null) + if(section.style.display == "") + { + image.src = image.src.replace("SectionExpanded.png", "SectionCollapsed.png"); + section.style.display = "none"; + } + else + { + image.src = image.src.replace("SectionCollapsed.png", "SectionExpanded.png"); + section.style.display = ""; + } +} + +// Expand or collapse a section when it has the focus and Enter is hit +function SectionExpandCollapse_CheckKey(togglePrefix, eventArgs) +{ + if(eventArgs.keyCode == 13) + SectionExpandCollapse(togglePrefix); +} + +// Help 1 persistence object. This requires a hidden input element on the page with a class of "userDataStyle" +// defined in the style sheet that implements the user data binary behavior: +// +var Help1Globals = +{ + UserDataCache: function() + { + var userData = document.getElementById("userDataCache"); + + return userData; + }, + + Load: function(key) + { + var userData = this.UserDataCache(); + + userData.load("userDataSettings"); + + var value = userData.getAttribute(key); + + return value; + }, + + Save: function(key, value) + { + var userData = this.UserDataCache(); + userData.setAttribute(key, value); + userData.save("userDataSettings"); + } +}; diff --git a/doc/ref/csharp/html/scripts/jquery-1.11.0.min.js b/doc/ref/csharp/html/scripts/jquery-1.11.0.min.js new file mode 100644 index 00000000000..73f33fb3aa5 --- /dev/null +++ b/doc/ref/csharp/html/scripts/jquery-1.11.0.min.js @@ -0,0 +1,4 @@ +/*! jQuery v1.11.0 | (c) 2005, 2014 jQuery Foundation, Inc. | jquery.org/license */ +!function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){var c=[],d=c.slice,e=c.concat,f=c.push,g=c.indexOf,h={},i=h.toString,j=h.hasOwnProperty,k="".trim,l={},m="1.11.0",n=function(a,b){return new n.fn.init(a,b)},o=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,p=/^-ms-/,q=/-([\da-z])/gi,r=function(a,b){return b.toUpperCase()};n.fn=n.prototype={jquery:m,constructor:n,selector:"",length:0,toArray:function(){return d.call(this)},get:function(a){return null!=a?0>a?this[a+this.length]:this[a]:d.call(this)},pushStack:function(a){var b=n.merge(this.constructor(),a);return b.prevObject=this,b.context=this.context,b},each:function(a,b){return n.each(this,a,b)},map:function(a){return this.pushStack(n.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(d.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(0>a?b:0);return this.pushStack(c>=0&&b>c?[this[c]]:[])},end:function(){return this.prevObject||this.constructor(null)},push:f,sort:c.sort,splice:c.splice},n.extend=n.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||n.isFunction(g)||(g={}),h===i&&(g=this,h--);i>h;h++)if(null!=(e=arguments[h]))for(d in e)a=g[d],c=e[d],g!==c&&(j&&c&&(n.isPlainObject(c)||(b=n.isArray(c)))?(b?(b=!1,f=a&&n.isArray(a)?a:[]):f=a&&n.isPlainObject(a)?a:{},g[d]=n.extend(j,f,c)):void 0!==c&&(g[d]=c));return g},n.extend({expando:"jQuery"+(m+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===n.type(a)},isArray:Array.isArray||function(a){return"array"===n.type(a)},isWindow:function(a){return null!=a&&a==a.window},isNumeric:function(a){return a-parseFloat(a)>=0},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},isPlainObject:function(a){var b;if(!a||"object"!==n.type(a)||a.nodeType||n.isWindow(a))return!1;try{if(a.constructor&&!j.call(a,"constructor")&&!j.call(a.constructor.prototype,"isPrototypeOf"))return!1}catch(c){return!1}if(l.ownLast)for(b in a)return j.call(a,b);for(b in a);return void 0===b||j.call(a,b)},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?h[i.call(a)]||"object":typeof a},globalEval:function(b){b&&n.trim(b)&&(a.execScript||function(b){a.eval.call(a,b)})(b)},camelCase:function(a){return a.replace(p,"ms-").replace(q,r)},nodeName:function(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()},each:function(a,b,c){var d,e=0,f=a.length,g=s(a);if(c){if(g){for(;f>e;e++)if(d=b.apply(a[e],c),d===!1)break}else for(e in a)if(d=b.apply(a[e],c),d===!1)break}else if(g){for(;f>e;e++)if(d=b.call(a[e],e,a[e]),d===!1)break}else for(e in a)if(d=b.call(a[e],e,a[e]),d===!1)break;return a},trim:k&&!k.call("\ufeff\xa0")?function(a){return null==a?"":k.call(a)}:function(a){return null==a?"":(a+"").replace(o,"")},makeArray:function(a,b){var c=b||[];return null!=a&&(s(Object(a))?n.merge(c,"string"==typeof a?[a]:a):f.call(c,a)),c},inArray:function(a,b,c){var d;if(b){if(g)return g.call(b,a,c);for(d=b.length,c=c?0>c?Math.max(0,d+c):c:0;d>c;c++)if(c in b&&b[c]===a)return c}return-1},merge:function(a,b){var c=+b.length,d=0,e=a.length;while(c>d)a[e++]=b[d++];if(c!==c)while(void 0!==b[d])a[e++]=b[d++];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;g>f;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,f=0,g=a.length,h=s(a),i=[];if(h)for(;g>f;f++)d=b(a[f],f,c),null!=d&&i.push(d);else for(f in a)d=b(a[f],f,c),null!=d&&i.push(d);return e.apply([],i)},guid:1,proxy:function(a,b){var c,e,f;return"string"==typeof b&&(f=a[b],b=a,a=f),n.isFunction(a)?(c=d.call(arguments,2),e=function(){return a.apply(b||this,c.concat(d.call(arguments)))},e.guid=a.guid=a.guid||n.guid++,e):void 0},now:function(){return+new Date},support:l}),n.each("Boolean Number String Function Array Date RegExp Object Error".split(" "),function(a,b){h["[object "+b+"]"]=b.toLowerCase()});function s(a){var b=a.length,c=n.type(a);return"function"===c||n.isWindow(a)?!1:1===a.nodeType&&b?!0:"array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a}var t=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s="sizzle"+-new Date,t=a.document,u=0,v=0,w=eb(),x=eb(),y=eb(),z=function(a,b){return a===b&&(j=!0),0},A="undefined",B=1<<31,C={}.hasOwnProperty,D=[],E=D.pop,F=D.push,G=D.push,H=D.slice,I=D.indexOf||function(a){for(var b=0,c=this.length;c>b;b++)if(this[b]===a)return b;return-1},J="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",K="[\\x20\\t\\r\\n\\f]",L="(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+",M=L.replace("w","w#"),N="\\["+K+"*("+L+")"+K+"*(?:([*^$|!~]?=)"+K+"*(?:(['\"])((?:\\\\.|[^\\\\])*?)\\3|("+M+")|)|)"+K+"*\\]",O=":("+L+")(?:\\(((['\"])((?:\\\\.|[^\\\\])*?)\\3|((?:\\\\.|[^\\\\()[\\]]|"+N.replace(3,8)+")*)|.*)\\)|)",P=new RegExp("^"+K+"+|((?:^|[^\\\\])(?:\\\\.)*)"+K+"+$","g"),Q=new RegExp("^"+K+"*,"+K+"*"),R=new RegExp("^"+K+"*([>+~]|"+K+")"+K+"*"),S=new RegExp("="+K+"*([^\\]'\"]*?)"+K+"*\\]","g"),T=new RegExp(O),U=new RegExp("^"+M+"$"),V={ID:new RegExp("^#("+L+")"),CLASS:new RegExp("^\\.("+L+")"),TAG:new RegExp("^("+L.replace("w","w*")+")"),ATTR:new RegExp("^"+N),PSEUDO:new RegExp("^"+O),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+K+"*(even|odd|(([+-]|)(\\d*)n|)"+K+"*(?:([+-]|)"+K+"*(\\d+)|))"+K+"*\\)|)","i"),bool:new RegExp("^(?:"+J+")$","i"),needsContext:new RegExp("^"+K+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+K+"*((?:-\\d)?\\d*)"+K+"*\\)|)(?=[^-]|$)","i")},W=/^(?:input|select|textarea|button)$/i,X=/^h\d$/i,Y=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,$=/[+~]/,_=/'|\\/g,ab=new RegExp("\\\\([\\da-f]{1,6}"+K+"?|("+K+")|.)","ig"),bb=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:0>d?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)};try{G.apply(D=H.call(t.childNodes),t.childNodes),D[t.childNodes.length].nodeType}catch(cb){G={apply:D.length?function(a,b){F.apply(a,H.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function db(a,b,d,e){var f,g,h,i,j,m,p,q,u,v;if((b?b.ownerDocument||b:t)!==l&&k(b),b=b||l,d=d||[],!a||"string"!=typeof a)return d;if(1!==(i=b.nodeType)&&9!==i)return[];if(n&&!e){if(f=Z.exec(a))if(h=f[1]){if(9===i){if(g=b.getElementById(h),!g||!g.parentNode)return d;if(g.id===h)return d.push(g),d}else if(b.ownerDocument&&(g=b.ownerDocument.getElementById(h))&&r(b,g)&&g.id===h)return d.push(g),d}else{if(f[2])return G.apply(d,b.getElementsByTagName(a)),d;if((h=f[3])&&c.getElementsByClassName&&b.getElementsByClassName)return G.apply(d,b.getElementsByClassName(h)),d}if(c.qsa&&(!o||!o.test(a))){if(q=p=s,u=b,v=9===i&&a,1===i&&"object"!==b.nodeName.toLowerCase()){m=ob(a),(p=b.getAttribute("id"))?q=p.replace(_,"\\$&"):b.setAttribute("id",q),q="[id='"+q+"'] ",j=m.length;while(j--)m[j]=q+pb(m[j]);u=$.test(a)&&mb(b.parentNode)||b,v=m.join(",")}if(v)try{return G.apply(d,u.querySelectorAll(v)),d}catch(w){}finally{p||b.removeAttribute("id")}}}return xb(a.replace(P,"$1"),b,d,e)}function eb(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function fb(a){return a[s]=!0,a}function gb(a){var b=l.createElement("div");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function hb(a,b){var c=a.split("|"),e=a.length;while(e--)d.attrHandle[c[e]]=b}function ib(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&(~b.sourceIndex||B)-(~a.sourceIndex||B);if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function jb(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function kb(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function lb(a){return fb(function(b){return b=+b,fb(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function mb(a){return a&&typeof a.getElementsByTagName!==A&&a}c=db.support={},f=db.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return b?"HTML"!==b.nodeName:!1},k=db.setDocument=function(a){var b,e=a?a.ownerDocument||a:t,g=e.defaultView;return e!==l&&9===e.nodeType&&e.documentElement?(l=e,m=e.documentElement,n=!f(e),g&&g!==g.top&&(g.addEventListener?g.addEventListener("unload",function(){k()},!1):g.attachEvent&&g.attachEvent("onunload",function(){k()})),c.attributes=gb(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=gb(function(a){return a.appendChild(e.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=Y.test(e.getElementsByClassName)&&gb(function(a){return a.innerHTML="",a.firstChild.className="i",2===a.getElementsByClassName("i").length}),c.getById=gb(function(a){return m.appendChild(a).id=s,!e.getElementsByName||!e.getElementsByName(s).length}),c.getById?(d.find.ID=function(a,b){if(typeof b.getElementById!==A&&n){var c=b.getElementById(a);return c&&c.parentNode?[c]:[]}},d.filter.ID=function(a){var b=a.replace(ab,bb);return function(a){return a.getAttribute("id")===b}}):(delete d.find.ID,d.filter.ID=function(a){var b=a.replace(ab,bb);return function(a){var c=typeof a.getAttributeNode!==A&&a.getAttributeNode("id");return c&&c.value===b}}),d.find.TAG=c.getElementsByTagName?function(a,b){return typeof b.getElementsByTagName!==A?b.getElementsByTagName(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){return typeof b.getElementsByClassName!==A&&n?b.getElementsByClassName(a):void 0},p=[],o=[],(c.qsa=Y.test(e.querySelectorAll))&&(gb(function(a){a.innerHTML="",a.querySelectorAll("[t^='']").length&&o.push("[*^$]="+K+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||o.push("\\["+K+"*(?:value|"+J+")"),a.querySelectorAll(":checked").length||o.push(":checked")}),gb(function(a){var b=e.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&o.push("name"+K+"*[*^$|!~]?="),a.querySelectorAll(":enabled").length||o.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),o.push(",.*:")})),(c.matchesSelector=Y.test(q=m.webkitMatchesSelector||m.mozMatchesSelector||m.oMatchesSelector||m.msMatchesSelector))&&gb(function(a){c.disconnectedMatch=q.call(a,"div"),q.call(a,"[s!='']:x"),p.push("!=",O)}),o=o.length&&new RegExp(o.join("|")),p=p.length&&new RegExp(p.join("|")),b=Y.test(m.compareDocumentPosition),r=b||Y.test(m.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},z=b?function(a,b){if(a===b)return j=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===e||a.ownerDocument===t&&r(t,a)?-1:b===e||b.ownerDocument===t&&r(t,b)?1:i?I.call(i,a)-I.call(i,b):0:4&d?-1:1)}:function(a,b){if(a===b)return j=!0,0;var c,d=0,f=a.parentNode,g=b.parentNode,h=[a],k=[b];if(!f||!g)return a===e?-1:b===e?1:f?-1:g?1:i?I.call(i,a)-I.call(i,b):0;if(f===g)return ib(a,b);c=a;while(c=c.parentNode)h.unshift(c);c=b;while(c=c.parentNode)k.unshift(c);while(h[d]===k[d])d++;return d?ib(h[d],k[d]):h[d]===t?-1:k[d]===t?1:0},e):l},db.matches=function(a,b){return db(a,null,null,b)},db.matchesSelector=function(a,b){if((a.ownerDocument||a)!==l&&k(a),b=b.replace(S,"='$1']"),!(!c.matchesSelector||!n||p&&p.test(b)||o&&o.test(b)))try{var d=q.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return db(b,l,null,[a]).length>0},db.contains=function(a,b){return(a.ownerDocument||a)!==l&&k(a),r(a,b)},db.attr=function(a,b){(a.ownerDocument||a)!==l&&k(a);var e=d.attrHandle[b.toLowerCase()],f=e&&C.call(d.attrHandle,b.toLowerCase())?e(a,b,!n):void 0;return void 0!==f?f:c.attributes||!n?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},db.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},db.uniqueSort=function(a){var b,d=[],e=0,f=0;if(j=!c.detectDuplicates,i=!c.sortStable&&a.slice(0),a.sort(z),j){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return i=null,a},e=db.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=db.selectors={cacheLength:50,createPseudo:fb,match:V,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(ab,bb),a[3]=(a[4]||a[5]||"").replace(ab,bb),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||db.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&db.error(a[0]),a},PSEUDO:function(a){var b,c=!a[5]&&a[2];return V.CHILD.test(a[0])?null:(a[3]&&void 0!==a[4]?a[2]=a[4]:c&&T.test(c)&&(b=ob(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(ab,bb).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=w[a+" "];return b||(b=new RegExp("(^|"+K+")"+a+"("+K+"|$)"))&&w(a,function(a){return b.test("string"==typeof a.className&&a.className||typeof a.getAttribute!==A&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=db.attr(d,a);return null==e?"!="===b:b?(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e+" ").indexOf(c)>-1:"|="===b?e===c||e.slice(0,c.length+1)===c+"-":!1):!0}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),t=!i&&!h;if(q){if(f){while(p){l=b;while(l=l[p])if(h?l.nodeName.toLowerCase()===r:1===l.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&t){k=q[s]||(q[s]={}),j=k[a]||[],n=j[0]===u&&j[1],m=j[0]===u&&j[2],l=n&&q.childNodes[n];while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if(1===l.nodeType&&++m&&l===b){k[a]=[u,n,m];break}}else if(t&&(j=(b[s]||(b[s]={}))[a])&&j[0]===u)m=j[1];else while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if((h?l.nodeName.toLowerCase()===r:1===l.nodeType)&&++m&&(t&&((l[s]||(l[s]={}))[a]=[u,m]),l===b))break;return m-=e,m===d||m%d===0&&m/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||db.error("unsupported pseudo: "+a);return e[s]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?fb(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=I.call(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:fb(function(a){var b=[],c=[],d=g(a.replace(P,"$1"));return d[s]?fb(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),!c.pop()}}),has:fb(function(a){return function(b){return db(a,b).length>0}}),contains:fb(function(a){return function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:fb(function(a){return U.test(a||"")||db.error("unsupported lang: "+a),a=a.replace(ab,bb).toLowerCase(),function(b){var c;do if(c=n?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===m},focus:function(a){return a===l.activeElement&&(!l.hasFocus||l.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:function(a){return a.disabled===!1},disabled:function(a){return a.disabled===!0},checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return X.test(a.nodeName)},input:function(a){return W.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:lb(function(){return[0]}),last:lb(function(a,b){return[b-1]}),eq:lb(function(a,b,c){return[0>c?c+b:c]}),even:lb(function(a,b){for(var c=0;b>c;c+=2)a.push(c);return a}),odd:lb(function(a,b){for(var c=1;b>c;c+=2)a.push(c);return a}),lt:lb(function(a,b,c){for(var d=0>c?c+b:c;--d>=0;)a.push(d);return a}),gt:lb(function(a,b,c){for(var d=0>c?c+b:c;++d","
"]},tb=eb(z),ub=tb.appendChild(z.createElement("div"));sb.optgroup=sb.option,sb.tbody=sb.tfoot=sb.colgroup=sb.caption=sb.thead,sb.th=sb.td;function vb(a,b){var c,d,e=0,f=typeof a.getElementsByTagName!==L?a.getElementsByTagName(b||"*"):typeof a.querySelectorAll!==L?a.querySelectorAll(b||"*"):void 0;if(!f)for(f=[],c=a.childNodes||a;null!=(d=c[e]);e++)!b||n.nodeName(d,b)?f.push(d):n.merge(f,vb(d,b));return void 0===b||b&&n.nodeName(a,b)?n.merge([a],f):f}function wb(a){X.test(a.type)&&(a.defaultChecked=a.checked)}function xb(a,b){return n.nodeName(a,"table")&&n.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function yb(a){return a.type=(null!==n.find.attr(a,"type"))+"/"+a.type,a}function zb(a){var b=qb.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function Ab(a,b){for(var c,d=0;null!=(c=a[d]);d++)n._data(c,"globalEval",!b||n._data(b[d],"globalEval"))}function Bb(a,b){if(1===b.nodeType&&n.hasData(a)){var c,d,e,f=n._data(a),g=n._data(b,f),h=f.events;if(h){delete g.handle,g.events={};for(c in h)for(d=0,e=h[c].length;e>d;d++)n.event.add(b,c,h[c][d])}g.data&&(g.data=n.extend({},g.data))}}function Cb(a,b){var c,d,e;if(1===b.nodeType){if(c=b.nodeName.toLowerCase(),!l.noCloneEvent&&b[n.expando]){e=n._data(b);for(d in e.events)n.removeEvent(b,d,e.handle);b.removeAttribute(n.expando)}"script"===c&&b.text!==a.text?(yb(b).text=a.text,zb(b)):"object"===c?(b.parentNode&&(b.outerHTML=a.outerHTML),l.html5Clone&&a.innerHTML&&!n.trim(b.innerHTML)&&(b.innerHTML=a.innerHTML)):"input"===c&&X.test(a.type)?(b.defaultChecked=b.checked=a.checked,b.value!==a.value&&(b.value=a.value)):"option"===c?b.defaultSelected=b.selected=a.defaultSelected:("input"===c||"textarea"===c)&&(b.defaultValue=a.defaultValue)}}n.extend({clone:function(a,b,c){var d,e,f,g,h,i=n.contains(a.ownerDocument,a);if(l.html5Clone||n.isXMLDoc(a)||!hb.test("<"+a.nodeName+">")?f=a.cloneNode(!0):(ub.innerHTML=a.outerHTML,ub.removeChild(f=ub.firstChild)),!(l.noCloneEvent&&l.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||n.isXMLDoc(a)))for(d=vb(f),h=vb(a),g=0;null!=(e=h[g]);++g)d[g]&&Cb(e,d[g]);if(b)if(c)for(h=h||vb(a),d=d||vb(f),g=0;null!=(e=h[g]);g++)Bb(e,d[g]);else Bb(a,f);return d=vb(f,"script"),d.length>0&&Ab(d,!i&&vb(a,"script")),d=h=e=null,f},buildFragment:function(a,b,c,d){for(var e,f,g,h,i,j,k,m=a.length,o=eb(b),p=[],q=0;m>q;q++)if(f=a[q],f||0===f)if("object"===n.type(f))n.merge(p,f.nodeType?[f]:f);else if(mb.test(f)){h=h||o.appendChild(b.createElement("div")),i=(kb.exec(f)||["",""])[1].toLowerCase(),k=sb[i]||sb._default,h.innerHTML=k[1]+f.replace(jb,"<$1>")+k[2],e=k[0];while(e--)h=h.lastChild;if(!l.leadingWhitespace&&ib.test(f)&&p.push(b.createTextNode(ib.exec(f)[0])),!l.tbody){f="table"!==i||lb.test(f)?"| t |
").append(n.parseHTML(a)).find(d):a)}).complete(c&&function(a,b){g.each(c,e||[a.responseText,b,a])}),this},n.expr.filters.animated=function(a){return n.grep(n.timers,function(b){return a===b.elem}).length};var dd=a.document.documentElement;function ed(a){return n.isWindow(a)?a:9===a.nodeType?a.defaultView||a.parentWindow:!1}n.offset={setOffset:function(a,b,c){var d,e,f,g,h,i,j,k=n.css(a,"position"),l=n(a),m={};"static"===k&&(a.style.position="relative"),h=l.offset(),f=n.css(a,"top"),i=n.css(a,"left"),j=("absolute"===k||"fixed"===k)&&n.inArray("auto",[f,i])>-1,j?(d=l.position(),g=d.top,e=d.left):(g=parseFloat(f)||0,e=parseFloat(i)||0),n.isFunction(b)&&(b=b.call(a,c,h)),null!=b.top&&(m.top=b.top-h.top+g),null!=b.left&&(m.left=b.left-h.left+e),"using"in b?b.using.call(a,m):l.css(m)}},n.fn.extend({offset:function(a){if(arguments.length)return void 0===a?this:this.each(function(b){n.offset.setOffset(this,a,b)});var b,c,d={top:0,left:0},e=this[0],f=e&&e.ownerDocument;if(f)return b=f.documentElement,n.contains(b,e)?(typeof e.getBoundingClientRect!==L&&(d=e.getBoundingClientRect()),c=ed(f),{top:d.top+(c.pageYOffset||b.scrollTop)-(b.clientTop||0),left:d.left+(c.pageXOffset||b.scrollLeft)-(b.clientLeft||0)}):d},position:function(){if(this[0]){var a,b,c={top:0,left:0},d=this[0];return"fixed"===n.css(d,"position")?b=d.getBoundingClientRect():(a=this.offsetParent(),b=this.offset(),n.nodeName(a[0],"html")||(c=a.offset()),c.top+=n.css(a[0],"borderTopWidth",!0),c.left+=n.css(a[0],"borderLeftWidth",!0)),{top:b.top-c.top-n.css(d,"marginTop",!0),left:b.left-c.left-n.css(d,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var a=this.offsetParent||dd;while(a&&!n.nodeName(a,"html")&&"static"===n.css(a,"position"))a=a.offsetParent;return a||dd})}}),n.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(a,b){var c=/Y/.test(b);n.fn[a]=function(d){return W(this,function(a,d,e){var f=ed(a);return void 0===e?f?b in f?f[b]:f.document.documentElement[d]:a[d]:void(f?f.scrollTo(c?n(f).scrollLeft():e,c?e:n(f).scrollTop()):a[d]=e)},a,d,arguments.length,null)}}),n.each(["top","left"],function(a,b){n.cssHooks[b]=Mb(l.pixelPosition,function(a,c){return c?(c=Kb(a,b),Ib.test(c)?n(a).position()[b]+"px":c):void 0})}),n.each({Height:"height",Width:"width"},function(a,b){n.each({padding:"inner"+a,content:b,"":"outer"+a},function(c,d){n.fn[d]=function(d,e){var f=arguments.length&&(c||"boolean"!=typeof d),g=c||(d===!0||e===!0?"margin":"border");return W(this,function(b,c,d){var e;return n.isWindow(b)?b.document.documentElement["client"+a]:9===b.nodeType?(e=b.documentElement,Math.max(b.body["scroll"+a],e["scroll"+a],b.body["offset"+a],e["offset"+a],e["client"+a])):void 0===d?n.css(b,c,g):n.style(b,c,d,g)},b,f?d:void 0,f,null)}})}),n.fn.size=function(){return this.length},n.fn.andSelf=n.fn.addBack,"function"==typeof define&&define.amd&&define("jquery",[],function(){return n});var fd=a.jQuery,gd=a.$;return n.noConflict=function(b){return a.$===n&&(a.$=gd),b&&a.jQuery===n&&(a.jQuery=fd),n},typeof b===L&&(a.jQuery=a.$=n),n});
diff --git a/doc/ref/csharp/html/search.html b/doc/ref/csharp/html/search.html
new file mode 100644
index 00000000000..296a4d29da4
--- /dev/null
+++ b/doc/ref/csharp/html/search.html
@@ -0,0 +1,35 @@
+
+
+
+ gRPC C# - Search
+
+
+
+
+
+
+
+
#include
+#include
#include
#include
-#include
-#include
-#include
+#include
#include
#include
-#include
-#include "test/cpp/util/test_config.h"
#include "examples/pubsub/publisher.h"
#include "examples/pubsub/subscriber.h"
+#include "test/cpp/util/test_config.h"
DEFINE_int32(server_port, 443, "Server port.");
DEFINE_string(server_host, "pubsub-staging.googleapis.com",
@@ -72,7 +70,7 @@ int main(int argc, char** argv) {
ss << FLAGS_server_host << ":" << FLAGS_server_port;
std::shared_ptr creds = grpc::GoogleDefaultCredentials();
- std::shared_ptr channel =
+ std::shared_ptr channel =
grpc::CreateChannel(ss.str(), creds, grpc::ChannelArguments());
grpc::examples::pubsub::Publisher publisher(channel);
diff --git a/examples/pubsub/publisher.cc b/examples/pubsub/publisher.cc
index 458050af739..fd38ca92ed9 100644
--- a/examples/pubsub/publisher.cc
+++ b/examples/pubsub/publisher.cc
@@ -50,7 +50,7 @@ namespace grpc {
namespace examples {
namespace pubsub {
-Publisher::Publisher(std::shared_ptr channel)
+Publisher::Publisher(std::shared_ptr channel)
: stub_(PublisherService::NewStub(channel)) {}
void Publisher::Shutdown() { stub_.reset(); }
diff --git a/examples/pubsub/publisher.h b/examples/pubsub/publisher.h
index 33bcf98df48..02e6194b0bd 100644
--- a/examples/pubsub/publisher.h
+++ b/examples/pubsub/publisher.h
@@ -34,8 +34,7 @@
#ifndef GRPC_EXAMPLES_PUBSUB_PUBLISHER_H
#define GRPC_EXAMPLES_PUBSUB_PUBLISHER_H
-#include
-#include
+#include
#include "examples/pubsub/pubsub.grpc.pb.h"
@@ -45,7 +44,7 @@ namespace pubsub {
class Publisher {
public:
- Publisher(std::shared_ptr channel);
+ Publisher(std::shared_ptr channel);
void Shutdown();
Status CreateTopic(const grpc::string& topic);
diff --git a/examples/pubsub/publisher_test.cc b/examples/pubsub/publisher_test.cc
index 6b9dcacc499..c2eb295ef27 100644
--- a/examples/pubsub/publisher_test.cc
+++ b/examples/pubsub/publisher_test.cc
@@ -31,22 +31,20 @@
*
*/
-#include
-#include
+#include
#include
#include
#include
#include
#include
#include
-#include
#include
#include "examples/pubsub/publisher.h"
#include "test/core/util/port.h"
#include "test/core/util/test_config.h"
-using grpc::ChannelInterface;
+using grpc::Channel;
namespace grpc {
namespace testing {
@@ -124,7 +122,7 @@ class PublisherTest : public ::testing::Test {
std::unique_ptr server_;
PublisherServiceImpl service_;
- std::shared_ptr channel_;
+ std::shared_ptr channel_;
std::unique_ptr publisher_;
};
diff --git a/examples/pubsub/subscriber.cc b/examples/pubsub/subscriber.cc
index d9e0292ba0f..0818f501db8 100644
--- a/examples/pubsub/subscriber.cc
+++ b/examples/pubsub/subscriber.cc
@@ -48,7 +48,7 @@ namespace grpc {
namespace examples {
namespace pubsub {
-Subscriber::Subscriber(std::shared_ptr channel)
+Subscriber::Subscriber(std::shared_ptr channel)
: stub_(SubscriberService::NewStub(channel)) {}
void Subscriber::Shutdown() { stub_.reset(); }
diff --git a/examples/pubsub/subscriber.h b/examples/pubsub/subscriber.h
index 40ab45471d5..c5b1df0d3ec 100644
--- a/examples/pubsub/subscriber.h
+++ b/examples/pubsub/subscriber.h
@@ -34,8 +34,7 @@
#ifndef GRPC_EXAMPLES_PUBSUB_SUBSCRIBER_H
#define GRPC_EXAMPLES_PUBSUB_SUBSCRIBER_H
-#include
-#include
+#include
#include "examples/pubsub/pubsub.grpc.pb.h"
@@ -45,7 +44,7 @@ namespace pubsub {
class Subscriber {
public:
- Subscriber(std::shared_ptr channel);
+ Subscriber(std::shared_ptr channel);
void Shutdown();
Status CreateSubscription(const grpc::string& topic,
diff --git a/examples/pubsub/subscriber_test.cc b/examples/pubsub/subscriber_test.cc
index b0e7fc034b8..c5a077f407c 100644
--- a/examples/pubsub/subscriber_test.cc
+++ b/examples/pubsub/subscriber_test.cc
@@ -31,15 +31,13 @@
*
*/
-#include
-#include
+#include
#include
#include
#include
#include
#include
#include
-#include
#include
#include "examples/pubsub/subscriber.h"
@@ -122,7 +120,7 @@ class SubscriberTest : public ::testing::Test {
std::unique_ptr server_;
SubscriberServiceImpl service_;
- std::shared_ptr channel_;
+ std::shared_ptr channel_;
std::unique_ptr subscriber_;
};
diff --git a/gRPC.podspec b/gRPC.podspec
index 2af608a620b..d945c299b51 100644
--- a/gRPC.podspec
+++ b/gRPC.podspec
@@ -202,6 +202,7 @@ Pod::Spec.new do |s|
'src/core/iomgr/tcp_server.h',
'src/core/iomgr/tcp_windows.h',
'src/core/iomgr/time_averaged_stats.h',
+ 'src/core/iomgr/udp_server.h',
'src/core/iomgr/wakeup_fd_pipe.h',
'src/core/iomgr/wakeup_fd_posix.h',
'src/core/json/json.h',
@@ -333,6 +334,7 @@ Pod::Spec.new do |s|
'src/core/iomgr/tcp_server_windows.c',
'src/core/iomgr/tcp_windows.c',
'src/core/iomgr/time_averaged_stats.c',
+ 'src/core/iomgr/udp_server.c',
'src/core/iomgr/wakeup_fd_eventfd.c',
'src/core/iomgr/wakeup_fd_nospecial.c',
'src/core/iomgr/wakeup_fd_pipe.c',
@@ -469,6 +471,7 @@ Pod::Spec.new do |s|
'src/core/iomgr/tcp_server.h',
'src/core/iomgr/tcp_windows.h',
'src/core/iomgr/time_averaged_stats.h',
+ 'src/core/iomgr/udp_server.h',
'src/core/iomgr/wakeup_fd_pipe.h',
'src/core/iomgr/wakeup_fd_posix.h',
'src/core/json/json.h',
diff --git a/include/grpc++/auth_metadata_processor.h b/include/grpc++/auth_metadata_processor.h
index db4beafeffd..3caf3e84fda 100644
--- a/include/grpc++/auth_metadata_processor.h
+++ b/include/grpc++/auth_metadata_processor.h
@@ -37,7 +37,7 @@
#include
+ gRPC C# - Search
+
+
+
+
+
+
diff --git a/doc/ref/csharp/html/styles/branding-Help1.css b/doc/ref/csharp/html/styles/branding-Help1.css
new file mode 100644
index 00000000000..8f7ba25a3ba
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding-Help1.css
@@ -0,0 +1,40 @@
+/* Define the userData cache persistence mechanism for Help 1 files */
+.userDataStyle {
+ behavior: url(#default#userdata);
+}
+
+/* Style adjustments for Help 1 */
+.pageBody {
+ padding-top: 0px 20px 0px 0px;
+}
+
+table {
+ width: 95%;
+ padding-right: 20px;
+}
+
+table.members {
+ width: 95%;
+ padding-right: 20px;
+}
+
+th p {
+ padding-bottom: 0px;
+}
+
+td p {
+ padding-bottom: 5px;
+}
+
+.codeSnippetContainerTabs {
+ top: 1px;
+}
+
+.codeSnippetToolBarText {
+ top: -13px;
+}
+
+.codeSnippetContainerTabSingle {
+ padding: 2px 15px 0px 15px;
+ height: 22px;
+}
diff --git a/doc/ref/csharp/html/styles/branding-HelpViewer.css b/doc/ref/csharp/html/styles/branding-HelpViewer.css
new file mode 100644
index 00000000000..951621be660
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding-HelpViewer.css
@@ -0,0 +1,48 @@
+/* Style adjustments for Help Viewer */
+.pageBody {
+ padding-top: 0px 20px 0px 0px;
+}
+
+table {
+ width: 95%;
+ padding-right: 20px;
+}
+
+table.members {
+ width: 95%;
+ padding-right: 20px;
+}
+
+th p {
+ padding-bottom: 0px;
+}
+
+td p {
+ padding-bottom: 5px;
+}
+
+.codeSnippetContainerTabs {
+ top: 1px;
+}
+
+.codeSnippetToolBarText {
+ top: -13px;
+}
+
+.codeSnippetContainerTabSingle {
+ padding: 2px 15px 0px 15px;
+ height: 22px;
+}
+
+.codeSnippetContainerTab a:visited {
+ color: #000000;
+}
+
+.codeSnippetContainerTabActive a:visited {
+ color: #000000;
+}
+
+span.keyword {
+ color: #0000ff;
+ font-weight: normal;
+}
diff --git a/doc/ref/csharp/html/styles/branding-Website.css b/doc/ref/csharp/html/styles/branding-Website.css
new file mode 100644
index 00000000000..d39e08c771d
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding-Website.css
@@ -0,0 +1,156 @@
+/* Style adjustments for websites */
+.pageBody {
+ padding: 0px 20px 0px 0px;
+}
+.topicContent {
+ margin-left: 280px;
+}
+
+/* Lightweight TOC */
+.tocCollapsed {
+ background: url('../icons/TocCollapsed.gif') no-repeat scroll center;
+ width: 17px;
+ height: 20px;
+ overflow: hidden;
+}
+.tocExpanded {
+ background: url('../icons/TocExpanded.gif') no-repeat scroll center;
+ width: 17px;
+ height: 20px;
+ overflow: hidden;
+}
+.tocResize {
+ position: absolute;
+ top: 90px;
+ left: 300px;
+ width: 5px;
+ height: 20px;
+ padding-right: 5px;
+}
+.tocResize img {
+ border: none;
+ cursor: pointer;
+}
+div#leftNav {
+ float: left;
+ margin: 0px -1px 0 0;
+ width: 280px;
+ min-height: 10px;
+ position: relative;
+ border-right: 1px solid #b6b6b6;
+ padding-left: 10px;
+ padding-top: 15px;
+}
+div#tocNav {
+ font-family: 'Segoe UI' ,Verdana,Arial;
+ overflow-x: hidden;
+ line-height: normal;
+ margin: -20px 0 0 -4px;
+}
+div#tocNav > div {
+ overflow-x: hidden;
+ white-space: normal;
+ width: auto;
+ margin-bottom: 5px;
+}
+div#leftNav a, div#leftNav a:link, div#leftNav a:visited {
+ color: #1364c4;
+ text-decoration: none;
+}
+div#leftNav a:hover {
+ color: #3390b1;
+}
+div#tocNav > div > a, div#tocNav > div > a:link, div#tocNav > div > a:visited {
+ display: block;
+ margin-left: 18px;
+ overflow: hidden;
+}
+div#tocNav > div.current > a, div#tocNav > div.current > a:link, div#tocNav > div.current > a:visited {
+ color: #000;
+ font-weight: bold;
+ text-decoration: none;
+}
+div#tocNav > div > a.tocExpanded, div#tocNav > div > a.tocCollapsed {
+ float: left;
+ display: inline-block;
+ margin-left: 0;
+ vertical-align: top;
+}
+div#tocResizableEW {
+ cursor: e-resize;
+ width: 15px;
+ top: 0;
+ height: 100%;
+ position: absolute;
+ display: block;
+ font-size: 0.5px;
+ right: -7px;
+}
+.toclevel0:first-child {
+ margin-top: 16px;
+}
+div#tocNav > div.toclevel1 {
+ padding-left: 17px;
+}
+div#tocNav > div.toclevel2 {
+ padding-left: 34px;
+}
+div#tocNav > div.toclevel3 {
+ padding-left: 51px;
+}
+div#tocNav > div.toclevel4 {
+ padding-left: 68px;
+}
+div#tocNav > div.toclevel5 {
+ padding-left: 85px;
+}
+div#tocNav > div.toclevel6 {
+ padding-left: 102px;
+}
+div#tocNav > div.toclevel7 {
+ padding-left: 119px;
+}
+div#tocNav > div.toclevel8 {
+ padding-left: 136px;
+}
+div#tocNav > div.toclevel9 {
+ padding-left: 153px;
+}
+div#tocNav > div.toclevel10 {
+ padding-left: 170px;
+}
+
+/* Search form */
+form#SearchForm {
+ float: right;
+ background-color: #eee;
+ width: 280px;
+}
+form#SearchForm input {
+ background-color: #eee;
+ border: 0;
+ height: 22px;
+ width: 230px;
+ color: #3b3b3b;
+ display: inline-block;
+ margin: 1px 0 0 0;
+ padding: 1px 4px 1px 10px;
+}
+form#SearchForm button {
+ background: url('../icons/Search.png') no-repeat scroll center;
+ background-color: #eee;
+ float: right;
+ border: 0;
+ margin: 3px 2px 0 0;
+ cursor: pointer;
+ color: #3b3b3b;
+ width: 19px;
+ height: 18px;
+ overflow: hidden;
+}
+.searchContainer {
+ width: 700px;
+ margin-top: 50px;
+ margin-left: auto;
+ margin-right: auto;
+}
diff --git a/doc/ref/csharp/html/styles/branding-cs-CZ.css b/doc/ref/csharp/html/styles/branding-cs-CZ.css
new file mode 100644
index 00000000000..f38de74970c
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding-cs-CZ.css
@@ -0,0 +1,3 @@
+/* Start CS-CZ locale-specific CSS */
+
+/* End locale-specific CSS */
diff --git a/doc/ref/csharp/html/styles/branding-de-DE.css b/doc/ref/csharp/html/styles/branding-de-DE.css
new file mode 100644
index 00000000000..4cf80baddae
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding-de-DE.css
@@ -0,0 +1,3 @@
+/* Start DE-DE locale-specific CSS */
+
+/* End locale-specific CSS */
diff --git a/doc/ref/csharp/html/styles/branding-en-US.css b/doc/ref/csharp/html/styles/branding-en-US.css
new file mode 100644
index 00000000000..248cbe5a2a4
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding-en-US.css
@@ -0,0 +1,3 @@
+/* Start EN-US locale-specific CSS */
+
+/* End locale-specific CSS */
diff --git a/doc/ref/csharp/html/styles/branding-es-ES.css b/doc/ref/csharp/html/styles/branding-es-ES.css
new file mode 100644
index 00000000000..4a7ebbd68dc
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding-es-ES.css
@@ -0,0 +1,3 @@
+/* Start ES-ES locale-specific CSS */
+
+/* End locale-specific CSS */
diff --git a/doc/ref/csharp/html/styles/branding-fr-FR.css b/doc/ref/csharp/html/styles/branding-fr-FR.css
new file mode 100644
index 00000000000..d924dec9654
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding-fr-FR.css
@@ -0,0 +1,3 @@
+/* Start FR-FR locale-specific CSS */
+
+/* End locale-specific CSS */
diff --git a/doc/ref/csharp/html/styles/branding-it-IT.css b/doc/ref/csharp/html/styles/branding-it-IT.css
new file mode 100644
index 00000000000..36c6b224fb1
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding-it-IT.css
@@ -0,0 +1,3 @@
+/* Start IT-IT locale-specific CSS */
+
+/* End locale-specific CSS */
diff --git a/doc/ref/csharp/html/styles/branding-ja-JP.css b/doc/ref/csharp/html/styles/branding-ja-JP.css
new file mode 100644
index 00000000000..403aa6ddf8f
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding-ja-JP.css
@@ -0,0 +1,18 @@
+/* Start JA-JP locale-specific CSS */
+body
+{
+ font-family: Segoe UI, Verdana, Arial, ＭＳ Ｐゴシック;
+}
+pre
+{
+ font-family: Consolas, Courier, monospace, ＭＳ ゴシック;
+}
+span.tt
+{
+ font-family: Consolas, Courier, monospace, ＭＳ ゴシック;
+}
+span.code
+{
+ font-family: Consolas, Courier, monospace, ＭＳ ゴシック;
+}
+/* End locale-specific CSS */
diff --git a/doc/ref/csharp/html/styles/branding-ko-KR.css b/doc/ref/csharp/html/styles/branding-ko-KR.css
new file mode 100644
index 00000000000..2b46e923efb
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding-ko-KR.css
@@ -0,0 +1,19 @@
+/* Start KO-KR locale-specific CSS */
+body
+{
+ font-family: Malgun Gothic, Segoe UI, Verdana, Arial;
+ font-size: 0.75em; /*9pt*/
+}
+pre
+{
+ font-family: Consolas, Courier, monospace, 돋움체;
+}
+span.tt
+{
+ font-family: Consolas, Courier, monospace, 돋움체;
+}
+span.code
+{
+ font-family: Consolas, Courier, monospace, 돋움체;
+}
+/* End locale-specific CSS */
diff --git a/doc/ref/csharp/html/styles/branding-pl-PL.css b/doc/ref/csharp/html/styles/branding-pl-PL.css
new file mode 100644
index 00000000000..19e981032d4
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding-pl-PL.css
@@ -0,0 +1,3 @@
+/* Start PL-PL locale-specific CSS */
+
+/* End locale-specific CSS */
diff --git a/doc/ref/csharp/html/styles/branding-pt-BR.css b/doc/ref/csharp/html/styles/branding-pt-BR.css
new file mode 100644
index 00000000000..a0683b0ef20
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding-pt-BR.css
@@ -0,0 +1,3 @@
+/* Start PT-BR locale-specific CSS */
+
+/* End locale-specific CSS */
diff --git a/doc/ref/csharp/html/styles/branding-ru-RU.css b/doc/ref/csharp/html/styles/branding-ru-RU.css
new file mode 100644
index 00000000000..c31f83a44bc
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding-ru-RU.css
@@ -0,0 +1,3 @@
+/* Start RU-RU locale-specific CSS */
+
+/* End locale-specific CSS */
diff --git a/doc/ref/csharp/html/styles/branding-tr-TR.css b/doc/ref/csharp/html/styles/branding-tr-TR.css
new file mode 100644
index 00000000000..81ca462ef7c
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding-tr-TR.css
@@ -0,0 +1,3 @@
+/* Start TR-TR locale-specific CSS */
+
+/* End locale-specific CSS */
diff --git a/doc/ref/csharp/html/styles/branding-zh-CN.css b/doc/ref/csharp/html/styles/branding-zh-CN.css
new file mode 100644
index 00000000000..cf79e7cd000
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding-zh-CN.css
@@ -0,0 +1,18 @@
+/* Start ZH-CN locale-specific CSS */
+body
+{
+ font-family: MS YaHei, Simsun, Segoe UI, Verdana, Arial;
+}
+pre
+{
+ font-family: Consolas, Courier, monospace, 新宋体;
+}
+span.tt
+{
+ font-family: Consolas, Courier, monospace, 新宋体;
+}
+span.code
+{
+ font-family: Consolas, Courier, monospace, 新宋体;
+}
+/* End locale-specific CSS */
diff --git a/doc/ref/csharp/html/styles/branding-zh-TW.css b/doc/ref/csharp/html/styles/branding-zh-TW.css
new file mode 100644
index 00000000000..eab654f8c5e
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding-zh-TW.css
@@ -0,0 +1,18 @@
+/* Start ZH-TW locale-specific CSS */
+body
+{
+ font-family: MS JhengHei, MingLiU, Segoe UI, Verdana, Arial;
+}
+pre
+{
+ font-family: Consolas, Courier, monospace, 細明體;
+}
+span.tt
+{
+ font-family: Consolas, Courier, monospace, 細明體;
+}
+span.code
+{
+ font-family: Consolas, Courier, monospace, 細明體;
+}
+/* End locale-specific CSS */
diff --git a/doc/ref/csharp/html/styles/branding.css b/doc/ref/csharp/html/styles/branding.css
new file mode 100644
index 00000000000..7afa70b3150
--- /dev/null
+++ b/doc/ref/csharp/html/styles/branding.css
@@ -0,0 +1,561 @@
+/* General styles */
+body {
+ font-family: 'Segoe UI' , 'Lucida Grande' , Verdana, Arial, Helvetica, sans-serif;
+ font-size: 15px;
+ padding: 0;
+ margin: 0;
+ margin-left: auto;
+ margin-right: auto;
+ color: #000;
+}
+h1 {
+ font-family: 'Segoe UI' , 'Lucida Grande' , Verdana, Arial, Helvetica, sans-serif;
+ font-size: 2.5em;
+ font-weight: normal;
+ margin-top: 0;
+ color: #000;
+}
+h2, h3 {
+ font-family: 'Segoe UI Semibold' , 'Segoe UI' , 'Lucida Grande' , Verdana, Arial, Helvetica, sans-serif;
+ font-weight: normal;
+ margin: 0;
+ padding-bottom: 5px;
+ padding-top: 5px;
+ color: #000;
+}
+h2 {
+ font-size: 1.769em;
+}
+h3 {
+ font-size: 1.231em;
+}
+h4, .subHeading {
+ font-family: 'Segoe UI Semibold' , 'Segoe UI' , 'Lucida Grande' , Verdana, Arial, Helvetica, sans-serif;
+ font-size: 1.077em;
+ font-weight: normal;
+ margin: 0;
+ color: #000;
+}
+.subHeading {
+ margin-top: 5px;
+}
+h5, h6 {
+ font-family: 'Segoe UI Semibold' , 'Segoe UI' , 'Lucida Grande' , Verdana, Arial, Helvetica, sans-serif;
+ font-size: 1em;
+ font-weight: normal;
+ line-height: 130%;
+ margin: 0;
+ color: #000;
+}
+a, a:link {
+ text-decoration: none;
+ color: #1364c4;
+}
+a:visited, a:active {
+ text-decoration: none;
+ color: #03697a;
+}
+a:hover {
+ text-decoration: none;
+ color: #3390b1;
+}
+img {
+ border: 0;
+}
+p {
+ margin-top: 0;
+ margin-bottom: 0;
+ padding-bottom: 15px;
+ line-height: 18px;
+}
+q {
+ font-style: italic;
+}
+blockquote {
+ margin-top: 0px;
+}
+table {
+ border-collapse: collapse;
+ padding: 0;
+ margin-bottom: 15px;
+ font-size: 15px;
+ width: 100%;
+}
+td, th {
+ border-bottom: 1px solid #dbdbdb;
+ margin: 10px;
+ padding-top: 10px;
+ padding-bottom: 10px;
+ padding-right: 8px;
+ padding-left: 8px;
+}
+th {
+ background-color: #ededed;
+ color: #636363;
+ text-align: left;
+ padding-top: 5px;
+ padding-bottom: 5px;
+}
+td {
+ color: #2a2a2a;
+ vertical-align: top;
+}
+table p:last-child {
+ padding-bottom: 0;
+}
+table.members {
+ width: 100%;
+}
+table.members td {
+ min-width: 72px;
+}
+table.members img {
+ padding-right: 5px;
+}
+div.alert img {
+ padding-right: 5px;
+}
+ol {
+ margin-top: 0px;
+ margin-bottom: 10px;
+}
+ol ol {
+ list-style-type: lower-alpha;
+}
+ol ol ol {
+ list-style-type: lower-roman;
+}
+ul {
+ margin-top: 0px;
+ margin-bottom: 10px;
+}
+.noBullet {
+ list-style-type: none;
+ padding-left: 20px;
+}
+ul ul {
+ list-style-type: circle;
+}
+ul ul ul {
+ list-style-type: square;
+}
+dt {
+ font-weight: 600;
+}
+pre {
+ font-family: Consolas, Courier, monospace;
+ overflow: hidden;
+}
+.pageHeader {
+ font-family: 'Segoe UI' , Tahoma, Helvetica, Sans-Serif;
+ background-color: #333333;
+ color: #d0d0d0;
+ padding: 5px 10px;
+ vertical-align: middle;
+ height: 25px;
+}
+.pageBody {
+ padding: 0px;
+}
+.topicContent {
+ padding: 10px 10px 15px 10px;
+ overflow: visible;
+ border-left: 1px solid #bbb;
+}
+.pageFooter {
+ clear: both;
+ border-top: solid 1px #bbb;
+ padding: 10px;
+}
+.feedbackLink {
+}
+.iconColumn {
+ width: 100px;
+}
+.seeAlsoStyle {
+}
+table.titleTable td {
+ padding-top: 0px;
+ border-width: 0px;
+}
+td.titleColumn {
+ font-family: 'Segoe UI' , 'Lucida Grande' , Verdana, Arial, Helvetica, sans-serif;
+ font-size: 2.5em;
+ font-weight: normal;
+ margin-top: 0px;
+ padding-left: 0px;
+ color: #000;
+ vertical-align: middle;
+}
+td.logoColumn {
+ padding-left: 0px;
+ padding-right: 10px;
+ vertical-align: middle;
+ width: 1px;
+}
+td.logoColumnAbove {
+ padding: 0px 10px 0px 0px;
+ vertical-align: middle;
+}
+span.selflink {
+ color: #000066;
+}
+div.preliminary {
+ margin-top: 1em;
+ margin-bottom: 1em;
+ font-weight: bold;
+ color: #333333;
+}
+div.caption {
+ font-weight: bold;
+ font-size: 1em; /*12pt*/
+ color: #003399;
+ padding-top: 5px;
+ padding-bottom: 5px;
+}
+.procedureSubHeading {
+ font-size: 1.1em; /*13.5pt*/
+ font-weight: bold;
+}
+.summary {
+}
+
+/* Collapsible region styles */
+.collapsibleAreaRegion {
+ margin-top: 15px;
+ margin-bottom: 15px;
+}
+.collapseToggle {
+ padding-right: 5px;
+}
+.collapsibleRegionTitle {
+ font-family: 'Segoe UI Semibold' , 'Segoe UI' , 'Lucida Grande' , Verdana, Arial, Helvetica, sans-serif !important;
+ font-style: normal !important;
+ font-size: 1.769em;
+ margin-top: 9px;
+ margin-bottom: 19px;
+ padding-top: 20px;
+ padding-bottom: 5px;
+ cursor: pointer;
+}
+.collapsibleSection {
+ padding: 0 0 0 20px;
+}
+
+/* Syntax and code snippet styles */
+.codeSnippetContainer {
+ min-width: 260px;
+ margin-top: 10px;
+}
+.codeSnippetContainerTabs {
+ height: 23px;
+ vertical-align: middle;
+ position: relative;
+ z-index: 1;
+}
+.codeSnippetContainerTab {
+ padding: 0px 15px;
+ width: auto;
+ height: 22px;
+ color: #2a2a2a;
+ font-family: "Segoe UI" , "Lucida Grande" , Verdana, Arial, Helvetica, sans-serif !important;
+ font-size: 12px;
+ font-style: normal !important;
+ vertical-align: baseline;
+ float: left;
+}
+.codeSnippetContainerTabActive {
+ background: #f8f8f8;
+ padding: 0px 15px;
+ width: auto;
+ height: 22px;
+ color: #000000;
+ font-family: "Segoe UI" , "Lucida Grande" , Verdana, Arial, Helvetica, sans-serif !important;
+ font-size: 12px;
+ font-style: normal !important;
+ vertical-align: baseline;
+ border-top-color: #939393;
+ border-right-color: #939393;
+ border-left-color: #939393;
+ border-top-width: 1px;
+ border-right-width: 1px;
+ border-left-width: 1px;
+ border-top-style: solid;
+ border-right-style: solid;
+ border-left-style: solid;
+ float: left;
+}
+.codeSnippetContainerTabPhantom {
+ background: #f8f8f8;
+ padding: 0px 15px;
+ width: auto;
+ height: 22px;
+ color: #000000;
+ font-family: "Segoe UI" , "Lucida Grande" , Verdana, Arial, Helvetica, sans-serif !important;
+ font-size: 12px;
+ font-style: normal !important;
+ vertical-align: baseline;
+ border-top-color: #939393;
+ border-right-color: #939393;
+ border-left-color: #939393;
+ border-top-width: 1px;
+ border-right-width: 1px;
+ border-left-width: 1px;
+ border-top-style: solid;
+ border-right-style: solid;
+ border-left-style: solid;
+ float: left;
+ display: none;
+}
+.codeSnippetContainerTabSingle {
+ background: #f8f8f8;
+ padding: 2px 15px 0px 15px;
+ width: auto;
+ height: 20px;
+ color: #000000;
+ font-family: "Segoe UI" , "Lucida Grande" , Verdana, Arial, Helvetica, sans-serif !important;
+ font-size: 12px;
+ font-weight: bold;
+ font-style: normal !important;
+ vertical-align: baseline;
+ border-top-color: #939393;
+ border-right-color: #939393;
+ border-left-color: #939393;
+ border-top-width: 1px;
+ border-right-width: 1px;
+ border-left-width: 1px;
+ border-top-style: solid;
+ border-right-style: solid;
+ border-left-style: solid;
+ float: left;
+}
+.codeSnippetContainerTab a {
+ top: 2px;
+ color: #000000;
+ font-weight: bold;
+ text-decoration: none;
+ position: relative;
+}
+.codeSnippetContainerTab a:link {
+ color: #000000;
+}
+.codeSnippetContainerTab a:hover {
+ color: #136460;
+}
+.codeSnippetContainerTabActive a {
+ top: 2px;
+ color: #000000;
+ font-weight: bold;
+ text-decoration: none;
+ position: relative;
+ cursor: default;
+}
+.codeSnippetContainerTabActive a:link {
+ color: #000000;
+}
+.codeSnippetContainerTabActive a:hover {
+ color: #000000;
+}
+.codeSnippetContainerTabPhantom a {
+ top: 2px;
+ color: #000000;
+ font-weight: bold;
+ text-decoration: none;
+ position: relative;
+ cursor: default;
+}
+.codeSnippetContainerTabPhantom a:link {
+ color: #000000;
+}
+.codeSnippetContainerCodeContainer {
+ border: 1px solid #939393;
+ top: -1px;
+ margin-bottom: 12px;
+ position: relative;
+}
+.codeSnippetToolBar {
+ width: auto;
+ height: auto;
+}
+.codeSnippetToolBarText {
+ top: -8px;
+ width: auto;
+ height: 0px;
+ padding-right: 0px;
+ padding-left: 0px;
+ vertical-align: top;
+ float: right;
+ position: relative;
+}
+.codeSnippetToolBarText a {
+ color: #1364c4;
+ text-decoration: none;
+ padding-left: 8px;
+ padding-right: 8px;
+ font-family: "Segoe UI" , "Lucida Grande" , Verdana, Arial, Helvetica, sans-serif !important;
+ font-size: 10px;
+ font-style: normal !important;
+ text-decoration: none;
+ margin-right: 10px;
+ margin-left: 0px;
+ background-color: #ffffff;
+}
+.codeSnippetToolBarText a:link {
+ color: #1364c4;
+}
+.codeSnippetContainerCode {
+ margin: 0px;
+ padding: 10px;
+ width: auto;
+}
+.codeSnippetContainerCode div {
+ margin: 0px;
+ padding: 0px;
+}
+.codeSnippetContainerCode pre {
+ margin: 0px;
+ padding: 5px;
+ overflow: auto;
+ font-family: Consolas, Courier, monospace !important;
+ font-style: normal;
+ font-weight: normal;
+ -ms-word-wrap: normal;
+}
+.codeSnippetContainerCode .keyword {
+ color: #0000ff;
+ font-weight: normal;
+}
+
+/* Keyword and phrase styles */
+span.code, span.command {
+ font-family: Consolas, Courier, monospace;
+ color: #000066;
+}
+span.ui {
+ font-weight: bold;
+}
+span.math {
+ font-style: italic;
+}
+span.input {
+ font-weight: bold;
+}
+span.term {
+ font-style: italic;
+}
+span.label {
+ font-weight: bold;
+}
+span.foreignPhrase, span.phrase {
+ font-style: italic;
+}
+span.placeholder {
+ font-style: italic;
+}
+span.typeparameter {
+ font-style: italic;
+}
+span.identifier {
+}
+span.keyword {
+ font-weight: bold;
+}
+span.parameter {
+ font-style: italic;
+}
+dt span.parameter {
+ font-weight: normal;
+}
+span.literal, span.literalValue {
+ color: #cc0000;
+}
+span.comment {
+ color: #006633;
+}
+span.introStyle {
+ color: #a9a9a9;
+}
+span.nolink {
+ font-weight: bold;
+}
+
+/* Auto-outline styles */
+ul.autoOutline {
+}
+li.outlineSectionEntry {
+}
+div.outlineSectionEntrySummary {
+}
+
+/* Media styles */
+div.mediaNear {
+ text-align: left;
+ margin-top: 1em;
+ margin-bottom: 1em;
+}
+div.mediaFar {
+ text-align: right;
+ margin-top: 1em;
+ margin-bottom: 1em;
+}
+div.mediaCenter {
+ text-align: center;
+ margin-top: 1em;
+ margin-bottom: 1em;
+}
+span.captionLead {
+ font-weight: bold;
+ margin-right: .5em;
+}
+span.media img {
+ vertical-align: top;
+}
+
+/* Glossary styles */
+div.glossaryDiv {
+}
+div.glossaryLetterBar {
+}
+hr.glossaryRule {
+}
+h3.glossaryGroupHeading {
+ color: #808080;
+}
+div.glossaryGroup {
+}
+dl.glossaryGroupList {
+ margin: 0;
+ color: Black;
+}
+dt.glossaryEntry {
+ margin-left: 2em;
+}
+dd.glossaryEntry {
+ margin-left: 2em;
+ margin-bottom: 2em;
+}
+div.relatedEntry {
+ margin-bottom: 4px;
+}
+
+/* Bibliography styles */
+div.bibliographStyle {
+ padding-top: 5px;
+}
+span.bibliographyNumber {
+}
+span.bibliographyAuthor {
+ font-weight: bold;
+}
+span.bibliographyTitle {
+ font-style: italic;
+}
+span.bibliographyPublisher {
+}
+sup.citation a:link a:visited a:active {
+ text-decoration: none;
+}
+
+/* Placeholder for the Help 1 user data style class */
+.userDataStyle {
+}
diff --git a/doc/ref/csharp/html/toc/Fields_T_Grpc_Core_ChannelOptions.xml b/doc/ref/csharp/html/toc/Fields_T_Grpc_Core_ChannelOptions.xml
new file mode 100644
index 00000000000..3270d758a1d
--- /dev/null
+++ b/doc/ref/csharp/html/toc/Fields_T_Grpc_Core_ChannelOptions.xml
@@ -0,0 +1 @@
+