/* * 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. * */ namespace Tizen.NUI { using System; using System.Runtime.InteropServices; /// /// 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.
///
public class Timer : BaseHandle { private global::System.Runtime.InteropServices.HandleRef swigCPtr; internal Timer(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.Timer_SWIGUpcast(cPtr), cMemoryOwn) { swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr); } 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; } /// /// Dispose. /// /// 3 protected override void Dispose(DisposeTypes type) { if(disposed) { return; } if(type == DisposeTypes.Explicit) { //Called by User //Release your own managed resources here. //You should release all of your own disposable objects here. } //Release your own unmanaged resources here. //You should not access any managed member here except static instance. //because the execution order of Finalizes is non-deterministic. if (_timerTickCallbackDelegate != null) { TickSignal().Disconnect(_timerTickCallbackDelegate); } if (swigCPtr.Handle != global::System.IntPtr.Zero) { if (swigCMemOwn) { swigCMemOwn = false; NDalicPINVOKE.delete_Timer(swigCPtr); } swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero); } base.Dispose(type); } /// /// Event arguments that passed via the tick event. /// public class TickEventArgs : EventArgs { } [UnmanagedFunctionPointer(CallingConvention.StdCall)] private delegate bool TickCallbackDelegate(IntPtr data); private EventHandlerWithReturnType _timerTickEventHandler; private TickCallbackDelegate _timerTickCallbackDelegate; /// /// @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) { _timerTickCallbackDelegate = (OnTick); TickSignal().Connect(_timerTickCallbackDelegate); } _timerTickEventHandler += value; } remove { _timerTickEventHandler -= value; if (_timerTickEventHandler == null && TickSignal().Empty() == false) { TickSignal().Disconnect(_timerTickCallbackDelegate); } } } private bool OnTick(IntPtr data) { TickEventArgs e = new TickEventArgs(); if (_timerTickEventHandler != null) { //here we send all data to user event handlers return _timerTickEventHandler(this, e); } return false; } /// /// Creates a tick timer that emits periodic signal. /// /// Interval in milliseconds. /// A new timer. /// 3 public Timer(uint milliSec) : this(NDalicPINVOKE.Timer_New(milliSec), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal Timer(Timer timer) : this(NDalicPINVOKE.new_Timer__SWIG_1(Timer.getCPtr(timer)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// /// [Obsolete("Please do not use! this will be deprecated")] /// /// 3 [Obsolete("Please do not use! this will be deprecated")] public static Timer DownCast(BaseHandle handle) { Timer ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as Timer; if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } /// /// Starts the timer.
/// In case a timer is already running, its time is reset and the timer is restarted.
///
/// 3 public void Start() { NDalicPINVOKE.Timer_Start(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// /// Stops the timer. /// /// 3 public void Stop() { NDalicPINVOKE.Timer_Stop(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// /// Gets/Sets the interval of the timer. /// /// 4 public uint Interval { get { return GetInterval(); } set { SetInterval(value); } } /// /// Sets a new interval on the timer and starts the timer.
/// Cancels the previous timer.
///
/// MilliSec interval in milliseconds. internal void SetInterval(uint milliSec) { NDalicPINVOKE.Timer_SetInterval(swigCPtr, milliSec); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal uint GetInterval() { uint ret = NDalicPINVOKE.Timer_GetInterval(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } /// /// Tells whether the timer is running. /// /// Whether the timer is started or not. /// 3 public bool IsRunning() { bool ret = NDalicPINVOKE.Timer_IsRunning(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } internal TimerSignalType TickSignal() { TimerSignalType ret = new TimerSignalType(NDalicPINVOKE.Timer_TickSignal(swigCPtr), false); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } } }