Skip to content

Commit 3c271ec

Browse files
JamesNKJamesNK
authored
Rename max message size properties (#461)
1 parent 487259c commit 3c271ec

File tree

11 files changed

+43
-43
lines changed

11 files changed

+43
-43
lines changed

‎src/Grpc.AspNetCore.Server/GrpcServiceOptions.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ public class GrpcServiceOptions
3737
/// <summary>
3838
/// Gets or sets the maximum message size in bytes that can be sent from the server.
3939
/// </summary>
40-
public int? SendMaxMessageSize { get; set; }
40+
public int? MaxSendMessageSize { get; set; }
4141

4242
/// <summary>
4343
/// Gets or sets the maximum message size in bytes that can be received by the server.
4444
/// </summary>
45-
public int? ReceiveMaxMessageSize { get; set; }
45+
public int? MaxReceiveMessageSize { get; set; }
4646

4747
/// <summary>
4848
/// Gets or sets a value indicating whether detailed error messages are sent to the peer.

‎src/Grpc.AspNetCore.Server/Internal/GrpcServiceOptionsSetup.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ internal class GrpcServiceOptionsSetup : IConfigureOptions<GrpcServiceOptions>
3131

3232
public void Configure(GrpcServiceOptions options)
3333
{
34-
if (options.ReceiveMaxMessageSize == null)
34+
if (options.MaxReceiveMessageSize == null)
3535
{
36-
options.ReceiveMaxMessageSize = DefaultReceiveMaxMessageSize;
36+
options.MaxReceiveMessageSize = DefaultReceiveMaxMessageSize;
3737
}
3838
if (options._compressionProviders == null || options._compressionProviders.Count == 0)
3939
{
@@ -54,8 +54,8 @@ public GrpcServiceOptionsSetup(IOptions<GrpcServiceOptions> options)
5454

5555
public void Configure(GrpcServiceOptions<TService> options)
5656
{
57-
options.ReceiveMaxMessageSize = _options.ReceiveMaxMessageSize;
58-
options.SendMaxMessageSize = _options.SendMaxMessageSize;
57+
options.MaxReceiveMessageSize = _options.MaxReceiveMessageSize;
58+
options.MaxSendMessageSize = _options.MaxSendMessageSize;
5959
options.EnableDetailedErrors = _options.EnableDetailedErrors;
6060
options.ResponseCompressionAlgorithm = _options.ResponseCompressionAlgorithm;
6161
options.ResponseCompressionLevel = _options.ResponseCompressionLevel;

‎src/Grpc.AspNetCore.Server/Internal/PipeExtensions.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ public static async Task WriteMessageAsync<TResponse>(this PipeWriter pipeWriter
9595
responsePayload);
9696
}
9797

98-
if (responsePayload.Length > serverCallContext.ServiceOptions.SendMaxMessageSize)
98+
if (responsePayload.Length > serverCallContext.ServiceOptions.MaxSendMessageSize)
9999
{
100100
throw new RpcException(SendingMessageExceedsLimitStatus);
101101
}
@@ -395,7 +395,7 @@ private static bool TryReadMessage(ref ReadOnlySequence<byte> buffer, HttpContex
395395
return false;
396396
}
397397

398-
if (messageLength > context.ServiceOptions.ReceiveMaxMessageSize)
398+
if (messageLength > context.ServiceOptions.MaxReceiveMessageSize)
399399
{
400400
throw new RpcException(ReceivedMessageExceedsLimitStatus);
401401
}

‎src/Grpc.AspNetCore.Server/Internal/ServerCallHandlerFactory.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ public ServerCallHandlerFactory(
6060
_resolvedOptions = new GrpcServiceOptions
6161
{
6262
EnableDetailedErrors = so.EnableDetailedErrors ?? go.EnableDetailedErrors,
63-
ReceiveMaxMessageSize = so.ReceiveMaxMessageSize ?? go.ReceiveMaxMessageSize,
64-
SendMaxMessageSize = so.SendMaxMessageSize ?? go.SendMaxMessageSize,
63+
MaxReceiveMessageSize = so.MaxReceiveMessageSize ?? go.MaxReceiveMessageSize,
64+
MaxSendMessageSize = so.MaxSendMessageSize ?? go.MaxSendMessageSize,
6565
ResponseCompressionAlgorithm = so.ResponseCompressionAlgorithm ?? go.ResponseCompressionAlgorithm,
6666
ResponseCompressionLevel = so.ResponseCompressionLevel ?? go.ResponseCompressionLevel
6767
};

‎src/Grpc.Net.Client/GrpcChannel.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ namespace Grpc.Net.Client
3838
/// </summary>
3939
public sealed class GrpcChannel : ChannelBase
4040
{
41-
internal const int DefaultReceiveMaxMessageSize = 1024 * 1024 * 4; // 4 MB
41+
internal const int DefaultMaxReceiveMessageSize = 1024 * 1024 * 4; // 4 MB
4242

4343
internal Uri Address { get; }
4444
internal HttpClient HttpClient { get; }
@@ -58,8 +58,8 @@ internal GrpcChannel(Uri address, GrpcChannelOptions channelOptions) : base(addr
5858
{
5959
Address = address;
6060
HttpClient = channelOptions.HttpClient ?? new HttpClient();
61-
SendMaxMessageSize = channelOptions.SendMaxMessageSize;
62-
ReceiveMaxMessageSize = channelOptions.ReceiveMaxMessageSize;
61+
SendMaxMessageSize = channelOptions.MaxSendMessageSize;
62+
ReceiveMaxMessageSize = channelOptions.MaxReceiveMessageSize;
6363
CompressionProviders = ResolveCompressionProviders(channelOptions.CompressionProviders);
6464
MessageAcceptEncoding = GrpcProtocolHelpers.GetMessageAcceptEncoding(CompressionProviders);
6565
LoggerFactory = channelOptions.LoggerFactory ?? NullLoggerFactory.Instance;

‎src/Grpc.Net.Client/GrpcChannelOptions.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ public sealed class GrpcChannelOptions
3838
/// <summary>
3939
/// Gets or sets the maximum message size in bytes that can be sent from the client.
4040
/// </summary>
41-
public int? SendMaxMessageSize { get; set; }
41+
public int? MaxSendMessageSize { get; set; }
4242

4343
/// <summary>
4444
/// Gets or sets the maximum message size in bytes that can be received by the client.
4545
/// </summary>
46-
public int? ReceiveMaxMessageSize { get; set; }
46+
public int? MaxReceiveMessageSize { get; set; }
4747

4848
/// <summary>
4949
/// Gets or sets a collection of compression providers.
@@ -65,7 +65,7 @@ public sealed class GrpcChannelOptions
6565
/// </summary>
6666
public GrpcChannelOptions()
6767
{
68-
ReceiveMaxMessageSize = GrpcChannel.DefaultReceiveMaxMessageSize;
68+
MaxReceiveMessageSize = GrpcChannel.DefaultMaxReceiveMessageSize;
6969
}
7070
}
7171
}

‎test/Grpc.AspNetCore.Server.Tests/GrpcServicesExtensionsTests.cs‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ public void AddGrpc_ConfigureOptions_OptionsSet()
3434
.AddGrpc(o =>
3535
{
3636
o.EnableDetailedErrors = true;
37-
o.ReceiveMaxMessageSize = 1;
38-
o.SendMaxMessageSize = 1;
37+
o.MaxReceiveMessageSize = 1;
38+
o.MaxSendMessageSize = 1;
3939
});
4040

4141
var serviceProvider = services.BuildServiceProvider(validateScopes: true);
@@ -45,8 +45,8 @@ public void AddGrpc_ConfigureOptions_OptionsSet()
4545

4646
// Assert
4747
Assert.AreEqual(true, options.EnableDetailedErrors);
48-
Assert.AreEqual(1, options.ReceiveMaxMessageSize);
49-
Assert.AreEqual(1, options.SendMaxMessageSize);
48+
Assert.AreEqual(1, options.MaxReceiveMessageSize);
49+
Assert.AreEqual(1, options.MaxSendMessageSize);
5050
}
5151

5252
[Test]
@@ -58,12 +58,12 @@ public void AddServiceOptions_ConfigureOptions_OverrideGlobalOptions()
5858
.AddGrpc(o =>
5959
{
6060
o.EnableDetailedErrors = true;
61-
o.ReceiveMaxMessageSize = 1;
62-
o.SendMaxMessageSize = 1;
61+
o.MaxReceiveMessageSize = 1;
62+
o.MaxSendMessageSize = 1;
6363
})
6464
.AddServiceOptions<object>(o =>
6565
{
66-
o.SendMaxMessageSize = 2;
66+
o.MaxSendMessageSize = 2;
6767
});
6868

6969
var serviceProvider = services.BuildServiceProvider(validateScopes: true);
@@ -73,8 +73,8 @@ public void AddServiceOptions_ConfigureOptions_OverrideGlobalOptions()
7373

7474
// Assert
7575
Assert.AreEqual(true, options.EnableDetailedErrors);
76-
Assert.AreEqual(1, options.ReceiveMaxMessageSize);
77-
Assert.AreEqual(2, options.SendMaxMessageSize);
76+
Assert.AreEqual(1, options.MaxReceiveMessageSize);
77+
Assert.AreEqual(2, options.MaxSendMessageSize);
7878
}
7979
}
8080
}

‎test/Grpc.AspNetCore.Server.Tests/PipeExtensionsTests.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ public async Task ReadSingleMessageAsync_OneByteMessage_ReturnData()
9191
public async Task ReadSingleMessageAsync_UnderReceiveSize_ReturnData()
9292
{
9393
// Arrange
94-
var context = HttpContextServerCallContextHelper.CreateServerCallContext(serviceOptions: new GrpcServiceOptions { SendMaxMessageSize = 1 });
94+
var context = HttpContextServerCallContextHelper.CreateServerCallContext(serviceOptions: new GrpcServiceOptions { MaxSendMessageSize = 1 });
9595
var ms = new MemoryStream(new byte[]
9696
{
9797
0x00, // compression = 0
@@ -116,7 +116,7 @@ public async Task ReadSingleMessageAsync_UnderReceiveSize_ReturnData()
116116
public async Task ReadSingleMessageAsync_ExceedReceiveSize_ReturnData()
117117
{
118118
// Arrange
119-
var context = HttpContextServerCallContextHelper.CreateServerCallContext(serviceOptions: new GrpcServiceOptions { ReceiveMaxMessageSize = 1 });
119+
var context = HttpContextServerCallContextHelper.CreateServerCallContext(serviceOptions: new GrpcServiceOptions { MaxReceiveMessageSize = 1 });
120120
var ms = new MemoryStream(new byte[]
121121
{
122122
0x00, // compression = 0
@@ -593,7 +593,7 @@ public async Task WriteMessageAsync_LongMessage_WriteData()
593593
public async Task WriteMessageAsync_UnderSendSize_WriteData()
594594
{
595595
// Arrange
596-
var context = HttpContextServerCallContextHelper.CreateServerCallContext(serviceOptions: new GrpcServiceOptions { SendMaxMessageSize = 1 });
596+
var context = HttpContextServerCallContextHelper.CreateServerCallContext(serviceOptions: new GrpcServiceOptions { MaxSendMessageSize = 1 });
597597
var ms = new MemoryStream();
598598
var pipeWriter = PipeWriter.Create(ms);
599599

@@ -620,7 +620,7 @@ public async Task WriteMessageAsync_UnderSendSize_WriteData()
620620
public async Task WriteMessageAsync_ExceedSendSize_ThrowError()
621621
{
622622
// Arrange
623-
var context = HttpContextServerCallContextHelper.CreateServerCallContext(serviceOptions: new GrpcServiceOptions { SendMaxMessageSize = 1 });
623+
var context = HttpContextServerCallContextHelper.CreateServerCallContext(serviceOptions: new GrpcServiceOptions { MaxSendMessageSize = 1 });
624624
var ms = new MemoryStream();
625625
var pipeWriter = PipeWriter.Create(ms);
626626

‎test/Grpc.Net.Client.Tests/MaximumMessageSizeTests.cs‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public async Task AsyncUnaryCall_MessageSmallerThanSendMaxMessageSize_Success()
6161
{
6262
// Arrange
6363
var httpClient = ClientTestHelpers.CreateTestClient(HandleRequest);
64-
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.SendMaxMessageSize = 100);
64+
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.MaxSendMessageSize = 100);
6565

6666
// Act
6767
var call = invoker.AsyncUnaryCall<HelloRequest, HelloReply>(ClientTestHelpers.ServiceMethod, string.Empty, new CallOptions(), new HelloRequest
@@ -79,7 +79,7 @@ public async Task AsyncUnaryCall_MessageLargerThanSendMaxMessageSize_ThrowsError
7979
{
8080
// Arrange
8181
var httpClient = ClientTestHelpers.CreateTestClient(HandleRequest);
82-
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.SendMaxMessageSize = 1);
82+
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.MaxSendMessageSize = 1);
8383

8484
// Act
8585
var call = invoker.AsyncUnaryCall<HelloRequest, HelloReply>(ClientTestHelpers.ServiceMethod, string.Empty, new CallOptions(), new HelloRequest
@@ -103,7 +103,7 @@ public async Task AsyncUnaryCall_MessageLargerThanDefaultReceiveMaxMessageSize_T
103103
// Act
104104
var call = invoker.AsyncUnaryCall<HelloRequest, HelloReply>(ClientTestHelpers.ServiceMethod, string.Empty, new CallOptions(), new HelloRequest
105105
{
106-
Name = new string('!', GrpcChannel.DefaultReceiveMaxMessageSize + 1) // max size + 1 B
106+
Name = new string('!', GrpcChannel.DefaultMaxReceiveMessageSize + 1) // max size + 1 B
107107
});
108108

109109
// Assert
@@ -117,8 +117,8 @@ public async Task AsyncUnaryCall_RemoveReceiveMaxMessageSize_Success()
117117
{
118118
// Arrange
119119
var httpClient = ClientTestHelpers.CreateTestClient(HandleRequest);
120-
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.ReceiveMaxMessageSize = null);
121-
var largeName = new string('!', GrpcChannel.DefaultReceiveMaxMessageSize + 1); // max size + 1 B
120+
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.MaxReceiveMessageSize = null);
121+
var largeName = new string('!', GrpcChannel.DefaultMaxReceiveMessageSize + 1); // max size + 1 B
122122

123123
// Act
124124
var call = invoker.AsyncUnaryCall<HelloRequest, HelloReply>(ClientTestHelpers.ServiceMethod, string.Empty, new CallOptions(), new HelloRequest
@@ -136,7 +136,7 @@ public async Task AsyncUnaryCall_MessageSmallerThanReceiveMaxMessageSize_Success
136136
{
137137
// Arrange
138138
var httpClient = ClientTestHelpers.CreateTestClient(HandleRequest);
139-
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.ReceiveMaxMessageSize = 100);
139+
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.MaxReceiveMessageSize = 100);
140140

141141
// Act
142142
var call = invoker.AsyncUnaryCall<HelloRequest, HelloReply>(ClientTestHelpers.ServiceMethod, string.Empty, new CallOptions(), new HelloRequest
@@ -154,7 +154,7 @@ public async Task AsyncUnaryCall_MessageLargerThanReceiveMaxMessageSize_ThrowsEr
154154
{
155155
// Arrange
156156
var httpClient = ClientTestHelpers.CreateTestClient(HandleRequest);
157-
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.ReceiveMaxMessageSize = 1);
157+
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.MaxReceiveMessageSize = 1);
158158

159159
// Act
160160
var call = invoker.AsyncUnaryCall<HelloRequest, HelloReply>(ClientTestHelpers.ServiceMethod, string.Empty, new CallOptions(), new HelloRequest
@@ -173,7 +173,7 @@ public async Task AsyncDuplexStreamingCall_MessageSmallerThanSendMaxMessageSize_
173173
{
174174
// Arrange
175175
var httpClient = ClientTestHelpers.CreateTestClient(HandleRequest);
176-
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.SendMaxMessageSize = 100);
176+
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.MaxSendMessageSize = 100);
177177

178178
// Act
179179
var call = invoker.AsyncDuplexStreamingCall<HelloRequest, HelloReply>(ClientTestHelpers.ServiceMethod, string.Empty, new CallOptions());
@@ -193,7 +193,7 @@ public async Task AsyncDuplexStreamingCall_MessageLargerThanSendMaxMessageSize_T
193193
{
194194
// Arrange
195195
var httpClient = ClientTestHelpers.CreateTestClient(HandleRequest);
196-
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.SendMaxMessageSize = 1);
196+
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.MaxSendMessageSize = 1);
197197

198198
// Act
199199
var call = invoker.AsyncDuplexStreamingCall<HelloRequest, HelloReply>(ClientTestHelpers.ServiceMethod, string.Empty, new CallOptions());
@@ -212,7 +212,7 @@ public async Task AsyncDuplexStreamingCall_MessageSmallerThanReceiveMaxMessageSi
212212
{
213213
// Arrange
214214
var httpClient = ClientTestHelpers.CreateTestClient(HandleRequest);
215-
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.ReceiveMaxMessageSize = 100);
215+
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.MaxReceiveMessageSize = 100);
216216

217217
// Act
218218
var call = invoker.AsyncDuplexStreamingCall<HelloRequest, HelloReply>(ClientTestHelpers.ServiceMethod, string.Empty, new CallOptions());
@@ -232,7 +232,7 @@ public async Task AsyncDuplexStreamingCall_MessageLargerThanReceiveMaxMessageSiz
232232
{
233233
// Arrange
234234
var httpClient = ClientTestHelpers.CreateTestClient(HandleRequest);
235-
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.ReceiveMaxMessageSize = 1);
235+
var invoker = HttpClientCallInvokerFactory.Create(httpClient, configure: o => o.MaxReceiveMessageSize = 1);
236236

237237
// Act
238238
var call = invoker.AsyncDuplexStreamingCall<HelloRequest, HelloReply>(ClientTestHelpers.ServiceMethod, string.Empty, new CallOptions());

‎test/Grpc.Net.ClientFactory.Tests/GrpcHttpClientBuilderExtensionsTests.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public async Task ConfigureChannel_MaxSizeSet_ThrowMaxSizeError()
5555
})
5656
.ConfigureChannel(options =>
5757
{
58-
options.SendMaxMessageSize = 100;
58+
options.MaxSendMessageSize = 100;
5959
})
6060
.ConfigurePrimaryHttpMessageHandler(() =>
6161
{

0 commit comments

Comments
 (0)