Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a caching channel factory. #92

Merged
merged 1 commit into from
Jun 11, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 97 additions & 0 deletions src/Lib/CachedChannelFactory.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using Google.Ads.GoogleAds.Config;
using Grpc.Auth;
using Grpc.Core;
using System;
using System.Collections.Generic;

namespace Google.Ads.GoogleAds.Lib
{
/// <summary>
/// A channel factory that uses internal caching when possible.
/// </summary>
internal class CachedChannelFactory
{
/// <summary>
/// The cache to store existing channels.
/// </summary>
private static Dictionary<string, Channel> cache = new Dictionary<string, Channel>();


/// <summary>
/// Gets the channel for the specified configuration.
/// </summary>
/// <param name="config">The configuration.</param>
/// <returns>The channel.</returns>
internal static Channel GetChannel(GoogleAdsConfig config)
{
Channel retval = null;

// Channels with unique (credentials, Url) combination should be unique.
string key = string.Join("~", new object[] {
config.OAuth2Mode,
config.OAuth2ClientId,
config.OAuth2ClientSecret,
config.OAuth2RefreshToken,
config.OAuth2PrivateKey,
config.OAuth2PrnEmail,
config.ServerUrl
});

lock (cache)
{
if (cache.ContainsKey(key))
{
retval = cache[key];
if (retval.State == ChannelState.Shutdown)
{
// If the channel is shut down, then remove it from cache.
lock (cache)
{
cache.Remove(key);
retval = null;
}
}
}

if (retval == null)
{
// Create a new channel.
lock (cache)
{
retval = CreateChannel(config);
cache[key] = retval;
}
}
}

return retval;
}

/// <summary>
/// Creates the channel.
/// </summary>
/// <param name="config">The configuration.</param>
/// <returns>The channel.</returns>
private static Channel CreateChannel(GoogleAdsConfig config)
{
ChannelCredentials channelCredentials =
GoogleGrpcCredentials.ToChannelCredentials(config.Credentials);
Uri uri = new Uri(config.ServerUrl);
return new Channel(uri.Host, uri.Port, channelCredentials);
}
}
}