RemoteContextClient.h

Go to the documentation of this file.

//=============================================================================
//  Computational Process Networks class library
//  Copyright (C) 1997-2006  Gregory E. Allen and The University of Texas
//
//  This library is free software; you can redistribute it and/or modify it
//  under the terms of the GNU Library General Public License as published
//  by the Free Software Foundation; either version 2 of the License, or
//  (at your option) any later version.
//
//  This library 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
//  Library General Public License for more details.
//
//  The GNU Public License is available in the file LICENSE, or you
//  can write to the Free Software Foundation, Inc., 59 Temple Place -
//  Suite 330, Boston, MA 02111-1307, USA, or you can find it on the
//  World Wide Web at http://www.fsf.org.
//=============================================================================
#ifndef CPN_REMOTECONTEXTCLIENT_H
#define CPN_REMOTECONTEXTCLIENT_H
#pragma once

#include <cpn/common.h>
#include <cpn/remote_context/RCTXMT.h>
#include <cpn/Context.h>
#include <cpn/QueueAttr.h>
#include <cpn/NodeAttr.h>
#include <cpn/threading/PthreadMutex.h>
#include <cpn/threading/PthreadCondition.h>
#include <Variant/Variant.h>
#include <list>

class Pthread;

namespace CPN {

    class RemoteContextClient : public Context {
    public:
        virtual ~RemoteContextClient();

        virtual int LogLevel() const;
        virtual int LogLevel(int level);
        virtual void Log(int level, const std::string &logmsg);

        virtual CPN::Key_t SetupKernel(const std::string &name, const std::string &hostname,
                const std::string &servname, CPN::KernelBase *kernel);
        virtual CPN::Key_t SetupKernel(const std::string &name, KernelBase *kernel) { ASSERT(false, "RemoteContextClient requires remote operation is turned on."); }
        virtual CPN::Key_t GetKernelKey(const std::string &kernel);
        virtual std::string GetKernelName(CPN::Key_t kernelkey);
        virtual void GetKernelConnectionInfo(CPN::Key_t kernelkey, std::string &hostname, std::string &servname);
        virtual CPN::Key_t WaitForKernelStart(const std::string &kernel);
        virtual void SignalKernelStart(CPN::Key_t kernelkey);
        virtual void SignalKernelEnd(CPN::Key_t kernelkey);

        virtual void SendCreateWriter(CPN::Key_t kernelkey, const CPN::SimpleQueueAttr &attr);
        virtual void SendCreateReader(CPN::Key_t kernelkey, const CPN::SimpleQueueAttr &attr);
        virtual void SendCreateQueue(CPN::Key_t kernelkey, const CPN::SimpleQueueAttr &attr);
        virtual void SendCreateNode(CPN::Key_t kernelkey, const CPN::NodeAttr &attr);

        virtual CPN::Key_t CreateNodeKey(CPN::Key_t kernelkey, const std::string &nodename);
        virtual CPN::Key_t GetNodeKey(const std::string &nodename);
        virtual std::string GetNodeName(CPN::Key_t nodekey);
        virtual CPN::Key_t GetNodeKernel(CPN::Key_t nodekey);
        virtual void SignalNodeStart(CPN::Key_t nodekey);
        virtual void SignalNodeEnd(CPN::Key_t nodekey);

        virtual CPN::Key_t WaitForNodeStart(const std::string &nodename);
        virtual void WaitForNodeEnd(const std::string &nodename);
        virtual void WaitForAllNodeEnd();


        virtual CPN::Key_t GetCreateReaderKey(CPN::Key_t nodekey, const std::string &portname);
        virtual CPN::Key_t GetReaderNode(CPN::Key_t portkey);
        virtual CPN::Key_t GetReaderKernel(CPN::Key_t portkey);
        virtual std::string GetReaderName(CPN::Key_t portkey);

        virtual CPN::Key_t GetCreateWriterKey(CPN::Key_t nodekey, const std::string &portname);
        virtual CPN::Key_t GetWriterNode(CPN::Key_t portkey);
        virtual CPN::Key_t GetWriterKernel(CPN::Key_t portkey);
        virtual std::string GetWriterName(CPN::Key_t portkey);

        virtual void ConnectEndpoints(CPN::Key_t writerkey, CPN::Key_t readerkey, const std::string &qname);
        virtual CPN::Key_t GetReadersWriter(CPN::Key_t readerkey);
        virtual CPN::Key_t GetWritersReader(CPN::Key_t writerkey);

        virtual void Terminate();
        virtual bool IsTerminated();

        virtual bool RequireRemote();

        void DispatchMessage(const Variant &msg);
    protected:
        RemoteContextClient();
        virtual void SendMessage(const Variant &msg) = 0;

        mutable PthreadMutex lock;
    private:

        struct WaiterInfo {
            WaiterInfo(unsigned wid) : waiterid(wid), signaled(false) {}
            unsigned waiterid;
            PthreadCondition cond;
            bool signaled;
            Variant msg;
        };

        struct GenericWaiter {
            PthreadCondition cond;
            std::list<Variant> messages;
        };
        typedef shared_ptr<GenericWaiter> GenericWaiterPtr;

        void SendQueueMsg(CPN::Key_t kernelkey, RCTXMT_t msgtype, const CPN::SimpleQueueAttr &attr);
        unsigned NewTranID();
        void AddWaiter(WaiterInfo *info);
        GenericWaiterPtr NewGenericWaiter();
        void InternalTerminate();
        void InternalCheckTerminated();
        void *TerminateThread();
        Variant RemoteCall(Variant msg);

        CPN::Key_t GetCreateEndpointKey(RCTXMT_t msgtype, CPN::Key_t nodekey, const std::string &portname);
        Variant GetEndpointInfo(RCTXMT_t msgtype, CPN::Key_t portkey);

        auto_ptr<Pthread> terminateThread;
        typedef std::map<unsigned, WaiterInfo*> WaiterMap;
        WaiterMap callwaiters;
        typedef std::list<weak_ptr<GenericWaiter> > WaiterList;
        WaiterList waiters;
        typedef std::map<CPN::Key_t, CPN::KernelBase*> KernelMap;
        KernelMap kernels;
        unsigned trancounter;
        bool shutdown;
        int loglevel;
    };
}
#endif