mirror of https://github.com/grpc/grpc.git
Merge pull request #1053 from jtattermusch/csharp_metadata
Added support for sending metadata from clients.pull/1067/head
Tim Emiola
10 years ago
commit
09eaec027a
19 changed files with 694 additions and 154 deletions
@ -0,0 +1,62 @@ |
||||
#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 MetadataArraySafeHandleTest |
||||
{ |
||||
[Test] |
||||
public void CreateEmptyAndDestroy() |
||||
{ |
||||
var metadata = Metadata.CreateBuilder().Build(); |
||||
var nativeMetadata = MetadataArraySafeHandle.Create(metadata); |
||||
nativeMetadata.Dispose(); |
||||
} |
||||
|
||||
[Test] |
||||
public void CreateAndDestroy() |
||||
{ |
||||
var metadata = Metadata.CreateBuilder() |
||||
.Add(new Metadata.MetadataEntry("host", "somehost")) |
||||
.Add(new Metadata.MetadataEntry("header2", "header value")).Build(); |
||||
var nativeMetadata = MetadataArraySafeHandle.Create(metadata); |
||||
nativeMetadata.Dispose(); |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,72 @@ |
||||
#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; |
||||
|
||||
namespace Grpc.Core.Internal |
||||
{ |
||||
/// <summary> |
||||
/// grpc_metadata_array from <grpc/grpc.h> |
||||
/// </summary> |
||||
internal class MetadataArraySafeHandle : SafeHandleZeroIsInvalid |
||||
{ |
||||
[DllImport("grpc_csharp_ext.dll")] |
||||
static extern MetadataArraySafeHandle grpcsharp_metadata_array_create(UIntPtr capacity); |
||||
|
||||
[DllImport("grpc_csharp_ext.dll", CharSet = CharSet.Ansi)] |
||||
static extern void grpcsharp_metadata_array_add(MetadataArraySafeHandle array, string key, byte[] value, UIntPtr valueLength); |
||||
|
||||
[DllImport("grpc_csharp_ext.dll")] |
||||
static extern void grpcsharp_metadata_array_destroy_full(IntPtr array); |
||||
|
||||
private MetadataArraySafeHandle() |
||||
{ |
||||
} |
||||
|
||||
public static MetadataArraySafeHandle Create(Metadata metadata) |
||||
{ |
||||
var entries = metadata.Entries; |
||||
var metadataArray = grpcsharp_metadata_array_create(new UIntPtr((ulong)entries.Count)); |
||||
for (int i = 0; i < entries.Count; i++) |
||||
{ |
||||
grpcsharp_metadata_array_add(metadataArray, entries[i].Key, entries[i].ValueBytes, new UIntPtr((ulong)entries[i].ValueBytes.Length)); |
||||
} |
||||
return metadataArray; |
||||
} |
||||
|
||||
protected override bool ReleaseHandle() |
||||
{ |
||||
grpcsharp_metadata_array_destroy_full(handle); |
||||
return true; |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,126 @@ |
||||
#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.Text; |
||||
|
||||
namespace Grpc.Core |
||||
{ |
||||
/// <summary> |
||||
/// gRPC call metadata. |
||||
/// </summary> |
||||
public class Metadata |
||||
{ |
||||
public static readonly Metadata Empty = new Metadata(ImmutableList<MetadataEntry>.Empty); |
||||
|
||||
readonly ImmutableList<MetadataEntry> entries; |
||||
|
||||
public Metadata(ImmutableList<MetadataEntry> entries) |
||||
{ |
||||
this.entries = entries; |
||||
} |
||||
|
||||
public ImmutableList<MetadataEntry> Entries |
||||
{ |
||||
get |
||||
{ |
||||
return this.entries; |
||||
} |
||||
} |
||||
|
||||
public static Builder CreateBuilder() |
||||
{ |
||||
return new Builder(); |
||||
} |
||||
|
||||
public struct MetadataEntry |
||||
{ |
||||
readonly string key; |
||||
readonly byte[] valueBytes; |
||||
|
||||
public MetadataEntry(string key, byte[] valueBytes) |
||||
{ |
||||
this.key = key; |
||||
this.valueBytes = valueBytes; |
||||
} |
||||
|
||||
public MetadataEntry(string key, string value) |
||||
{ |
||||
this.key = key; |
||||
this.valueBytes = Encoding.ASCII.GetBytes(value); |
||||
} |
||||
|
||||
public string Key |
||||
{ |
||||
get |
||||
{ |
||||
return this.key; |
||||
} |
||||
} |
||||
|
||||
// TODO: using ByteString would guarantee immutability. |
||||
public byte[] ValueBytes |
||||
{ |
||||
get |
||||
{ |
||||
return this.valueBytes; |
||||
} |
||||
} |
||||
} |
||||
|
||||
public class Builder |
||||
{ |
||||
readonly List<Metadata.MetadataEntry> entries = new List<Metadata.MetadataEntry>(); |
||||
|
||||
public List<MetadataEntry> Entries |
||||
{ |
||||
get |
||||
{ |
||||
return entries; |
||||
} |
||||
} |
||||
|
||||
public Builder Add(MetadataEntry entry) |
||||
{ |
||||
entries.Add(entry); |
||||
return this; |
||||
} |
||||
|
||||
public Metadata Build() |
||||
{ |
||||
return new Metadata(entries.ToImmutableList()); |
||||
} |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,73 @@ |
||||
#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.Internal; |
||||
|
||||
namespace Grpc.Core |
||||
{ |
||||
// TODO: support adding timeout to methods. |
||||
/// <summary> |
||||
/// Base for client-side stubs. |
||||
/// </summary> |
||||
public abstract class AbstractStub<TStub, TConfig> |
||||
where TConfig : StubConfiguration |
||||
{ |
||||
readonly Channel channel; |
||||
readonly TConfig config; |
||||
|
||||
public AbstractStub(Channel channel, TConfig config) |
||||
{ |
||||
this.channel = channel; |
||||
this.config = config; |
||||
} |
||||
|
||||
public Channel Channel |
||||
{ |
||||
get |
||||
{ |
||||
return this.channel; |
||||
} |
||||
} |
||||
|
||||
/// <summary> |
||||
/// Creates a new call to given method. |
||||
/// </summary> |
||||
protected Call<TRequest, TResponse> CreateCall<TRequest, TResponse>(string serviceName, Method<TRequest, TResponse> method) |
||||
{ |
||||
var headerBuilder = Metadata.CreateBuilder(); |
||||
config.HeaderInterceptor(headerBuilder); |
||||
return new Call<TRequest, TResponse>(serviceName, method, channel, headerBuilder.Build()); |
||||
} |
||||
} |
||||
} |
||||
@ -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 Grpc.Core.Internal; |
||||
using Grpc.Core.Utils; |
||||
|
||||
namespace Grpc.Core |
||||
{ |
||||
public delegate void HeaderInterceptorDelegate(Metadata.Builder headerBuilder); |
||||
|
||||
public class StubConfiguration |
||||
{ |
||||
/// <summary> |
||||
/// The default stub configuration. |
||||
/// </summary> |
||||
public static readonly StubConfiguration Default = new StubConfiguration((headerBuilder) => { }); |
||||
|
||||
readonly HeaderInterceptorDelegate headerInterceptor; |
||||
|
||||
public StubConfiguration(HeaderInterceptorDelegate headerInterceptor) |
||||
{ |
||||
this.headerInterceptor = Preconditions.CheckNotNull(headerInterceptor); |
||||
} |
||||
|
||||
public HeaderInterceptorDelegate HeaderInterceptor |
||||
{ |
||||
get |
||||
{ |
||||
return headerInterceptor; |
||||
} |
||||
} |
||||
} |
||||
} |
||||
Loading…
Reference in new issue