C# Class HdrHistogram.HistogramFactory

Provides factory methods to define the features of your histogram.

Afficher le fichier Open project: HdrHistogram/HdrHistogram.NET Class Usage Examples

Méthodes publiques

Méthode	Description
Create ( ) : HistogramBase	Creates the histogram as configured by this factory instance.
Create ( long lowestDiscernibleValue, long highestTrackableValue, int numberOfSignificantValueDigits ) : HistogramBase	A factory-method to create the Histogram.
Create ( long instanceId, long lowestDiscernibleValue, long highestTrackableValue, int numberOfSignificantValueDigits ) : HistogramBase	A factory-method to create the Histogram.
With16BitBucketSize ( ) : HistogramFactory	Specify that the Histogram should be able to record count values in the 32bit range.
With32BitBucketSize ( ) : HistogramFactory	Specify that the Histogram should be able to record count values in the 32bit range.
With64BitBucketSize ( ) : HistogramFactory	Specify that the Histogram should be able to record count values in the 64bit range.
WithPrecisionOf ( int numberOfSignificantValueDigits ) : HistogramFactory	Specifies the number of significant figures that the Histogram should record.
WithThreadSafeReads ( ) : RecorderFactory	Specifies that the consumer will need to be able to read Histogram values in a thread safe manner. This will mean Recorder will be used to wrap the Histogram, allowing thread safe reads.
WithThreadSafeWrites ( ) : HistogramFactory	Specifies that the Histogram to be created should be thread safe when written to from multiple threads.
WithValuesFrom ( long lowestDiscernibleValue ) : HistogramFactory	Specifies the lowest value the Histogram should be configured to record.
WithValuesUpTo ( long highestTrackableValue ) : HistogramFactory	Specifies the highest value the Histogram should be configured to record.

Private Methods

Méthode	Description
HistogramFactory ( ) : System	Private constructor to force usage via the Static starter methods.

Method Details

Create() public méthode

Creates the histogram as configured by this factory instance.

public Create ( ) : HistogramBase
Résultat	HistogramBase

Create() public abstract méthode

A factory-method to create the Histogram.

public abstract Create ( long lowestDiscernibleValue, long highestTrackableValue, int numberOfSignificantValueDigits ) : HistogramBase
lowestDiscernibleValue	long	/// The lowest value that can be tracked (distinguished from 0) by the histogram. /// Must be a positive integer that is >= 1. /// May be internally rounded down to nearest power of 2. ///
highestTrackableValue	long	The highest value to be tracked by the histogram. Must be a positive integer that is >= (2 * ).
numberOfSignificantValueDigits	int	The number of significant decimal digits to which the histogram will maintain value resolution and separation. /// Must be a non-negative integer between 0 and 5. ///
Résultat	HistogramBase

Create() public abstract méthode

A factory-method to create the Histogram.

public abstract Create ( long instanceId, long lowestDiscernibleValue, long highestTrackableValue, int numberOfSignificantValueDigits ) : HistogramBase
instanceId	long	An identifier for this instance.
lowestDiscernibleValue	long	/// The lowest value that can be tracked (distinguished from 0) by the histogram. /// Must be a positive integer that is >= 1. /// May be internally rounded down to nearest power of 2. ///
highestTrackableValue	long	The highest value to be tracked by the histogram. Must be a positive integer that is >= (2 * ).
numberOfSignificantValueDigits	int	The number of significant decimal digits to which the histogram will maintain value resolution and separation. /// Must be a non-negative integer between 0 and 5. ///
Résultat	HistogramBase

With16BitBucketSize() public static méthode

Specify that the Histogram should be able to record count values in the 32bit range.

public static With16BitBucketSize ( ) : HistogramFactory
Résultat	HistogramFactory

With32BitBucketSize() public static méthode

Specify that the Histogram should be able to record count values in the 32bit range.

public static With32BitBucketSize ( ) : HistogramFactory
Résultat	HistogramFactory

With64BitBucketSize() public static méthode

Specify that the Histogram should be able to record count values in the 64bit range.

public static With64BitBucketSize ( ) : HistogramFactory
Résultat	HistogramFactory

WithPrecisionOf() public méthode

Specifies the number of significant figures that the Histogram should record.

public WithPrecisionOf ( int numberOfSignificantValueDigits ) : HistogramFactory
numberOfSignificantValueDigits	int	/// The number of significant decimal digits to which the histogram will maintain value resolution and separation. /// Must be a non-negative integer between 0 and 5. ///
Résultat	HistogramFactory

WithThreadSafeReads() public abstract méthode

Specifies that the consumer will need to be able to read Histogram values in a thread safe manner. This will mean Recorder will be used to wrap the Histogram, allowing thread safe reads.

public abstract WithThreadSafeReads ( ) : RecorderFactory
Résultat	RecorderFactory

WithThreadSafeWrites() public abstract méthode

Specifies that the Histogram to be created should be thread safe when written to from multiple threads.

public abstract WithThreadSafeWrites ( ) : HistogramFactory
Résultat	HistogramFactory

WithValuesFrom() public méthode

Specifies the lowest value the Histogram should be configured to record.

public WithValuesFrom ( long lowestDiscernibleValue ) : HistogramFactory
lowestDiscernibleValue	long	/// The lowest value that can be tracked (distinguished from 0) by the histogram. /// Must be a positive integer that is >= 1. /// May be internally rounded down to nearest power of 2. ///
Résultat	HistogramFactory

WithValuesUpTo() public méthode

Specifies the highest value the Histogram should be configured to record.

public WithValuesUpTo ( long highestTrackableValue ) : HistogramFactory
highestTrackableValue	long	/// The highest value to be tracked by the histogram. Must be a positive integer that is >= (2 * ). ///
Résultat	HistogramFactory