/*
 * -*- coding: utf-8 -*- {{{
 * vim: set fenc=utf-8 ft=python sw=4 ts=4 sts=4 et:
 *
 * Copyright 2018, Kisensum.
 *
 * 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.
 *
 * Neither Kisensum, nor any of its employees, nor any jurisdiction or
 * organization that has cooperated in the development of these materials,
 * makes any warranty, express or implied, or assumes any legal liability
 * or responsibility for the accuracy, completeness, or usefulness or any
 * information, apparatus, product, software, or process disclosed, or
 * represents that its use would not infringe privately owned rights.
 * Reference herein to any specific commercial product, process, or service
 * by trade name, trademark, manufacturer, or otherwise does not necessarily
 * constitute or imply its endorsement, recommendation, or favoring by Kisensum.
 * }}}
 */

#ifndef PYDNP3_OPENPAL_EXECUTOR_TIMERREF_H
#define PYDNP3_OPENPAL_EXECUTOR_TIMERREF_H

#include <pybind11/pybind11.h>
#include <Python.h>

#include <openpal/executor/TimerRef.h>

#ifdef PYDNP3_OPENPAL

namespace py = pybind11;

void bind_TimerRef(py::module &m)
{
    // ----- class: openpal::TimerRef -----
    py::class_<openpal::TimerRef>(m, "TimerRef",
        "A management class to make dealing with timer pointers safer a little safer. \n"
        "Holds an optional pointer to an active ITimer pointer. \n"
        "Acts as a safe proxy for dealing with a recurring timer instance.")

        .def(
            py::init<openpal::IExecutor&>(),
            py::arg("executor"),
            py::return_value_policy::reference
        )

        .def(
            "IsActive",
            &openpal::TimerRef::IsActive,
            "Called to see if the timer is currently active."
        )

        .def(
            "ExpiresAt",
            &openpal::TimerRef::ExpiresAt,
            ":return: the expiration time, MonotonticTimestamp::Max() if not active"
        )

        .def(
            "Cancel",
            &openpal::TimerRef::Cancel,
            "   Cancels any existing timer. \n"
            ":return: true if the timer was active, false otherwise"
        );
}

#endif // PYDNP3_OPENPAL
#endif
