Interface IStatsApi

Get statistics/diagnostics for the various core components.

Namespace: Ipfs.CoreApi
Assembly: Ipfs.Core.dll
Syntax
public interface IStatsApi

Methods

| Improve this Doc View Source

BandwidthAsync(CancellationToken)

Get statistics on network bandwidth.

Declaration
Task<BandwidthData> BandwidthAsync(CancellationToken cancel = default(CancellationToken))
Parameters
Type Name Description
CancellationToken cancel

Is used to stop the task. When cancelled, the TaskCanceledException is raised.
Returns
Type Description
Task<BandwidthData>

A task that represents the asynchronous operation. The task's result is the current BandwidthData.
See Also
| Improve this Doc View Source

BitswapAsync(CancellationToken)

Get statistics on the blocks exchanged with other peers.

Declaration
Task<BitswapData> BitswapAsync(CancellationToken cancel = default(CancellationToken))
Parameters
Type Name Description
CancellationToken cancel

Is used to stop the task. When cancelled, the TaskCanceledException is raised.
Returns
Type Description
Task<BitswapData>

A task that represents the asynchronous operation. The task's result is the current BitswapData.
See Also
| Improve this Doc View Source

RepositoryAsync(CancellationToken)

Get statistics on the repository.

Declaration
Task<RepositoryData> RepositoryAsync(CancellationToken cancel = default(CancellationToken))
Parameters
Type Name Description
CancellationToken cancel

Is used to stop the task. When cancelled, the TaskCanceledException is raised.
Returns
Type Description
Task<RepositoryData>

A task that represents the asynchronous operation. The task's result is the current RepositoryData.
Remarks

Same as StatisticsAsync(CancellationToken).

See Also