mirror of https://github.com/grpc/grpc.git
Conflicts: include/grpc++/async_unary_call.h include/grpc++/config.h include/grpc++/config_protobuf.h include/grpc++/impl/service_type.h include/grpc++/stream.h src/cpp/common/call.ccpull/1969/head
Craig Tiller
10 years ago
commit
2622ddbcfd
199 changed files with 4680 additions and 1340 deletions
@ -0,0 +1,147 @@ |
||||
gRPC Connectivity Semantics and API |
||||
=================================== |
||||
|
||||
This document describes the connectivity semantics for gRPC channels and the |
||||
corresponding impact on RPCs. We then discuss an API. |
||||
|
||||
States of Connectivity |
||||
---------------------- |
||||
|
||||
gRPC Channels provide the abstraction over which clients can communicate with |
||||
servers.The client-side channel object can be constructed using little more |
||||
than a DNS name. Channels encapsulate a range of functionality including name |
||||
resolution, establishing a TCP connection (with retries and backoff) and TLS |
||||
handshakes. Channels can also handle errors on established connections and |
||||
reconnect, or in the case of HTTP/2 GO_AWAY, re-resolve the name and reconnect. |
||||
|
||||
To hide the details of all this activity from the user of the gRPC API (i.e., |
||||
application code) while exposing meaningful information about the state of a |
||||
channel, we use a state machine with four states, defined below: |
||||
|
||||
CONNECTING: The channel is trying to establish a connection and is waiting to |
||||
make progress on one of the steps involved in name resolution, TCP connection |
||||
establishment or TLS handshake. This may be used as the initial state for channels upon |
||||
creation. |
||||
|
||||
READY: The channel has successfully established a connection all the way |
||||
through TLS handshake (or equivalent) and all subsequent attempt to communicate |
||||
have succeeded (or are pending without any known failure ). |
||||
|
||||
TRANSIENT_FAILURE: There has been some transient failure (such as a TCP 3-way |
||||
handshake timing out or a socket error). Channels in this state will eventually |
||||
switch to the CONNECTING state and try to establish a connection again. Since |
||||
retries are done with exponential backoff, channels that fail to connect will |
||||
start out spending very little time in this state but as the attempts fail |
||||
repeatedly, the channel will spend increasingly large amounts of time in this |
||||
state. For many non-fatal failures (e.g., TCP connection attempts timing out |
||||
because the server is not yet available), the channel may spend increasingly |
||||
large amounts of time in this state. |
||||
|
||||
IDLE: This is the state where the channel is not even trying to create a |
||||
connection because of a lack of new or pending RPCs. New channels MAY be created |
||||
in this state. Any attempt to start an RPC on the channel will push the channel |
||||
out of this state to connecting. When there has been no RPC activity on a channel |
||||
for a specified IDLE_TIMEOUT, i.e., no new or pending (active) RPCs for this |
||||
period, channels that are READY or CONNECTING switch to IDLE. Additionaly, |
||||
channels that receive a GOAWAY when there are no active or pending RPCs should |
||||
also switch to IDLE to avoid connection overload at servers that are attempting |
||||
to shed connections. We will use a default IDLE_TIMEOUT of 300 seconds (5 minutes). |
||||
|
||||
SHUTDOWN: This channel has started shutting down. Any new RPCs should fail |
||||
immediately. Pending RPCs may continue running till the application cancels them. |
||||
Channels may enter this state either because the application explicitly requested |
||||
a shutdown or if a non-recoverable error has happened during attempts to connect |
||||
communicate . (As of 6/12/2015, there are no known errors (while connecting or |
||||
communicating) that are classified as non-recoverable) |
||||
Channels that enter this state never leave this state. |
||||
|
||||
The following table lists the legal transitions from one state to another and |
||||
corresponding reasons. Empty cells denote disallowed transitions. |
||||
|
||||
<table style='border: 1px solid black'> |
||||
<tr> |
||||
<th>From/To</th> |
||||
<th>CONNECTING</th> |
||||
<th>READY</th> |
||||
<th>TRANSIENT_FAILURE</th> |
||||
<th>IDLE</th> |
||||
<th>SHUTDOWN</th> |
||||
</tr> |
||||
<tr> |
||||
<th>CONNECTING</th> |
||||
<td>Incremental progress during connection establishment</td> |
||||
<td>All steps needed to establish a connection succeeded</td> |
||||
<td>Any failure in any of the steps needed to establish connection</td> |
||||
<td>No RPC activity on channel for IDLE_TIMEOUT</td> |
||||
<td>Shutdown triggered by application.</td> |
||||
</tr> |
||||
<tr> |
||||
<th>READY</th> |
||||
<td></td> |
||||
<td>Incremental successful communication on established channel.</td> |
||||
<td>Any failure encountered while expecting successful communication on |
||||
established channel.</td> |
||||
<td>No RPC activity on channel for IDLE_TIMEOUT <br>OR<br>upon receiving a GOAWAY while there are no pending RPCs.</td> |
||||
<td>Shutdown triggered by application.</td> |
||||
</tr> |
||||
<tr> |
||||
<th>TRANSIENT_FAILURE</th> |
||||
<td>Wait time required to implement (exponential) backoff is over.</td> |
||||
<td></td> |
||||
<td></td> |
||||
<td></td> |
||||
<td>Shutdown triggered by application.</td> |
||||
</tr> |
||||
<tr> |
||||
<th>IDLE</th> |
||||
<td>Any new RPC activity on the channel</td> |
||||
<td></td> |
||||
<td></td> |
||||
<td></td> |
||||
<td>Shutdown triggered by application.</td> |
||||
</tr> |
||||
<tr> |
||||
<th>FATAL_FAILURE</th> |
||||
<td></td> |
||||
<td></td> |
||||
<td></td> |
||||
<td></td> |
||||
<td></td> |
||||
</tr> |
||||
</table> |
||||
|
||||
|
||||
Channel State API |
||||
----------------- |
||||
|
||||
All gRPC libraries will expose a channel-level API method to poll the current |
||||
state of a channel. In C++, this method is called GetCurrentState and returns |
||||
an enum for one of the four legal states. |
||||
|
||||
All libraries should also expose an API that enables the application (user of |
||||
the gRPC API) to be notified when the channel state changes. Since state |
||||
changes can be rapid and race with any such notification, the notification |
||||
should just inform the user that some state change has happened, leaving it to |
||||
the user to poll the channel for the current state. |
||||
|
||||
The synchronous version of this API is: |
||||
|
||||
```cpp |
||||
bool WaitForStateChange(gpr_timespec deadline, ChannelState source_state); |
||||
``` |
||||
|
||||
which returns true when the state changes to something other than the |
||||
source_state and false if the deadline expires. Asynchronous and futures based |
||||
APIs should have a corresponding method that allows the application to be |
||||
notified when the state of a channel changes. |
||||
|
||||
Note that a notification is delivered every time there is a transition from any |
||||
state to any *other* state. On the other hand the rules for legal state |
||||
transition, require a transition from CONNECTING to TRANSIENT_FAILURE and back |
||||
to CONNECTING for every recoverable failure, even if the corresponding |
||||
exponential backoff requires no wait before retry. The combined effect is that |
||||
the application may receive state change notifications that appear spurious. |
||||
e.g., an application waiting for state changes on a channel that is CONNECTING |
||||
may receive a state change notification but find the channel in the same |
||||
CONNECTING state on polling for current state because the channel may have |
||||
spent infinitesimally small amount of time in the TRANSIENT_FAILURE state. |
||||
@ -0,0 +1,105 @@ |
||||
#region Copyright notice and license |
||||
|
||||
// Copyright 2015, Google Inc. |
||||
// All rights reserved. |
||||
// |
||||
// Redistribution and use in source and binary forms, with or without |
||||
// modification, are permitted provided that the following conditions are |
||||
// met: |
||||
// |
||||
// * Redistributions of source code must retain the above copyright |
||||
// notice, this list of conditions and the following disclaimer. |
||||
// * Redistributions in binary form must reproduce the above |
||||
// copyright notice, this list of conditions and the following disclaimer |
||||
// in the documentation and/or other materials provided with the |
||||
// distribution. |
||||
// * Neither the name of Google Inc. nor the names of its |
||||
// contributors may be used to endorse or promote products derived from |
||||
// this software without specific prior written permission. |
||||
// |
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
|
||||
#endregion |
||||
|
||||
using System; |
||||
using System.Collections.Generic; |
||||
using Grpc.Core; |
||||
using Grpc.Core.Internal; |
||||
using Grpc.Core.Utils; |
||||
using NUnit.Framework; |
||||
|
||||
namespace Grpc.Core.Internal.Tests |
||||
{ |
||||
public class ChannelOptionsTest |
||||
{ |
||||
[Test] |
||||
public void IntOption() |
||||
{ |
||||
var option = new ChannelOption("somename", 1); |
||||
|
||||
Assert.AreEqual(ChannelOption.OptionType.Integer, option.Type); |
||||
Assert.AreEqual("somename", option.Name); |
||||
Assert.AreEqual(1, option.IntValue); |
||||
Assert.Throws(typeof(InvalidOperationException), () => { var s = option.StringValue; }); |
||||
} |
||||
|
||||
[Test] |
||||
public void StringOption() |
||||
{ |
||||
var option = new ChannelOption("somename", "ABCDEF"); |
||||
|
||||
Assert.AreEqual(ChannelOption.OptionType.String, option.Type); |
||||
Assert.AreEqual("somename", option.Name); |
||||
Assert.AreEqual("ABCDEF", option.StringValue); |
||||
Assert.Throws(typeof(InvalidOperationException), () => { var s = option.IntValue; }); |
||||
} |
||||
|
||||
[Test] |
||||
public void ConstructorPreconditions() |
||||
{ |
||||
Assert.Throws(typeof(NullReferenceException), () => { new ChannelOption(null, "abc"); }); |
||||
Assert.Throws(typeof(NullReferenceException), () => { new ChannelOption(null, 1); }); |
||||
Assert.Throws(typeof(NullReferenceException), () => { new ChannelOption("abc", null); }); |
||||
} |
||||
|
||||
[Test] |
||||
public void CreateChannelArgsNull() |
||||
{ |
||||
var channelArgs = ChannelOptions.CreateChannelArgs(null); |
||||
Assert.IsTrue(channelArgs.IsInvalid); |
||||
} |
||||
|
||||
[Test] |
||||
public void CreateChannelArgsEmpty() |
||||
{ |
||||
var options = new List<ChannelOption>(); |
||||
var channelArgs = ChannelOptions.CreateChannelArgs(options); |
||||
channelArgs.Dispose(); |
||||
} |
||||
|
||||
[Test] |
||||
public void CreateChannelArgs() |
||||
{ |
||||
var options = new List<ChannelOption> |
||||
{ |
||||
new ChannelOption("ABC", "XYZ"), |
||||
new ChannelOption("somename", "IJKLM"), |
||||
new ChannelOption("intoption", 12345), |
||||
new ChannelOption("GHIJK", 12345), |
||||
}; |
||||
|
||||
var channelArgs = ChannelOptions.CreateChannelArgs(options); |
||||
channelArgs.Dispose(); |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,75 @@ |
||||
#region Copyright notice and license |
||||
|
||||
// Copyright 2015, Google Inc. |
||||
// All rights reserved. |
||||
// |
||||
// Redistribution and use in source and binary forms, with or without |
||||
// modification, are permitted provided that the following conditions are |
||||
// met: |
||||
// |
||||
// * Redistributions of source code must retain the above copyright |
||||
// notice, this list of conditions and the following disclaimer. |
||||
// * Redistributions in binary form must reproduce the above |
||||
// copyright notice, this list of conditions and the following disclaimer |
||||
// in the documentation and/or other materials provided with the |
||||
// distribution. |
||||
// * Neither the name of Google Inc. nor the names of its |
||||
// contributors may be used to endorse or promote products derived from |
||||
// this software without specific prior written permission. |
||||
// |
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
|
||||
#endregion |
||||
|
||||
using System; |
||||
using Grpc.Core; |
||||
using Grpc.Core.Internal; |
||||
using Grpc.Core.Utils; |
||||
using NUnit.Framework; |
||||
|
||||
namespace Grpc.Core.Internal.Tests |
||||
{ |
||||
public class ChannelArgsSafeHandleTest |
||||
{ |
||||
[Test] |
||||
public void CreateEmptyAndDestroy() |
||||
{ |
||||
var channelArgs = ChannelArgsSafeHandle.Create(0); |
||||
channelArgs.Dispose(); |
||||
} |
||||
|
||||
[Test] |
||||
public void CreateNonEmptyAndDestroy() |
||||
{ |
||||
var channelArgs = ChannelArgsSafeHandle.Create(5); |
||||
channelArgs.Dispose(); |
||||
} |
||||
|
||||
[Test] |
||||
public void CreateNullAndDestroy() |
||||
{ |
||||
var channelArgs = ChannelArgsSafeHandle.CreateNull(); |
||||
channelArgs.Dispose(); |
||||
} |
||||
|
||||
[Test] |
||||
public void CreateFillAndDestroy() |
||||
{ |
||||
var channelArgs = ChannelArgsSafeHandle.Create(3); |
||||
channelArgs.SetInteger(0, "somekey", 12345); |
||||
channelArgs.SetString(1, "somekey", "abcdefghijkl"); |
||||
channelArgs.SetString(2, "somekey", "XYZ"); |
||||
channelArgs.Dispose(); |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,52 @@ |
||||
#region Copyright notice and license |
||||
|
||||
// Copyright 2015, Google Inc. |
||||
// All rights reserved. |
||||
// |
||||
// Redistribution and use in source and binary forms, with or without |
||||
// modification, are permitted provided that the following conditions are |
||||
// met: |
||||
// |
||||
// * Redistributions of source code must retain the above copyright |
||||
// notice, this list of conditions and the following disclaimer. |
||||
// * Redistributions in binary form must reproduce the above |
||||
// copyright notice, this list of conditions and the following disclaimer |
||||
// in the documentation and/or other materials provided with the |
||||
// distribution. |
||||
// * Neither the name of Google Inc. nor the names of its |
||||
// contributors may be used to endorse or promote products derived from |
||||
// this software without specific prior written permission. |
||||
// |
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
|
||||
#endregion |
||||
|
||||
using System; |
||||
using System.Runtime.InteropServices; |
||||
using System.Threading.Tasks; |
||||
using Grpc.Core; |
||||
using Grpc.Core.Internal; |
||||
using Grpc.Core.Utils; |
||||
using NUnit.Framework; |
||||
|
||||
namespace Grpc.Core.Internal.Tests |
||||
{ |
||||
public class CompletionQueueEventTest |
||||
{ |
||||
[Test] |
||||
public void CreateAndDestroy() |
||||
{ |
||||
Assert.AreEqual(CompletionQueueEvent.NativeSize, Marshal.SizeOf(typeof(CompletionQueueEvent))); |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,64 @@ |
||||
#region Copyright notice and license |
||||
|
||||
// Copyright 2015, Google Inc. |
||||
// All rights reserved. |
||||
// |
||||
// Redistribution and use in source and binary forms, with or without |
||||
// modification, are permitted provided that the following conditions are |
||||
// met: |
||||
// |
||||
// * Redistributions of source code must retain the above copyright |
||||
// notice, this list of conditions and the following disclaimer. |
||||
// * Redistributions in binary form must reproduce the above |
||||
// copyright notice, this list of conditions and the following disclaimer |
||||
// in the documentation and/or other materials provided with the |
||||
// distribution. |
||||
// * Neither the name of Google Inc. nor the names of its |
||||
// contributors may be used to endorse or promote products derived from |
||||
// this software without specific prior written permission. |
||||
// |
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
|
||||
#endregion |
||||
|
||||
using System; |
||||
using System.Threading.Tasks; |
||||
using Grpc.Core; |
||||
using Grpc.Core.Internal; |
||||
using Grpc.Core.Utils; |
||||
using NUnit.Framework; |
||||
|
||||
namespace Grpc.Core.Internal.Tests |
||||
{ |
||||
public class CompletionQueueSafeHandleTest |
||||
{ |
||||
[Test] |
||||
public void CreateAndDestroy() |
||||
{ |
||||
var cq = CompletionQueueSafeHandle.Create(); |
||||
cq.Dispose(); |
||||
} |
||||
|
||||
[Test] |
||||
public void CreateAndShutdown() |
||||
{ |
||||
var cq = CompletionQueueSafeHandle.Create(); |
||||
cq.Shutdown(); |
||||
var ev = cq.Next(); |
||||
cq.Dispose(); |
||||
Assert.AreEqual(GRPCCompletionType.Shutdown, ev.type); |
||||
Assert.AreNotEqual(IntPtr.Zero, ev.success); |
||||
Assert.AreEqual(IntPtr.Zero, ev.tag); |
||||
} |
||||
} |
||||
} |
||||
@ -1,115 +0,0 @@ |
||||
#region Copyright notice and license |
||||
// Copyright 2015, Google Inc. |
||||
// All rights reserved. |
||||
// |
||||
// Redistribution and use in source and binary forms, with or without |
||||
// modification, are permitted provided that the following conditions are |
||||
// met: |
||||
// |
||||
// * Redistributions of source code must retain the above copyright |
||||
// notice, this list of conditions and the following disclaimer. |
||||
// * Redistributions in binary form must reproduce the above |
||||
// copyright notice, this list of conditions and the following disclaimer |
||||
// in the documentation and/or other materials provided with the |
||||
// distribution. |
||||
// * Neither the name of Google Inc. nor the names of its |
||||
// contributors may be used to endorse or promote products derived from |
||||
// this software without specific prior written permission. |
||||
// |
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
#endregion |
||||
using System; |
||||
using System.Collections.Generic; |
||||
using System.Collections.Immutable; |
||||
using System.Runtime.InteropServices; |
||||
using System.Threading; |
||||
using System.Threading.Tasks; |
||||
using Grpc.Core.Internal; |
||||
|
||||
namespace Grpc.Core |
||||
{ |
||||
/// <summary> |
||||
/// gRPC channel options. |
||||
/// </summary> |
||||
public class ChannelArgs |
||||
{ |
||||
public const string SslTargetNameOverrideKey = "grpc.ssl_target_name_override"; |
||||
|
||||
readonly ImmutableDictionary<string, string> stringArgs; |
||||
|
||||
private ChannelArgs(ImmutableDictionary<string, string> stringArgs) |
||||
{ |
||||
this.stringArgs = stringArgs; |
||||
} |
||||
|
||||
public string GetSslTargetNameOverride() |
||||
{ |
||||
string result; |
||||
if (stringArgs.TryGetValue(SslTargetNameOverrideKey, out result)) |
||||
{ |
||||
return result; |
||||
} |
||||
return null; |
||||
} |
||||
|
||||
public static Builder CreateBuilder() |
||||
{ |
||||
return new Builder(); |
||||
} |
||||
|
||||
public class Builder |
||||
{ |
||||
readonly Dictionary<string, string> stringArgs = new Dictionary<string, string>(); |
||||
|
||||
// TODO: AddInteger not supported yet. |
||||
public Builder AddString(string key, string value) |
||||
{ |
||||
stringArgs.Add(key, value); |
||||
return this; |
||||
} |
||||
|
||||
public ChannelArgs Build() |
||||
{ |
||||
return new ChannelArgs(stringArgs.ToImmutableDictionary()); |
||||
} |
||||
} |
||||
|
||||
/// <summary> |
||||
/// Creates native object for the channel arguments. |
||||
/// </summary> |
||||
/// <returns>The native channel arguments.</returns> |
||||
internal ChannelArgsSafeHandle ToNativeChannelArgs() |
||||
{ |
||||
ChannelArgsSafeHandle nativeArgs = null; |
||||
try |
||||
{ |
||||
nativeArgs = ChannelArgsSafeHandle.Create(stringArgs.Count); |
||||
int i = 0; |
||||
foreach (var entry in stringArgs) |
||||
{ |
||||
nativeArgs.SetString(i, entry.Key, entry.Value); |
||||
i++; |
||||
} |
||||
return nativeArgs; |
||||
} |
||||
catch (Exception) |
||||
{ |
||||
if (nativeArgs != null) |
||||
{ |
||||
nativeArgs.Dispose(); |
||||
} |
||||
throw; |
||||
} |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,178 @@ |
||||
#region Copyright notice and license |
||||
// Copyright 2015, Google Inc. |
||||
// All rights reserved. |
||||
// |
||||
// Redistribution and use in source and binary forms, with or without |
||||
// modification, are permitted provided that the following conditions are |
||||
// met: |
||||
// |
||||
// * Redistributions of source code must retain the above copyright |
||||
// notice, this list of conditions and the following disclaimer. |
||||
// * Redistributions in binary form must reproduce the above |
||||
// copyright notice, this list of conditions and the following disclaimer |
||||
// in the documentation and/or other materials provided with the |
||||
// distribution. |
||||
// * Neither the name of Google Inc. nor the names of its |
||||
// contributors may be used to endorse or promote products derived from |
||||
// this software without specific prior written permission. |
||||
// |
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
#endregion |
||||
using System; |
||||
using System.Collections.Generic; |
||||
using System.Collections.Immutable; |
||||
using System.Runtime.InteropServices; |
||||
using System.Threading; |
||||
using System.Threading.Tasks; |
||||
using Grpc.Core.Internal; |
||||
using Grpc.Core.Utils; |
||||
|
||||
namespace Grpc.Core |
||||
{ |
||||
/// <summary> |
||||
/// Channel option specified when creating a channel. |
||||
/// Corresponds to grpc_channel_args from grpc/grpc.h. |
||||
/// </summary> |
||||
public sealed class ChannelOption |
||||
{ |
||||
public enum OptionType |
||||
{ |
||||
Integer, |
||||
String |
||||
} |
||||
|
||||
private readonly OptionType type; |
||||
private readonly string name; |
||||
private readonly int intValue; |
||||
private readonly string stringValue; |
||||
|
||||
/// <summary> |
||||
/// Creates a channel option with a string value. |
||||
/// </summary> |
||||
/// <param name="name">Name.</param> |
||||
/// <param name="stringValue">String value.</param> |
||||
public ChannelOption(string name, string stringValue) |
||||
{ |
||||
this.type = OptionType.String; |
||||
this.name = Preconditions.CheckNotNull(name); |
||||
this.stringValue = Preconditions.CheckNotNull(stringValue); |
||||
} |
||||
|
||||
/// <summary> |
||||
/// Creates a channel option with an integer value. |
||||
/// </summary> |
||||
/// <param name="name">Name.</param> |
||||
/// <param name="stringValue">String value.</param> |
||||
public ChannelOption(string name, int intValue) |
||||
{ |
||||
this.type = OptionType.Integer; |
||||
this.name = Preconditions.CheckNotNull(name); |
||||
this.intValue = intValue; |
||||
} |
||||
|
||||
public OptionType Type |
||||
{ |
||||
get |
||||
{ |
||||
return type; |
||||
} |
||||
} |
||||
|
||||
public string Name |
||||
{ |
||||
get |
||||
{ |
||||
return name; |
||||
} |
||||
} |
||||
|
||||
public int IntValue |
||||
{ |
||||
get |
||||
{ |
||||
Preconditions.CheckState(type == OptionType.Integer); |
||||
return intValue; |
||||
} |
||||
} |
||||
|
||||
public string StringValue |
||||
{ |
||||
get |
||||
{ |
||||
Preconditions.CheckState(type == OptionType.String); |
||||
return stringValue; |
||||
} |
||||
} |
||||
} |
||||
|
||||
public static class ChannelOptions |
||||
{ |
||||
// Override SSL target check. Only to be used for testing. |
||||
public const string SslTargetNameOverride = "grpc.ssl_target_name_override"; |
||||
|
||||
// Enable census for tracing and stats collection |
||||
public const string Census = "grpc.census"; |
||||
|
||||
// Maximum number of concurrent incoming streams to allow on a http2 connection |
||||
public const string MaxConcurrentStreams = "grpc.max_concurrent_streams"; |
||||
|
||||
// Maximum message length that the channel can receive |
||||
public const string MaxMessageLength = "grpc.max_message_length"; |
||||
|
||||
// Initial sequence number for http2 transports |
||||
public const string Http2InitialSequenceNumber = "grpc.http2.initial_sequence_number"; |
||||
|
||||
/// <summary> |
||||
/// Creates native object for a collection of channel options. |
||||
/// </summary> |
||||
/// <returns>The native channel arguments.</returns> |
||||
internal static ChannelArgsSafeHandle CreateChannelArgs(IEnumerable<ChannelOption> options) |
||||
{ |
||||
if (options == null) |
||||
{ |
||||
return ChannelArgsSafeHandle.CreateNull(); |
||||
} |
||||
var optionList = new List<ChannelOption>(options); // It's better to do defensive copy |
||||
ChannelArgsSafeHandle nativeArgs = null; |
||||
try |
||||
{ |
||||
nativeArgs = ChannelArgsSafeHandle.Create(optionList.Count); |
||||
for (int i = 0; i < optionList.Count; i++) |
||||
{ |
||||
var option = optionList[i]; |
||||
if (option.Type == ChannelOption.OptionType.Integer) |
||||
{ |
||||
nativeArgs.SetInteger(i, option.Name, option.IntValue); |
||||
} |
||||
else if (option.Type == ChannelOption.OptionType.String) |
||||
{ |
||||
nativeArgs.SetString(i, option.Name, option.StringValue); |
||||
} |
||||
else |
||||
{ |
||||
throw new InvalidOperationException("Unknown option type"); |
||||
} |
||||
} |
||||
return nativeArgs; |
||||
} |
||||
catch (Exception) |
||||
{ |
||||
if (nativeArgs != null) |
||||
{ |
||||
nativeArgs.Dispose(); |
||||
} |
||||
throw; |
||||
} |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,60 @@ |
||||
#region Copyright notice and license |
||||
|
||||
// Copyright 2015, Google Inc. |
||||
// All rights reserved. |
||||
// |
||||
// Redistribution and use in source and binary forms, with or without |
||||
// modification, are permitted provided that the following conditions are |
||||
// met: |
||||
// |
||||
// * Redistributions of source code must retain the above copyright |
||||
// notice, this list of conditions and the following disclaimer. |
||||
// * Redistributions in binary form must reproduce the above |
||||
// copyright notice, this list of conditions and the following disclaimer |
||||
// in the documentation and/or other materials provided with the |
||||
// distribution. |
||||
// * Neither the name of Google Inc. nor the names of its |
||||
// contributors may be used to endorse or promote products derived from |
||||
// this software without specific prior written permission. |
||||
// |
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
|
||||
#endregion |
||||
|
||||
using System; |
||||
using System.Runtime.InteropServices; |
||||
|
||||
namespace Grpc.Core.Internal |
||||
{ |
||||
/// <summary> |
||||
/// grpc_event from grpc/grpc.h |
||||
/// </summary> |
||||
[StructLayout(LayoutKind.Sequential)] |
||||
internal struct CompletionQueueEvent |
||||
{ |
||||
[DllImport("grpc_csharp_ext.dll")] |
||||
static extern int grpcsharp_sizeof_grpc_event(); |
||||
|
||||
public GRPCCompletionType type; |
||||
public int success; |
||||
public IntPtr tag; |
||||
|
||||
internal static int NativeSize |
||||
{ |
||||
get |
||||
{ |
||||
return grpcsharp_sizeof_grpc_event(); |
||||
} |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,89 @@ |
||||
#region Copyright notice and license |
||||
|
||||
// Copyright 2015, Google Inc. |
||||
// All rights reserved. |
||||
// |
||||
// Redistribution and use in source and binary forms, with or without |
||||
// modification, are permitted provided that the following conditions are |
||||
// met: |
||||
// |
||||
// * Redistributions of source code must retain the above copyright |
||||
// notice, this list of conditions and the following disclaimer. |
||||
// * Redistributions in binary form must reproduce the above |
||||
// copyright notice, this list of conditions and the following disclaimer |
||||
// in the documentation and/or other materials provided with the |
||||
// distribution. |
||||
// * Neither the name of Google Inc. nor the names of its |
||||
// contributors may be used to endorse or promote products derived from |
||||
// this software without specific prior written permission. |
||||
// |
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
|
||||
#endregion |
||||
|
||||
using System; |
||||
using System.Collections.Concurrent; |
||||
using System.Collections.Generic; |
||||
using System.Runtime.InteropServices; |
||||
using Grpc.Core.Utils; |
||||
|
||||
namespace Grpc.Core.Internal |
||||
{ |
||||
internal delegate void OpCompletionDelegate(bool success); |
||||
|
||||
internal delegate void BatchCompletionDelegate(bool success, BatchContextSafeHandle ctx); |
||||
|
||||
internal class CompletionRegistry |
||||
{ |
||||
readonly ConcurrentDictionary<IntPtr, OpCompletionDelegate> dict = new ConcurrentDictionary<IntPtr, OpCompletionDelegate>(); |
||||
|
||||
public void Register(IntPtr key, OpCompletionDelegate callback) |
||||
{ |
||||
DebugStats.PendingBatchCompletions.Increment(); |
||||
Preconditions.CheckState(dict.TryAdd(key, callback)); |
||||
} |
||||
|
||||
public void RegisterBatchCompletion(BatchContextSafeHandle ctx, BatchCompletionDelegate callback) |
||||
{ |
||||
OpCompletionDelegate opCallback = ((success) => HandleBatchCompletion(success, ctx, callback)); |
||||
Register(ctx.Handle, opCallback); |
||||
} |
||||
|
||||
public OpCompletionDelegate Extract(IntPtr key) |
||||
{ |
||||
OpCompletionDelegate value; |
||||
Preconditions.CheckState(dict.TryRemove(key, out value)); |
||||
DebugStats.PendingBatchCompletions.Decrement(); |
||||
return value; |
||||
} |
||||
|
||||
private static void HandleBatchCompletion(bool success, BatchContextSafeHandle ctx, BatchCompletionDelegate callback) |
||||
{ |
||||
try |
||||
{ |
||||
callback(success, ctx); |
||||
} |
||||
catch (Exception e) |
||||
{ |
||||
Console.WriteLine("Exception occured while invoking completion delegate: " + e); |
||||
} |
||||
finally |
||||
{ |
||||
if (ctx != null) |
||||
{ |
||||
ctx.Dispose(); |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,90 @@ |
||||
/* |
||||
* |
||||
* Copyright 2015, Google Inc. |
||||
* All rights reserved. |
||||
* |
||||
* Redistribution and use in source and binary forms, with or without |
||||
* modification, are permitted provided that the following conditions are |
||||
* met: |
||||
* |
||||
* * Redistributions of source code must retain the above copyright |
||||
* notice, this list of conditions and the following disclaimer. |
||||
* * Redistributions in binary form must reproduce the above |
||||
* copyright notice, this list of conditions and the following disclaimer |
||||
* in the documentation and/or other materials provided with the |
||||
* distribution. |
||||
* * Neither the name of Google Inc. nor the names of its |
||||
* contributors may be used to endorse or promote products derived from |
||||
* this software without specific prior written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
* |
||||
*/ |
||||
|
||||
'use strict'; |
||||
|
||||
var assert = require('assert'); |
||||
|
||||
var common = require('../src/common.js'); |
||||
|
||||
var ProtoBuf = require('protobufjs'); |
||||
|
||||
var messages_proto = ProtoBuf.loadProtoFile( |
||||
__dirname + '/test_messages.proto').build(); |
||||
|
||||
describe('Proto message serialize and deserialize', function() { |
||||
var longSerialize = common.serializeCls(messages_proto.LongValues); |
||||
var longDeserialize = common.deserializeCls(messages_proto.LongValues); |
||||
var pos_value = '314159265358979'; |
||||
var neg_value = '-27182818284590'; |
||||
it('should preserve positive int64 values', function() { |
||||
var serialized = longSerialize({int_64: pos_value}); |
||||
assert.strictEqual(longDeserialize(serialized).int_64.toString(), |
||||
pos_value); |
||||
}); |
||||
it('should preserve negative int64 values', function() { |
||||
var serialized = longSerialize({int_64: neg_value}); |
||||
assert.strictEqual(longDeserialize(serialized).int_64.toString(), |
||||
neg_value); |
||||
}); |
||||
it('should preserve uint64 values', function() { |
||||
var serialized = longSerialize({uint_64: pos_value}); |
||||
assert.strictEqual(longDeserialize(serialized).uint_64.toString(), |
||||
pos_value); |
||||
}); |
||||
it('should preserve positive sint64 values', function() { |
||||
var serialized = longSerialize({sint_64: pos_value}); |
||||
assert.strictEqual(longDeserialize(serialized).sint_64.toString(), |
||||
pos_value); |
||||
}); |
||||
it('should preserve negative sint64 values', function() { |
||||
var serialized = longSerialize({sint_64: neg_value}); |
||||
assert.strictEqual(longDeserialize(serialized).sint_64.toString(), |
||||
neg_value); |
||||
}); |
||||
it('should preserve fixed64 values', function() { |
||||
var serialized = longSerialize({fixed_64: pos_value}); |
||||
assert.strictEqual(longDeserialize(serialized).fixed_64.toString(), |
||||
pos_value); |
||||
}); |
||||
it('should preserve positive sfixed64 values', function() { |
||||
var serialized = longSerialize({sfixed_64: pos_value}); |
||||
assert.strictEqual(longDeserialize(serialized).sfixed_64.toString(), |
||||
pos_value); |
||||
}); |
||||
it('should preserve negative sfixed64 values', function() { |
||||
var serialized = longSerialize({sfixed_64: neg_value}); |
||||
assert.strictEqual(longDeserialize(serialized).sfixed_64.toString(), |
||||
neg_value); |
||||
}); |
||||
}); |
||||
@ -0,0 +1,38 @@ |
||||
// Copyright 2015, Google Inc. |
||||
// All rights reserved. |
||||
// |
||||
// Redistribution and use in source and binary forms, with or without |
||||
// modification, are permitted provided that the following conditions are |
||||
// met: |
||||
// |
||||
// * Redistributions of source code must retain the above copyright |
||||
// notice, this list of conditions and the following disclaimer. |
||||
// * Redistributions in binary form must reproduce the above |
||||
// copyright notice, this list of conditions and the following disclaimer |
||||
// in the documentation and/or other materials provided with the |
||||
// distribution. |
||||
// * Neither the name of Google Inc. nor the names of its |
||||
// contributors may be used to endorse or promote products derived from |
||||
// this software without specific prior written permission. |
||||
// |
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
|
||||
syntax = "proto3"; |
||||
|
||||
message LongValues { |
||||
int64 int_64 = 1; |
||||
uint64 uint_64 = 2; |
||||
sint64 sint_64 = 3; |
||||
fixed64 fixed_64 = 4; |
||||
sfixed64 sfixed_64 = 5; |
||||
} |
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue