queue.h

Go to the documentation of this file.

/*
* Copyright (c) 2011-2012 MLBA-Team. 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 object {

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

        void async(operation*);
    #if XDISPATCH_HAS_BLOCKS

        inline void async(dispatch_block_t b) {
            async( new block_operation(b) );
        }
    #endif
    #if XDISPATCH_HAS_FUNCTION

        inline void async(const lambda_function& b) {
            async( new function_operation(b) );
        }
    #endif

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

        inline void apply(dispatch_iteration_block_t b, size_t times) {
            apply( new block_iteration_operation(b), times );
        }
    #endif
    #if XDISPATCH_HAS_FUNCTION

        inline void apply(const iteration_lambda_function& b, size_t times) {
            apply( new function_iteration_operation(b), times );
        }
    #endif

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

        inline void after(dispatch_block_t b, struct tm* time) {
            after( new block_operation(b), time );
        }
        inline void after(dispatch_block_t b, dispatch_time_t time) {
            after( new block_operation(b), time );
        }
    #endif
    #if XDISPATCH_HAS_FUNCTION

        inline void after(const lambda_function& b, struct tm* time) {
            after( new function_operation(b), time );
        }
        inline void after(const lambda_function& b, dispatch_time_t time) {
            after( new function_operation(b), time );
        }
    #endif

        void sync(operation*);
    #if XDISPATCH_HAS_BLOCKS

        inline void sync(dispatch_block_t b) {
            sync( new block_operation(b) );
        }
    #endif
    #if XDISPATCH_HAS_FUNCTION

        inline void sync(const lambda_function& b) {
            sync( new function_operation(b) );
        }
    #endif

        void finalizer(operation*, const queue& = global_queue());
    #if XDISPATCH_HAS_BLOCKS

        inline void finalizer(dispatch_block_t b, const queue& q = global_queue()) {
            finalizer( new block_operation(b), q );
        }
    #endif
    #if XDISPATCH_HAS_FUNCTION

        inline void finalizer(const lambda_function& b, const queue& q = global_queue()) {
            finalizer( new function_operation(b), q );
        }
    #endif

        const std::string& label() const;
        virtual dispatch_object_t native() const;
        virtual dispatch_queue_t native_queue() const;

        queue& operator= (const queue&);

    private:
        class data;
        pointer<data>::unique d;

};

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

__XDISPATCH_END_NAMESPACE

#endif /* XDISPATCH_QUEUE_H_ */