summaryrefslogtreecommitdiff
path: root/util/concurrency/msg.h
blob: 57925964939ed74ac008f99675ca4c1956a1123a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
// @file msg.h - interthread message passing

/**
*    Copyright (C) 2008 10gen Inc.
*
*    This program is free software: you can redistribute it and/or  modify
*    it under the terms of the GNU Affero General Public License, version 3,
*    as published by the Free Software Foundation.
*
*    This program is distributed in the hope that it will be useful,b
*    but WITHOUT ANY WARRANTY; without even the implied warranty of
*    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*    GNU Affero General Public License for more details.
*
*    You should have received a copy of the GNU Affero General Public License
*    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#pragma once

#include <deque>
#include "task.h"

namespace mongo { 

    namespace task { 

        /** See task::PortUnitTest in task.cpp for an example of usage.
        */
        class Port : private Task { 
        protected:
            /** implement a receiver of messages for the port. 
                @return false to stop the port / terminate the thread (i.e. you want to return true)
            */
            virtual bool got(const any& msg) = 0;
            virtual string name() = 0; // names the thread
        public:
            /** send a message to the port */
            void send(const any& msg);

            /** typical usage is: task::fork( foo.task() ); */
            shared_ptr<Task> taskPtr() { return shared_ptr<Task>(static_cast<Task*>(this)); }

            Port() { }
            virtual ~Port() { }

        private:
            void doWork();
            deque<any> d;
            boost::mutex m;
            boost::condition c;
        };

    }

}