Skip to content

Consistently use Task or ValueTask in APIs #1646

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 6, 2024
Merged

Consistently use Task or ValueTask in APIs #1646

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion projects/RabbitMQ.Client/client/impl/AutorecoveringConnection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ public async ValueTask<RecoveryAwareChannel> CreateNonRecoveringChannelAsync(Can
public override string ToString()
=> $"AutorecoveringConnection({InnerConnection.Id},{Endpoint},{GetHashCode()})";

internal Task CloseFrameHandlerAsync()
internal ValueTask CloseFrameHandlerAsync()
{
return InnerConnection.FrameHandler.CloseAsync(CancellationToken.None);
}
Expand Down
4 changes: 2 additions & 2 deletions projects/RabbitMQ.Client/client/impl/IFrameHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ internal interface IFrameHandler
///<summary>Socket write timeout. System.Threading.Timeout.InfiniteTimeSpan signals "infinity".</summary>
TimeSpan WriteTimeout { set; }

Task CloseAsync(CancellationToken cancellationToken);
ValueTask CloseAsync(CancellationToken cancellationToken);

///<summary>Read a frame from the underlying
///transport. Returns null if the read operation timed out
Expand All @@ -66,7 +66,7 @@ internal interface IFrameHandler
///</summary>
bool TryReadFrame(InboundFrame frame);

Task SendProtocolHeaderAsync(CancellationToken cancellationToken);
ValueTask SendProtocolHeaderAsync(CancellationToken cancellationToken);

ValueTask WriteAsync(RentedMemory frames, CancellationToken cancellationToken);
}
Expand Down
4 changes: 2 additions & 2 deletions projects/RabbitMQ.Client/client/impl/SocketFrameHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ public static async Task<SocketFrameHandler> CreateAsync(AmqpTcpEndpoint amqpTcp
return socketFrameHandler;
}

public async Task CloseAsync(CancellationToken cancellationToken)
public async ValueTask CloseAsync(CancellationToken cancellationToken)
{
if (_closed)
{
Expand Down Expand Up @@ -216,7 +216,7 @@ public bool TryReadFrame(InboundFrame frame)
_amqpTcpEndpoint.MaxInboundMessageBodySize, frame);
}

public async Task SendProtocolHeaderAsync(CancellationToken cancellationToken)
public async ValueTask SendProtocolHeaderAsync(CancellationToken cancellationToken)
{
await _pipeWriter.WriteAsync(Amqp091ProtocolHeader, cancellationToken)
.ConfigureAwait(false);
Expand Down
4 changes: 2 additions & 2 deletions projects/Test/Integration/TestConnectionShutdown.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,13 +100,13 @@ public async Task TestDisposedWithSocketClosedOutOfBand()
};

var c = (AutorecoveringConnection)_conn;
Task frameHandlerCloseTask = c.CloseFrameHandlerAsync();
ValueTask frameHandlerCloseTask = c.CloseFrameHandlerAsync();

try
{
_conn.Dispose();
await WaitAsync(tcs, WaitSpan, "channel shutdown");
await frameHandlerCloseTask.WaitAsync(WaitSpan);
await frameHandlerCloseTask.AsTask().WaitAsync(WaitSpan);
}
finally
{
Expand Down