Whiteboard.h

Go to the documentation of this file.

/*
 *  Whiteboard.h
 *  
 *  Created by René Hexel on 21/12/11.
 *  Copyright (c) 2011, 2012, 2013, 2014, 2015, 2019 Rene Hexel.
 *  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials
 *    provided with the distribution.
 *
 * 3. All advertising materials mentioning features or use of this
 *    software must display the following acknowledgement:
 *
 *        This product includes software developed by Rene Hexel.
 *
 * 4. Neither the name of the author nor the names of contributors
 *    may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * -----------------------------------------------------------------------
 * This program is free software; you can redistribute it and/or
 * modify it under the above terms or under the terms of the GNU
 * General Public License as published by the Free Software Foundation;
 * either version 2 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see http://www.gnu.org/licenses/
 * or write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA  02110-1301, USA.
 *
 */
#ifndef gusimplewhiteboard_Whiteboard_h
#define gusimplewhiteboard_Whiteboard_h
 
#include <dispatch/dispatch.h>
#include <string>
#include <vector>
#include <iostream>
#include <gu_util.h>
#include "gusimplewhiteboard.h"
#include "WhiteboardConstants.h"
#include "WBFunctor.h"
#include "WBMsg.h"
 
#ifndef FROM_WHITEBOARD_CC_
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wpedantic"
#pragma clang diagnostic warning "-W#warnings"
 
#pragma warning using deprecated whiteboard version
 
#pragma clang diagnostic pop
#else
#pragma message "************************************************************"
#pragma message "*** using deprecated whiteboard version " __FILE__ "***"
#pragma message "************************************************************"
#endif
#endif // FROM_WHITEBOARD_CC_
 
#ifdef WHITEBOARD_OLD_H
#error *** Error: attempt to mix old and simple Whiteboard!
#endif
#ifdef _BOOST_WHITEBOARD_H_
#error *** Error: attempt to mix boost and simple Whiteboard!
#endif
 
#define NEW_MSG_ID -1
#define GLOBAL_MSG_ID 0
 
namespace guWhiteboard 
{
        typedef struct gsw_hash_info
        {
            gsw_hash_info() { msg_offset = NEW_MSG_ID; }    
            gsw_hash_info(int offset) { msg_offset = offset; }                
            int msg_offset; 
        } gsw_hash_info;
    
        class Whiteboard
        {
        public:
                struct callback_descr
                {
                        int type;                       
                        int current;                    
                        WBFunctorBase *func;            
 
                        callback_descr(WBFunctorBase *f, int t = -1, int o = -1): type(t), current(o), func(f) {}
                };
        private:
                dispatch_group_t callback_group;        
                dispatch_queue_t callback_queue;        
                std::vector<callback_descr> _sub;       
                u_int8_t cball_indexes[GSW_TOTAL_MESSAGE_TYPES];        
 
                int getTypeOffset_private(std::string type);
        public:
                gu_simple_whiteboard_descriptor *_wbd;  
                Whiteboard(const char *sharedMemoryObjectName = gsw_global_whiteboard_name, bool checkVersion = true, int number = 0);
 
                virtual ~Whiteboard();           
 
                void addMessage(gsw_hash_info *hashinfo, const WBMsg &msg, bool nonatomic=false, bool notifySubscribers=true);            
 
        typedef enum wb_method_result
        {
            METHOD_OK,      
            METHOD_FAIL     
        } WBResult;
            
                WBMsg getMessage(gsw_hash_info *hashinfo, WBResult *result = NULLPTR);
            
                void subscriptionCallback(void);
                
                virtual void subscribeToMessage(gsw_hash_info *hashinfo, WBFunctorBase *func, WBResult &result);
                
                void unsubscribeToMessage(gsw_hash_info *hashinfo, WBResult &result);            
                
                gsw_hash_info *getTypeOffset(std::string type);            
                
                static WBMsg getWBMsg(gu_simple_message *m)
                {
                    switch (m->wbmsg.type)
                    {
                        case WBMsg::TypeBool:
                            return WBMsg(static_cast<bool>(m->sint));
                            
                        case WBMsg::TypeInt:
                            return WBMsg(m->sint);
                            
                        case WBMsg::TypeFloat:
                            return WBMsg(m->sfloat);
                            
                        case WBMsg::TypeString:
                            return WBMsg(m->wbmsg.data);
                            
                        case WBMsg::TypeBinary:
                            return WBMsg(m->wbmsg.data, m->wbmsg.len);
                            
                        case WBMsg::TypeArray:
                        {
                            std::vector<int> *v = new std::vector<int>();
                            for (int i = 0; i < m->wbmsg.len; i++)
                                v->push_back(m->ivec[i]);
                            return WBMsg(v, true);
                        }
                        default:
                            return WBMsg();
                    }
                    /* NOTREACHED */
                }                     
    
            
            
            
            
            
                void addMessage(const std::string &type, const WBMsg &msg, bool nonatomic=false, bool notifySubscribers=true);
                
                WBMsg getMessage(std::string type, WBResult *result = NULLPTR);
            
            
        virtual void subscribeToMessage(const std::string &type, WBFunctorBase *func, WBResult &result);
 
        void unsubscribeToMessage(std::string type, WBResult &result);
            
        };       
}
 
#endif