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
33using Google.Protobuf.Collections;
34using System;
35using System.Collections.Generic;
36using System.Collections.ObjectModel;
37
38namespace Google.Protobuf.Reflection
39{
40    /// <summary>
41    /// Describes a service type.
42    /// </summary>
43    public sealed class ServiceDescriptor : DescriptorBase
44    {
45        private readonly ServiceDescriptorProto proto;
46        private readonly IList<MethodDescriptor> methods;
47
48        internal ServiceDescriptor(ServiceDescriptorProto proto, FileDescriptor file, int index)
49            : base(file, file.ComputeFullName(null, proto.Name), index)
50        {
51            this.proto = proto;
52            methods = DescriptorUtil.ConvertAndMakeReadOnly(proto.Method,
53                                                            (method, i) => new MethodDescriptor(method, file, this, i));
54
55            file.DescriptorPool.AddSymbol(this);
56        }
57
58        /// <summary>
59        /// The brief name of the descriptor's target.
60        /// </summary>
61        public override string Name { get { return proto.Name; } }
62
63        internal override IReadOnlyList<DescriptorBase> GetNestedDescriptorListForField(int fieldNumber)
64        {
65            switch (fieldNumber)
66            {
67                case ServiceDescriptorProto.MethodFieldNumber:
68                    return (IReadOnlyList<DescriptorBase>) methods;
69                default:
70                    return null;
71            }
72        }
73
74        internal ServiceDescriptorProto Proto { get { return proto; } }
75
76        /// <value>
77        /// An unmodifiable list of methods in this service.
78        /// </value>
79        public IList<MethodDescriptor> Methods
80        {
81            get { return methods; }
82        }
83
84        /// <summary>
85        /// Finds a method by name.
86        /// </summary>
87        /// <param name="name">The unqualified name of the method (e.g. "Foo").</param>
88        /// <returns>The method's descriptor, or null if not found.</returns>
89        public MethodDescriptor FindMethodByName(String name)
90        {
91            return File.DescriptorPool.FindSymbol<MethodDescriptor>(FullName + "." + name);
92        }
93
94        /// <summary>
95        /// The (possibly empty) set of custom options for this service.
96        /// </summary>
97        [Obsolete("CustomOptions are obsolete. Use the GetOptions() method.")]
98        public CustomOptions CustomOptions => new CustomOptions(Proto.Options?._extensions?.ValuesByNumber);
99
100        /// <summary>
101        /// The <c>ServiceOptions</c>, defined in <c>descriptor.proto</c>.
102        /// If the options message is not present (i.e. there are no options), <c>null</c> is returned.
103        /// Custom options can be retrieved as extensions of the returned message.
104        /// NOTE: A defensive copy is created each time this property is retrieved.
105        /// </summary>
106        public ServiceOptions GetOptions() => Proto.Options?.Clone();
107
108        /// <summary>
109        /// Gets a single value service option for this descriptor
110        /// </summary>
111        [Obsolete("GetOption is obsolete. Use the GetOptions() method.")]
112        public T GetOption<T>(Extension<ServiceOptions, T> extension)
113        {
114            var value = Proto.Options.GetExtension(extension);
115            return value is IDeepCloneable<T> ? (value as IDeepCloneable<T>).Clone() : value;
116        }
117
118        /// <summary>
119        /// Gets a repeated value service option for this descriptor
120        /// </summary>
121        [Obsolete("GetOption is obsolete. Use the GetOptions() method.")]
122        public RepeatedField<T> GetOption<T>(RepeatedExtension<ServiceOptions, T> extension)
123        {
124            return Proto.Options.GetExtension(extension).Clone();
125        }
126
127        internal void CrossLink()
128        {
129            foreach (MethodDescriptor method in methods)
130            {
131                method.CrossLink();
132            }
133        }
134    }
135}
136