FMIceLinkManagedTimer Class Reference

Inherits from NSObject
Declared in FMIceLinkManagedTimer.h
FMIceLinkManagedTimer.m

Overview

A managed timer that will tick on intervals. Might catchup if callback takes too long.

– initWithInterval:callback:

Creates a new instance of the managed timer.
- (instancetype)initWithInterval:(int)interval callback:(FMIceLinkAction0 *)callback

Parameters

interval

The millisecond interval to tick on.

callback

The callback to use when a tick occurs.

Discussion

Creates a new instance of the managed timer.

Declared In

FMIceLinkManagedTimer.h

– interval

Gets the interval that the timer will tick on.
- (int)interval

Discussion

Gets the interval that the timer will tick on.

Declared In

FMIceLinkManagedTimer.h

+ managedTimerWithInterval:callback:

Creates a new instance of the managed timer.
+ (FMIceLinkManagedTimer *)managedTimerWithInterval:(int)interval callback:(FMIceLinkAction0 *)callback

Parameters

interval

The millisecond interval to tick on.

callback

The callback to use when a tick occurs.

Discussion

Creates a new instance of the managed timer.

Declared In

FMIceLinkManagedTimer.h

+ perSecondIntervalWithTimesPerSecond:

Calculates a [interval](#//api/name/interval) based on how many times you want the timer to tick per second.
+ (int)perSecondIntervalWithTimesPerSecond:(int)timesPerSecond

Parameters

timesPerSecond

The amount of times to tick per second.

Discussion

Calculates a [interval](#//api/name/interval) based on how many times you want the timer to tick per second.

Declared In

FMIceLinkManagedTimer.h

– running

Gets whether the timer is running.
- (bool)running

Discussion

Gets whether the timer is running.

Declared In

FMIceLinkManagedTimer.h

– start

Starts the timer.
- (bool)start

Return Value

false if the timer was already started; otherwise, true.

Discussion

Starts the timer.

Declared In

FMIceLinkManagedTimer.h

– stop

Stops the timer.
- (bool)stop

Return Value

false if the timer was already stopped; otherwise, true.

Discussion

Stops the timer.

Declared In

FMIceLinkManagedTimer.h

– stopAsync

Stops the timer.
- (FMIceLinkFuture<id> *)stopAsync

Return Value

false if the timer was already stopped; otherwise, true.

Discussion

Stops the timer.

Declared In

FMIceLinkManagedTimer.h