Orocos Real-Time Toolkit  2.6.0
ConnPolicy.hpp
00001 /***************************************************************************
00002   tag: Peter Soetens  Thu Oct 22 11:59:08 CEST 2009  ConnPolicy.hpp
00003 
00004                         ConnPolicy.hpp -  description
00005                            -------------------
00006     begin                : Thu October 22 2009
00007     copyright            : (C) 2009 Peter Soetens
00008     email                : peter@thesourcworks.com
00009 
00010  ***************************************************************************
00011  *   This library is free software; you can redistribute it and/or         *
00012  *   modify it under the terms of the GNU General Public                   *
00013  *   License as published by the Free Software Foundation;                 *
00014  *   version 2 of the License.                                             *
00015  *                                                                         *
00016  *   As a special exception, you may use this file as part of a free       *
00017  *   software library without restriction.  Specifically, if other files   *
00018  *   instantiate templates or use macros or inline functions from this     *
00019  *   file, or you compile this file and link it with other files to        *
00020  *   produce an executable, this file does not by itself cause the         *
00021  *   resulting executable to be covered by the GNU General Public          *
00022  *   License.  This exception does not however invalidate any other        *
00023  *   reasons why the executable file might be covered by the GNU General   *
00024  *   Public License.                                                       *
00025  *                                                                         *
00026  *   This library is distributed in the hope that it will be useful,       *
00027  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00028  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00029  *   Lesser General Public License for more details.                       *
00030  *                                                                         *
00031  *   You should have received a copy of the GNU General Public             *
00032  *   License along with this library; if not, write to the Free Software   *
00033  *   Foundation, Inc., 59 Temple Place,                                    *
00034  *   Suite 330, Boston, MA  02111-1307  USA                                *
00035  *                                                                         *
00036  ***************************************************************************/
00037 
00038 
00039 #ifndef ORO_CONN_POLICY_HPP
00040 #define ORO_CONN_POLICY_HPP
00041 
00042 #include <string>
00043 #include "rtt-fwd.hpp"
00044 #include "rtt-config.h"
00045 
00046 namespace RTT {
00047 
00090     class RTT_API ConnPolicy
00091     {
00092     public:
00093         static const int DATA   = 0;
00094         static const int BUFFER = 1;
00095         static const int CIRCULAR_BUFFER = 2;
00096 
00097         static const int UNSYNC    = 0;
00098         static const int LOCKED    = 1;
00099         static const int LOCK_FREE = 2;
00100 
00109         static ConnPolicy buffer(int size, int lock_policy = LOCK_FREE, bool init_connection = false, bool pull = false);
00110 
00119         static ConnPolicy circularBuffer(int size, int lock_policy = LOCK_FREE, bool init_connection = false, bool pull = false);
00120 
00128         static ConnPolicy data(int lock_policy = LOCK_FREE, bool init_connection = true, bool pull = false);
00129 
00138         explicit ConnPolicy(int type = DATA, int lock_policy = LOCK_FREE);
00139 
00141         int    type;
00147         bool   init;
00149         int    lock_policy;
00154         bool   pull;
00156         int    size;
00161         int    transport;
00162 
00171         mutable int    data_size;
00172 
00179         mutable std::string name_id;
00180     };
00181 }
00182 
00183 #endif
00184