RKBenchmark Class Reference
| Inherits from | NSObject |
| Declared in | RKBenchmark.h RKBenchmark.m |
Overview
RKBenchmark objects provide a simple, lightweight interface for quickly benchmarking the performance of units of code. Benchmark objects can be used procedurally, by manually starting & stopping the benchmark, or using a block interface to measure the execution time of the block.
Tasks
Accessing Benchmark Values
-
nameA name for the benchmark. Can be nil.
property -
startTimeThe start time of the benchmark as an absolute time value.
property -
endTimeThe end time of the benchmark as an absolute time value.
property -
elapsedTimeThe elapsed time of the benchmark as determined by subtracting the end time from the start time. Returns zero until the benchmark has been stopped.
property
Quickly Performing Benchmarks
-
+ report:executionBlock: -
+ measureWithExecutionBlock:Performs a benchmark and returns a time interval measurement of the total time elapsed during the execution of the blocl.
Creating Benchmark Objects
-
+ instanceWithName:Retrieves or creates a benchmark object instance with a given name.
-
+ benchmarkWithName:Creates and returns a benchmark object with a name.
-
– initWithName:Initializes a new benchmark object with a name.
Performing Benchmarks
-
– run:Runs a benchmark by starting the receiver, executing the block, and then stopping the benchmark object.
-
– startStarts the benchmark by recording the start time.
-
– stopStops the benchmark by recording the stop time.
-
– logLogs the current benchmark status. If the receiver has been stopped, the elapsed time of the benchmark is logged. If the benchmark is still running, the total time since the benchmark was started is logged.
Properties
elapsedTime
The elapsed time of the benchmark as determined by subtracting the end time from the start time. Returns zero until the benchmark has been stopped.
@property (nonatomic, assign, readonly) CFTimeInterval elapsedTimeDeclared In
RKBenchmark.hendTime
The end time of the benchmark as an absolute time value.
@property (nonatomic, assign, readonly) CFAbsoluteTime endTimeDeclared In
RKBenchmark.hname
A name for the benchmark. Can be nil.
@property (nonatomic, retain) NSString *nameDeclared In
RKBenchmark.hstartTime
The start time of the benchmark as an absolute time value.
@property (nonatomic, assign, readonly) CFAbsoluteTime startTimeDeclared In
RKBenchmark.hClass Methods
benchmarkWithName:
Creates and returns a benchmark object with a name.
+ (id)benchmarkWithName:(NSString *)nameParameters
- name
A name for the benchmark.
Return Value
A new benchmark object with the given name.
Declared In
RKBenchmark.hinstanceWithName:
Retrieves or creates a benchmark object instance with a given name.
+ (RKBenchmark *)instanceWithName:(NSString *)nameParameters
- name
A name for the benchmark.
Return Value
A new or existing benchmark object with the given name.
Declared In
RKBenchmark.hmeasureWithExecutionBlock:
Performs a benchmark and returns a time interval measurement of the total time elapsed during the execution of the blocl.
+ (CFTimeInterval)measureWithExecutionBlock:(void ( ^ ) ( void ))blockParameters
- block
A block to execute and measure the elapsed time during execution.
Return Value
A time interval equal to the total time elapsed during execution.
Declared In
RKBenchmark.hInstance Methods
initWithName:
Initializes a new benchmark object with a name.
- (id)initWithName:(NSString *)nameParameters
- name
The name to initialize the receiver with.
Return Value
The receiver, initialized with the given name.
Declared In
RKBenchmark.hlog
Logs the current benchmark status. If the receiver has been stopped, the elapsed time of the benchmark is logged. If the benchmark is still running, the total time since the benchmark was started is logged.
- (void)logDeclared In
RKBenchmark.h