/* * Copyright(c) 2017 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * */ using System; using System.Runtime.InteropServices; using System.ComponentModel; using System.Threading; using System.Diagnostics; namespace Tizen.NUI { /// /// Mechanism to issue simple periodic or one-shot events.
/// Timer is provided for application developers to be able to issue /// simple periodic or one-shot events. Please note that the timer /// callback functions should return as soon as possible because they /// block the next SignalTick. Please note that timer signals are not /// in sync with DALi's render timer.
/// This class is a handle class so it can be stack allocated and used /// as a member.
///
/// 3 public class Timer : BaseHandle { private bool played = false; private EventHandlerWithReturnType _timerTickEventHandler; private TickCallbackDelegate _timerTickCallbackDelegate; private System.IntPtr _timerTickCallbackOfNative; /// /// Creates a tick timer that emits periodic signal. /// /// Interval in milliseconds. /// A new timer. /// 3 public Timer(uint milliSec) : this(Interop.Timer.New(milliSec), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); NUILog.Debug($"(0x{swigCPtr.Handle:X}) Timer({milliSec}) Constructor!"); } internal Timer(Timer timer) : this(Interop.Timer.NewTimer(Timer.getCPtr(timer)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal Timer(global::System.IntPtr cPtr, bool cMemoryOwn) : base(Interop.Timer.Upcast(cPtr), cMemoryOwn) { _timerTickCallbackDelegate = OnTick; _timerTickCallbackOfNative = System.Runtime.InteropServices.Marshal.GetFunctionPointerForDelegate(_timerTickCallbackDelegate); NUILog.Debug($"(0x{swigCPtr.Handle:X})Timer() contructor!"); } /// /// Destructor. /// ~Timer() { NUILog.Debug($"(0x{swigCPtr.Handle:X})Timer() distructor!, disposed={disposed}"); } [UnmanagedFunctionPointer(CallingConvention.StdCall)] private delegate bool TickCallbackDelegate(); /// /// @brief Event for the ticked signal, which can be used to subscribe or unsubscribe the event handler /// provided by the user. The ticked signal is emitted after specified time interval.
///
/// 3 public event EventHandlerWithReturnType Tick { add { if (_timerTickEventHandler == null && disposed == false) { TickSignal().Connect(_timerTickCallbackOfNative); } _timerTickEventHandler += value; } remove { _timerTickEventHandler -= value; if (_timerTickEventHandler == null && TickSignal().Empty() == false) { TickSignal().Disconnect(_timerTickCallbackOfNative); } } } /// /// Gets/Sets the interval of the timer. /// /// For setter, this sets a new interval on the timer and starts the timer.
/// Cancels the previous timer. ///
/// 4 public uint Interval { get { return GetInterval(); } set { SetInterval(value); } } /// /// Starts the timer.
/// In case a timer is already running, its time is reset and the timer is restarted.
///
/// 3 public void Start() { if (Thread.CurrentThread.ManagedThreadId != 1) { Tizen.Log.Error("NUI", "current threadID : " + Thread.CurrentThread.ManagedThreadId); StackTrace st = new StackTrace(true); for (int i = 0; i < st.FrameCount; i++) { StackFrame sf = st.GetFrame(i); Tizen.Log.Error("NUI", " Method " + sf.GetMethod()); } } if (swigCPtr.Handle == global::System.IntPtr.Zero || disposed) { NUILog.Error("[ERR] already disposed! can not get this done! just return here! please make sure that the handle gets free when using explicit Dispose()! For example, timer.Dispose(); timer = null; this must be done!"); return; } played = true; Interop.Timer.Start(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// /// Stops the timer. /// /// 3 public void Stop() { if (Thread.CurrentThread.ManagedThreadId != 1) { Tizen.Log.Error("NUI", "current threadID : " + Thread.CurrentThread.ManagedThreadId); StackTrace st = new StackTrace(true); for (int i = 0; i < st.FrameCount; i++) { StackFrame sf = st.GetFrame(i); Tizen.Log.Error("NUI", " Method " + sf.GetMethod()); } } if (swigCPtr.Handle == global::System.IntPtr.Zero || disposed) { NUILog.Error("[ERR] already disposed! can not get this done! just return here! please make sure that the handle gets free when using explicit Dispose()! For example, timer.Dispose(); timer = null; this must be done!"); return; } played = false; Interop.Timer.Stop(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// /// Tells whether the timer is running. /// /// Whether the timer is started or not. /// 3 public bool IsRunning() { if (Thread.CurrentThread.ManagedThreadId != 1) { Tizen.Log.Error("NUI", "current threadID : " + Thread.CurrentThread.ManagedThreadId); StackTrace st = new StackTrace(true); for (int i = 0; i < st.FrameCount; i++) { StackFrame sf = st.GetFrame(i); Tizen.Log.Error("NUI", " Method " + sf.GetMethod()); } } if (swigCPtr.Handle == global::System.IntPtr.Zero || disposed) { NUILog.Error("[ERR] already disposed! can not get this done! just return here! please make sure that the handle gets free when using explicit Dispose()! For example, timer.Dispose(); timer = null; this must be done!"); return false; } bool ret = Interop.Timer.IsRunning(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } internal static global::System.Runtime.InteropServices.HandleRef getCPtr(Timer obj) { return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr; } /// /// Sets a new interval on the timer and starts the timer.
/// Cancels the previous timer.
///
/// MilliSec interval in milliseconds. internal void SetInterval(uint milliSec) { NUILog.Debug($"(0x{swigCPtr.Handle:X})SetInterval({milliSec})"); if (swigCPtr.Handle == global::System.IntPtr.Zero || disposed) { NUILog.Error("[ERR] already disposed! can not get this done! just return here! please make sure that the handle gets free when using explicit Dispose()! For example, timer.Dispose(); timer = null; this must be done!"); return; } played = true; Interop.Timer.SetInterval(swigCPtr, milliSec); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal uint GetInterval() { if (swigCPtr.Handle == global::System.IntPtr.Zero || disposed) { NUILog.Error("[ERR] already disposed! can not get this done! just return here! please make sure that the handle gets free when using explicit Dispose()! For example, timer.Dispose(); timer = null; this must be done!"); return 0; } uint ret = Interop.Timer.GetInterval(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } internal TimerSignalType TickSignal() { TimerSignalType ret = new TimerSignalType(Interop.Timer.TickSignal(swigCPtr), false); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } /// /// Dispose. /// /// 3 protected override void Dispose(DisposeTypes type) { NUILog.Debug($"(0x{swigCPtr.Handle:X}) Timer.Dispose(type={type}, disposed={disposed})"); if (this != null && _timerTickCallbackDelegate != null) { TickSignal().Disconnect(_timerTickCallbackOfNative); } if (disposed) { return; } played = false; base.Dispose(type); } /// This will not be public opened. [EditorBrowsable(EditorBrowsableState.Never)] protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr) { Interop.Timer.DeleteTimer(swigCPtr); } private bool OnTick() { TickEventArgs e = new TickEventArgs(); if (played == false) { Tizen.Log.Fatal("NUI", $"(0x{swigCPtr.Handle:X}) OnTick() is called even played is false!"); //throw new System.InvalidOperationException($"OnTick() excpetion!"); } if (_timerTickEventHandler != null && played == true) { //here we send all data to user event handlers return _timerTickEventHandler(this, e); } return false; } /// /// Event arguments that passed via the tick event. /// /// 3 public class TickEventArgs : EventArgs { } } }