include/xdispatch/timer.h

Go to the documentation of this file.

/*
* Copyright (c) 2011 MLBA. All rights reserved.
*
* @MLBA_OPEN_LICENSE_HEADER_START@
*
* 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.
*
* @MLBA_OPEN_LICENSE_HEADER_END@
*/


#ifndef XDISPATCH_TIMER_H_
#define XDISPATCH_TIMER_H_

#ifndef __XDISPATCH_INDIRECT__
#error "Please #include <xdispatch/dispatch.h> instead of this file directly."
#endif

#include <memory>

__XDISPATCH_BEGIN_NAMESPACE

class XDISPATCH_EXPORT timer {

public:
    timer(uint64_t interval, const xdispatch::queue& target = global_queue());
    timer(const timer&);
    timer(dispatch_source_t);
    ~timer();

    void interval(uint64_t);
    void latency(uint64_t);
    void start();
    void stop();
    void handler(xdispatch::operation*);
#ifdef XDISPATCH_HAS_BLOCKS

    void handler(dispatch_block_t);
#endif

    void set_queue(const xdispatch::queue&);
    xdispatch::queue queue();
    virtual const dispatch_source_t native() const;
    static timer* current();
    static void single_shot(dispatch_time_t, const xdispatch::queue&, xdispatch::operation*);
    static void single_shot(struct tm*, const xdispatch::queue&, xdispatch::operation*);
#ifdef XDISPATCH_HAS_BLOCKS

    static void single_shot(dispatch_time_t, const xdispatch::queue&, dispatch_block_t);
    static void single_shot(struct tm*, const xdispatch::queue&, dispatch_block_t);
#endif

private:
    class data;
    data* d;

};

XDISPATCH_EXPORT std::ostream& operator<<(std::ostream& stream, const timer*);
XDISPATCH_EXPORT std::ostream& operator<<(std::ostream& stream, const timer&);

__XDISPATCH_END_NAMESPACE

#endif /* XDISPATCH_TIMER_H_ */