blob: 19d7f8a09258fbe9961c8423cdda7ade9cc539ef [file] [log] [blame]
Brian Silverman9c614bc2016-02-15 20:20:02 -05001#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
33namespace Google.Protobuf.Reflection
34{
35 /// <summary>
36 /// Describes a single method in a service.
37 /// </summary>
38 public sealed class MethodDescriptor : DescriptorBase
39 {
40 private readonly MethodDescriptorProto proto;
41 private readonly ServiceDescriptor service;
42 private MessageDescriptor inputType;
43 private MessageDescriptor outputType;
44
45 /// <value>
46 /// The service this method belongs to.
47 /// </value>
48 public ServiceDescriptor Service { get { return service; } }
49
50 /// <value>
51 /// The method's input type.
52 /// </value>
53 public MessageDescriptor InputType { get { return inputType; } }
54
55 /// <value>
56 /// The method's input type.
57 /// </value>
58 public MessageDescriptor OutputType { get { return outputType; } }
59
60 /// <value>
61 /// Indicates if client streams multiple requests.
62 /// </value>
63 public bool IsClientStreaming { get { return proto.ClientStreaming; } }
64
65 /// <value>
66 /// Indicates if server streams multiple responses.
67 /// </value>
68 public bool IsServerStreaming { get { return proto.ServerStreaming; } }
69
Austin Schuh40c16522018-10-28 20:27:54 -070070 /// <summary>
71 /// The (possibly empty) set of custom options for this method.
72 /// </summary>
73 public CustomOptions CustomOptions => Proto.Options?.CustomOptions ?? CustomOptions.Empty;
74
Brian Silverman9c614bc2016-02-15 20:20:02 -050075 internal MethodDescriptor(MethodDescriptorProto proto, FileDescriptor file,
76 ServiceDescriptor parent, int index)
77 : base(file, parent.FullName + "." + proto.Name, index)
78 {
79 this.proto = proto;
80 service = parent;
81 file.DescriptorPool.AddSymbol(this);
82 }
83
84 internal MethodDescriptorProto Proto { get { return proto; } }
85
86 /// <summary>
87 /// The brief name of the descriptor's target.
88 /// </summary>
89 public override string Name { get { return proto.Name; } }
90
91 internal void CrossLink()
92 {
93 IDescriptor lookup = File.DescriptorPool.LookupSymbol(Proto.InputType, this);
94 if (!(lookup is MessageDescriptor))
95 {
96 throw new DescriptorValidationException(this, "\"" + Proto.InputType + "\" is not a message type.");
97 }
98 inputType = (MessageDescriptor) lookup;
99
100 lookup = File.DescriptorPool.LookupSymbol(Proto.OutputType, this);
101 if (!(lookup is MessageDescriptor))
102 {
103 throw new DescriptorValidationException(this, "\"" + Proto.OutputType + "\" is not a message type.");
104 }
105 outputType = (MessageDescriptor) lookup;
106 }
107 }
108}