csharp/src/Google.Protobuf/Reflection/ServiceDescriptor.cs

   1 #region Copyright notice and license
   2 // Protocol Buffers - Google's data interchange format
   3 // Copyright 2008 Google Inc.  All rights reserved.
   4 // https://developers.google.com/protocol-buffers/
   5 //
   6 // Redistribution and use in source and binary forms, with or without
   7 // modification, are permitted provided that the following conditions are
   8 // met:
   9 //
  10 //     * Redistributions of source code must retain the above copyright
  11 // notice, this list of conditions and the following disclaimer.
  12 //     * Redistributions in binary form must reproduce the above
  13 // copyright notice, this list of conditions and the following disclaimer
  14 // in the documentation and/or other materials provided with the
  15 // distribution.
  16 //     * Neither the name of Google Inc. nor the names of its
  17 // contributors may be used to endorse or promote products derived from
  18 // this software without specific prior written permission.
  19 //
  20 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31 #endregion
  32
  33 using System;
  34 using System.Collections.Generic;
  35 using System.Collections.ObjectModel;
  36
  37 namespace Google.Protobuf.Reflection
  38 {
  39     /// <summary>
  40     /// Describes a service type.
  41     /// </summary>
  42     public sealed class ServiceDescriptor : DescriptorBase
  43     {
  44         private readonly ServiceDescriptorProto proto;
  45         private readonly IList<MethodDescriptor> methods;
  46
  47         internal ServiceDescriptor(ServiceDescriptorProto proto, FileDescriptor file, int index)
  48             : base(file, file.ComputeFullName(null, proto.Name), index)
  49         {
  50             this.proto = proto;
  51             methods = DescriptorUtil.ConvertAndMakeReadOnly(proto.Method,
  52                                                             (method, i) => new MethodDescriptor(method, file, this, i));
  53
  54             file.DescriptorPool.AddSymbol(this);
  55         }
  56
  57         /// <summary>
  58         /// The brief name of the descriptor's target.
  59         /// </summary>
  60         public override string Name { get { return proto.Name; } }
  61
  62         internal override IReadOnlyList<DescriptorBase> GetNestedDescriptorListForField(int fieldNumber)
  63         {
  64             switch (fieldNumber)
  65             {
  66                 case ServiceDescriptorProto.MethodFieldNumber:
  67                     return (IReadOnlyList<DescriptorBase>) methods;
  68                 default:
  69                     return null;
  70             }
  71         }
  72
  73         internal ServiceDescriptorProto Proto { get { return proto; } }
  74
  75         /// <value>
  76         /// An unmodifiable list of methods in this service.
  77         /// </value>
  78         public IList<MethodDescriptor> Methods
  79         {
  80             get { return methods; }
  81         }
  82
  83         /// <summary>
  84         /// Finds a method by name.
  85         /// </summary>
  86         /// <param name="name">The unqualified name of the method (e.g. "Foo").</param>
  87         /// <returns>The method's decsriptor, or null if not found.</returns>
  88         public MethodDescriptor FindMethodByName(String name)
  89         {
  90             return File.DescriptorPool.FindSymbol<MethodDescriptor>(FullName + "." + name);
  91         }
  92
  93         /// <summary>
  94         /// The (possibly empty) set of custom options for this service.
  95         /// </summary>
  96         public CustomOptions CustomOptions => Proto.Options?.CustomOptions ?? CustomOptions.Empty;
  97
  98         internal void CrossLink()
  99         {
 100             foreach (MethodDescriptor method in methods)
 101             {
 102                 method.CrossLink();
 103             }
 104         }
 105     }
 106 }