thread.hpp 4.11 KB
Newer Older
Martin Sustrik's avatar
Martin Sustrik committed
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
Martin Sustrik's avatar
Martin Sustrik committed
3

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
Martin Sustrik's avatar
Martin Sustrik committed
5

6 7 8
    libzmq is free software; you can redistribute it and/or modify it under
    the terms of the GNU Lesser General Public License (LGPL) as published
    by the Free Software Foundation; either version 3 of the License, or
Martin Sustrik's avatar
Martin Sustrik committed
9 10
    (at your option) any later version.

11 12 13 14 15 16 17 18 19 20 21 22 23 24
    As a special exception, the Contributors give you permission to link
    this library with independent modules to produce an executable,
    regardless of the license terms of these independent modules, and to
    copy and distribute the resulting executable under terms of your choice,
    provided that you also meet, for each linked independent module, the
    terms and conditions of the license of that module. An independent
    module is a module which is not derived from or based on this library.
    If you modify this library, you must extend this exception to your
    version of the library.

    libzmq 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 Lesser General Public
    License for more details.
Martin Sustrik's avatar
Martin Sustrik committed
25

26
    You should have received a copy of the GNU Lesser General Public License
Martin Sustrik's avatar
Martin Sustrik committed
27 28 29
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

Martin Sustrik's avatar
Martin Sustrik committed
30 31
#ifndef __ZMQ_THREAD_HPP_INCLUDED__
#define __ZMQ_THREAD_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
32

33 34 35 36
#if defined ZMQ_HAVE_VXWORKS
#include <vxWorks.h>
#include <taskLib.h>
#elif !defined ZMQ_HAVE_WINDOWS
Martin Sustrik's avatar
Martin Sustrik committed
37 38
#include <pthread.h>
#endif
39
#include <set>
Martin Sustrik's avatar
Martin Sustrik committed
40

Martin Sustrik's avatar
Martin Sustrik committed
41
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
42
{
43
typedef void(thread_fn) (void *);
Martin Sustrik's avatar
Martin Sustrik committed
44

45 46 47 48 49 50
//  Class encapsulating OS thread. Thread initiation/termination is done
//  using special functions rather than in constructor/destructor so that
//  thread isn't created during object construction by accident, causing
//  newly created thread to access half-initialised object. Same applies
//  to the destruction process: Thread should be terminated before object
//  destruction begins, otherwise it can access half-destructed object.
Martin Sustrik's avatar
Martin Sustrik committed
51

52 53 54 55 56 57
class thread_t
{
  public:
    inline thread_t () :
        tfn (NULL),
        arg (NULL),
58
        started (false),
59 60
        thread_priority (ZMQ_THREAD_PRIORITY_DFLT),
        thread_sched_policy (ZMQ_THREAD_SCHED_POLICY_DFLT)
Martin Sustrik's avatar
Martin Sustrik committed
61
    {
62
    }
Martin Sustrik's avatar
Martin Sustrik committed
63

64 65 66 67 68 69 70 71 72
#ifdef ZMQ_HAVE_VXWORKS
    ~thread_t ()
    {
        if (descriptor != NULL || descriptor > 0) {
            taskDelete (descriptor);
        }
    }
#endif

73 74 75
    //  Creates OS thread. 'tfn' is main thread function. It'll be passed
    //  'arg' as an argument.
    void start (thread_fn *tfn_, void *arg_);
Martin Sustrik's avatar
Martin Sustrik committed
76

77 78 79 80 81 82 83
    //  Returns whether the thread was started, i.e. start was called.
    bool get_started () const;

    //  Returns whether the executing thread is the thread represented by the
    //  thread object.
    bool is_current_thread () const;

84 85
    //  Waits for thread termination.
    void stop ();
86

87 88 89
    // Sets the thread scheduling parameters. Only implemented for
    // pthread. Has no effect on other platforms.
    void setSchedulingParameters (int priority_,
90
                                  int scheduling_policy_,
91
                                  const std::set<int> &affinity_cpus_);
92

93 94 95
    // Sets the thread name, 16 characters max including terminating NUL.
    // Only implemented for pthread. Has no effect on other platforms.
    void setThreadName (const char *name_);
96

97 98 99 100 101
    //  These are internal members. They should be private, however then
    //  they would not be accessible from the main C routine of the thread.
    void applySchedulingParameters ();
    thread_fn *tfn;
    void *arg;
Martin Sustrik's avatar
Martin Sustrik committed
102

103
  private:
104 105
    bool started;

Martin Sustrik's avatar
Martin Sustrik committed
106
#ifdef ZMQ_HAVE_WINDOWS
107
    HANDLE descriptor;
108 109 110 111 112 113 114 115
#elif defined ZMQ_HAVE_VXWORKS
    int descriptor;
    enum
    {
        DEFAULT_PRIORITY = 100,
        DEFAULT_OPTIONS = 0,
        DEFAULT_STACK_SIZE = 4000
    };
Martin Sustrik's avatar
Martin Sustrik committed
116
#else
117
    pthread_t descriptor;
Martin Sustrik's avatar
Martin Sustrik committed
118 119
#endif

120 121 122 123
    //  Thread scheduling parameters.
    int thread_priority;
    int thread_sched_policy;
    std::set<int> thread_affinity_cpus;
Martin Sustrik's avatar
Martin Sustrik committed
124

125 126 127
    thread_t (const thread_t &);
    const thread_t &operator= (const thread_t &);
};
Martin Sustrik's avatar
Martin Sustrik committed
128 129 130
}

#endif