System::Threading::Timer Class Reference

Timer class that executes job item in separate thread after delay. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

#include <timer.h>

Inherits System::Object.

Public Member Functions
	Timer (TimerCallback callback)
	Constructor. More...
	Timer (TimerCallback callback, const System::SharedPtr< System::Object > &state, int64_t dueTime, int64_t period)
	Constructor. More...
	Timer (TimerCallback callback, const System::SharedPtr< System::Object > &state, System::TimeSpan dueTime, System::TimeSpan period)
	Constructor. More...
bool	Change (int64_t dueTime, int64_t period)
	Re-schedules or cancels timer. More...
bool	Change (System::TimeSpan dueTime, System::TimeSpan period)
	Re-schedules or cancels timer. More...
void	Dispose ()
	De-schedules timer. More...
Public Member Functions inherited from System::Object
	Object ()
	Creates object. Initializes all internal data structures. More...
virtual	~Object ()
	Destroys object. Frees all internal data structures. More...
	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...
Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...
int	SharedCount () const
	Gets current value of shared reference counter. More...
void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...
virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...
virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...
template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...
template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

Protected Member Functions
	~Timer () override
	Destructor. More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...
Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...
static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...
template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

Detailed Description

Timer class that executes job item in separate thread after delay. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

#include "system/threading/thread.h"
#include "system/threading/timer.h"
#include "system/object.h"
#include "system/smart_ptr.h"
#include <iostream>
 
int main()
{
  using namespace System::Threading;
 
  auto number = 0;
  auto timer = System::MakeObject<Timer>([&number](System::SharedPtr<System::Object> object) -> void {
    std::cout << ++number << std::endl;
  }, nullptr, 0, 200);
 
  Thread::Sleep(1000);
  timer->Dispose();
 
  return 0;
}
/*
This code example produces the following output:
1
2
3
4
5
*/

Constructor & Destructor Documentation

Timer() [1/3]

System::Threading::Timer::Timer

(

TimerCallback

callback

)

Constructor.

Parameters

callback

Function to be called by the timer.

Timer() [2/3]

System::Threading::Timer::Timer	(	TimerCallback	callback,
		const System::SharedPtr< System::Object > &	state,
		int64_t	dueTime,
		int64_t	period
	)

Constructor.

Parameters

callback	Function to be called by the timer.
state	Callback function argument.
dueTime	Timeout before first invocation of callback function, in milliseconds; negative values doesn't schedule timer after creation so it can be re-scheduled later.
period	Timeout between consequental invocations of callback function, in milliseconds; non-positive values mean that timer should only be executed once.

Timer() [3/3]

System::Threading::Timer::Timer	(	TimerCallback	callback,
		const System::SharedPtr< System::Object > &	state,
		System::TimeSpan	dueTime,
		System::TimeSpan	period
	)

Constructor.

Parameters

callback	Function to be called by the timer.
state	Callback function argument.
dueTime	Timeout before first invocation of callback function; negative values doesn't schedule timer after creation so it can be re-scheduled later.
period	Timeout between consequental invocations of callback function; non-positive values mean that timer should only be executed once.

~Timer()

System::Threading::Timer::~Timer ( )

overrideprotected

Destructor.

Member Function Documentation

Change() [1/2]

bool System::Threading::Timer::Change	(	int64_t	dueTime,
		int64_t	period
	)

Re-schedules or cancels timer.

Parameters

dueTime	Timeout before next invocation of callback function, in milliseconds; negative values cancel timer even if it was scheduled.
period	Timeout between consequental invocations of callback function, in milliseconds; non-positive values mean that timer should only be executed once.

Change() [2/2]

bool System::Threading::Timer::Change	(	System::TimeSpan	dueTime,
		System::TimeSpan	period
	)

Re-schedules or cancels timer.

Parameters

dueTime	Timeout before next invocation of callback function; negative values cancel timer even if it was scheduled.
period	Timeout between consequental invocations of callback function; non-positive values mean that timer should only be executed once.

Dispose()

void System::Threading::Timer::Dispose

(

)

De-schedules timer.