include/xdispatch/queue.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_QUEUE_H_
#define XDISPATCH_QUEUE_H_

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

#include <iostream>

__XDISPATCH_BEGIN_NAMESPACE

class XDISPATCH_EXPORT queue {

public:
    queue(dispatch_queue_t);
    queue(const char* label);
    queue(const std::string&);
    queue(const queue&);
    ~queue();

    virtual void async(operation*);
#ifdef XDISPATCH_HAS_BLOCKS

    virtual void async(dispatch_block_t);
#endif

    virtual void apply(iteration_operation*, size_t times);
#ifdef XDISPATCH_HAS_BLOCKS

    virtual void apply(dispatch_iteration_block_t, size_t times);
#endif

    virtual void after(operation*, struct tm* time);
    virtual void after(operation*, dispatch_time_t time);
#ifdef XDISPATCH_HAS_BLOCKS

    virtual void after(dispatch_block_t, struct tm* time);
    virtual void after(dispatch_block_t, dispatch_time_t time);
#endif

    virtual void sync(operation*);
#ifdef XDISPATCH_HAS_BLOCKS

    virtual void sync(dispatch_block_t);
#endif

    virtual void set_finalizer(operation*, const queue& = global_queue());
#ifdef XDISPATCH_HAS_BLOCKS

    virtual void set_finalizer(dispatch_block_t, const queue& = global_queue());
#endif

    virtual const std::string label() const;
    virtual void suspend();
    virtual void resume();
    virtual const dispatch_queue_t native() const;

private:
    class data;
    data* d;

};

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

bool operator ==(const queue& a, const queue& b);
bool operator ==(const queue& a, const dispatch_queue_t& b);
bool operator ==(const dispatch_queue_t& a, const queue& b);

__XDISPATCH_END_NAMESPACE

#endif /* XDISPATCH_QUEUE_H_ */