/// <summary>
/// Subscribes to a Topic Stream from a mirror node, placing the
/// topic messages returned meeting the query criteria into the
/// provided .net Channel.
/// </summary>
/// <param name="subscribeParameters">
/// The details of the query, including the id of the topic, time
/// constraint filters and the .net channel receiving the messages
/// as they are returned from the server.
/// </param>
/// <param name="configure">
/// Optional callback method providing an opportunity to modify the
/// execution configuration for just this method call. It is executed
/// prior to submitting the request to the mirror node.
/// </param>
/// <returns>
/// Returns only after one of the four conditions ocurr: the output channel is
/// completed by calling code; the cancelation token provided in the params is
/// signaled; the maximum number of topic messages was returned as configured in
/// the params; or if the mirror stream faults during streaming, in which case a
/// <see cref="MirrorException"/> is thrown.
/// </returns>
/// <exception cref="ArgumentNullException">If required arguments are missing.</exception>
/// <exception cref="InvalidOperationException">If required context configuration is missing or a parameter is invalid.</exception>
/// <exception cref="MirrorException">If the mirror node stream faulted during request processing or upon submission.</exception>
public async Task SubscribeTopicAsync(SubscribeTopicParams subscribeParameters, Action <IMirrorContext>?configure = null)
{
if (subscribeParameters is null)
{
throw new ArgumentNullException(nameof(subscribeParameters), "Topic Subscribe Parameters argument is missing. Please check that it is not null.");
}
if (subscribeParameters.Topic is null)
{
throw new ArgumentNullException(nameof(subscribeParameters.Topic), "Topic address is missing. Please check that it is not null.");
}
if (subscribeParameters.MessageWriter is null)
{
throw new ArgumentNullException(nameof(subscribeParameters.MessageWriter), "The destination channel writer missing. Please check that it is not null.");
}
if (subscribeParameters.Starting.HasValue && subscribeParameters.Ending.HasValue)
{
if (subscribeParameters.Ending.Value < subscribeParameters.Starting.Value)
{
throw new ArgumentOutOfRangeException(nameof(subscribeParameters.Ending), "The ending filter date is less than the starting filter date, no records can be returned.");
}
}
await using var context = CreateChildContext(configure);
if (context.Url is null)
{
throw new InvalidOperationException("The Mirror Node Urul has not been configured. Please check that 'Url' is set in the Mirror context.");
}
var query = new ConsensusTopicQuery()
{
TopicID = new Proto.TopicID(subscribeParameters.Topic),
Limit = subscribeParameters.MaxCount
};
if (subscribeParameters.Starting.HasValue)
{
query.ConsensusStartTime = new Proto.Timestamp(subscribeParameters.Starting.Value);
}
if (subscribeParameters.Ending.HasValue)
{
query.ConsensusEndTime = new Proto.Timestamp(subscribeParameters.Ending.Value);
}
var service = new ConsensusService.ConsensusServiceClient(context.GetChannel());
using var cancelTokenSource = CancellationTokenSource.CreateLinkedTokenSource(subscribeParameters.CancellationToken);
var options = new CallOptions(cancellationToken: cancelTokenSource.Token);
context.InstantiateOnSendingRequestHandler()(query);
using var response = service.subscribeTopic(query, options);
var stream = response.ResponseStream;
var writer = subscribeParameters.MessageWriter;
try
{
await ProcessResultStreamAsync(subscribeParameters.Topic).ConfigureAwait(false);
}
catch (RpcException ex) when(ex.StatusCode == StatusCode.Cancelled)
{
// Cancelled is an expected closing condition, not an error
}
catch (RpcException ex) when(ex.StatusCode == StatusCode.NotFound)
{
throw new MirrorException($"The topic with the specified address does not exist.", MirrorExceptionCode.TopicNotFound, ex);
}
catch (RpcException ex) when(ex.StatusCode == StatusCode.InvalidArgument)
{
throw new MirrorException($"The address exists, but is not a topic.", MirrorExceptionCode.InvalidTopicAddress, ex);
}
catch (RpcException ex) when(ex.StatusCode == StatusCode.Unavailable)
{
throw new MirrorException($"The Mirror node is not avaliable at this time.", MirrorExceptionCode.Unavailable, ex);
}
catch (RpcException ex)
{
throw new MirrorException($"Stream Terminated with Error: {ex.StatusCode}", MirrorExceptionCode.CommunicationError, ex);
}
finally
{
if (subscribeParameters.CompleteChannelWhenFinished)
{
writer.TryComplete();
}
}
async Task ProcessResultStreamAsync(Address topic)
{
while (await stream.MoveNext().ConfigureAwait(false))
{
var message = stream.Current.ToTopicMessage(topic);
if (!writer.TryWrite(message))
{
while (await writer.WaitToWriteAsync().ConfigureAwait(false))
{
if (!writer.TryWrite(message))
{
cancelTokenSource.Cancel();
return;
}
}
}
}
}
}
/// <summary>
/// Subscribes to a Topic Stream from a mirror node, placing the
/// topic messages returned meeting the query criteria into the
/// provided .net Channel.
/// </summary>
/// <param name="subscribeParameters">
/// The details of the query, including the id of the topic, time
/// constraint filters and the .net channel receiving the messages
/// as they are returned from the server.
/// </param>
/// <param name="configure">
/// Optional callback method providing an opportunity to modify the
/// execution configuration for just this method call. It is executed
/// prior to submitting the request to the mirror node.
/// </param>
/// <returns>
/// Returns only after one of the four conditions ocurr: the output channel is
/// completed by calling code; the cancelation token provided in the params is
/// signaled; the maximum number of topic messages was returned as configured in
/// the params; or if the mirror stream faults during streaming, in which case a
/// <see cref="MirrorException"/> is thrown.
/// </returns>
/// <exception cref="ArgumentNullException">If required arguments are missing.</exception>
/// <exception cref="InvalidOperationException">If required context configuration is missing or a parameter is invalid.</exception>
/// <exception cref="MirrorException">If the mirror node stream faulted during request processing or upon submission.</exception>
public async Task SubscribeTopicAsync(SubscribeTopicParams subscribeParameters, Action <IMirrorContext>?configure = null)
{
subscribeParameters = RequireInputParameter.SubscribeParameters(subscribeParameters);
await using var context = CreateChildContext(configure);
RequireInContext.Url(context);
var query = new ConsensusTopicQuery()
{
TopicID = new Proto.TopicID(subscribeParameters.Topic),
Limit = subscribeParameters.MaxCount
};
if (subscribeParameters.Starting.HasValue)
{
query.ConsensusStartTime = new Proto.Timestamp(subscribeParameters.Starting.Value);
}
if (subscribeParameters.Ending.HasValue)
{
query.ConsensusEndTime = new Proto.Timestamp(subscribeParameters.Ending.Value);
}
var service = new ConsensusService.ConsensusServiceClient(context.GetChannel());
using var cancelTokenSource = CancellationTokenSource.CreateLinkedTokenSource(subscribeParameters.CancellationToken);
var options = new CallOptions(cancellationToken: cancelTokenSource.Token);
context.InstantiateOnSendingRequestHandler()(query);
using var response = service.subscribeTopic(query, options);
var stream = response.ResponseStream;
var writer = subscribeParameters.MessageWriter;
try
{
await ProcessResultStream(subscribeParameters.Topic);
}
catch (RpcException ex) when(ex.StatusCode == StatusCode.Cancelled)
{
// Cancelled is an expected closing condition, not an error
}
catch (RpcException ex) when(ex.StatusCode == StatusCode.NotFound)
{
throw new MirrorException($"The topic with the specified address does not exist.", MirrorExceptionCode.TopicNotFound, ex);
}
catch (RpcException ex) when(ex.StatusCode == StatusCode.InvalidArgument)
{
throw new MirrorException($"The address exists, but is not a topic.", MirrorExceptionCode.InvalidTopicAddress, ex);
}
catch (RpcException ex) when(ex.StatusCode == StatusCode.Unavailable)
{
throw new MirrorException($"The Mirror node is not avaliable at this time.", MirrorExceptionCode.Unavailable, ex);
}
catch (RpcException ex)
{
throw new MirrorException($"Stream Terminated with Error: {ex.StatusCode}", MirrorExceptionCode.CommunicationError, ex);
}
finally
{
if (subscribeParameters.CompleteChannelWhenFinished)
{
writer.TryComplete();
}
}
async Task ProcessResultStream(Address topic)
{
while (await stream.MoveNext())
{
var message = stream.Current.ToTopicMessage(topic);
if (!writer.TryWrite(message))
{
while (await writer.WaitToWriteAsync())
{
if (!writer.TryWrite(message))
{
cancelTokenSource.Cancel();
return;
}
}
}
}
}
}
