Click here to Skip to main content
15,885,365 members
Articles / Programming Languages / C++

RCF - Interprocess Communication for C++

Rate me:
Please Sign up or sign in to vote.
4.94/5 (147 votes)
25 Oct 2011CPOL20 min read 4.6M   8.4K   331  
A server/client IPC framework, using the C++ preprocessor as an IDL compiler.
// uncomment to enable VLD leak detection - will automatically link to required libs
//#include "vld.h"
//#include "vldapi.h"

#include <stdexcept>
#include <string>

#include <RCF/test/TestMinimal.hpp>

#include <RCF/Idl.hpp>
#include <RCF/RcfServer.hpp>
#include <RCF/test/EndpointFactories.hpp>
#include <RCF/test/TransportFactories.hpp>
#include <RCF/util/CommandLine.hpp>

namespace Test_ErrorReporting {

    std::string makeString(std::size_t len)
    {
        std::string s;
        for (std::size_t i=0; i<len; ++i)
        {
            s += '0' + i%10;
        }
        return s;
    }

    // a class to trigger serialization errors in read or write direction
    class A
    {
    public:
        A() : a1(RCF_DEFAULT_INIT), a2(RCF_DEFAULT_INIT), a3(), mWhich(RCF_DEFAULT_INIT)
        {}

        A(int which) : a1(17), a2(18.19), a3("twenty"), mWhich(which)
        {}

        class MyException : public std::runtime_error
        {
        public:
            MyException() : std::runtime_error("MyException: no go")
            {}

            ~MyException() throw()
            {}
        };

        template<typename Archive>
        void serialize(Archive &ar, const unsigned int)
        {
            RCF_ASSERT(0); // won't be doing boost serialization in this test. TODO: maybe should?
        }

        void serialize(SF::Archive &ar, const unsigned int)
        {
            RCF_ASSERT(ar.isRead() || ar.isWrite());
            switch (mWhich)
            {
            case 0:
                ar & a1 & a2;
                break;
            case 1:
                ar & a1 & a2;
                throw MyException();
                ar & a3;
                break;
            case 2:
                ar & a3;
                break;
            default:
                RCF_ASSERT(0);
            }
        }

        int mWhich;

        int a1;
        double a2;
        std::string a3;
    };

    class MyRemoteException : public RCF::RemoteException
    {
    public:

        MyRemoteException() :
            mError(RCF_DEFAULT_INIT),
            mWhat()
        {}

        MyRemoteException(int error, const std::string &msg) :
            mError(error),
            mWhat(msg)
        {}

        ~MyRemoteException() throw()
        {}

        const char *what() const throw()
        {
            return mWhat.c_str();
        }

        int getError() const
        {
            return mError;
        }

        template<typename Archive>
        void serialize(Archive &ar, const unsigned int)
        {
            ar & mError & mWhat;
        }

    private:

        void throwCopy() const
        {
            MyRemoteException myRemoteException(*this);
            throw myRemoteException;
        }

        int mError;
        std::string mWhat;

    };

    AUTO_RUN( SF::registerBaseAndDerived( (RCF::RemoteException*) 0, (MyRemoteException*) 0) );
    AUTO_RUN( SF::registerType( (MyRemoteException*) 0, "MyRemoteException") );

    RCF_BEGIN(I_Echo, "I_Echo")
        RCF_METHOD_R1(std::string, echo, const std::string &)
        RCF_METHOD_R1(std::size_t, putString, const std::string &)
        RCF_METHOD_R1(std::string, getString, std::size_t)
        RCF_METHOD_V1(void, putA, const A &)
        RCF_METHOD_R1(A, getA, int)
        RCF_METHOD_V2(void, throwRemoteException, int, const std::string &)
        RCF_METHOD_V2(void, throwMyRemoteException, int, const std::string &)
    RCF_END(I_Echo)

    class Echo
    {
    public:
        std::string echo(const std::string &s)
        {
            sLog = s;
            return s;
        }
        static std::string sLog;

        std::size_t putString(const std::string &s)
        {
            return s.size();
        }

        std::string getString(std::size_t len)
        {
            return makeString(len);
        }

        void putA(const A &a)
        {
        }

        A getA(int which)
        {
            return A(which);
        }

        void throwRemoteException(int errorCode, const std::string &errorString)
        {
            throw RCF::RemoteException(errorCode, errorString);
        }

        void throwMyRemoteException(int errorCode, const std::string &errorString)
        {
            throw MyRemoteException(errorCode, errorString);
        }
    };

    std::string Echo::sLog;

} // namespace Test_ErrorReporting

RCF_BROKEN_COMPILER_TYPE_TRAITS_SPECIALIZATION(Test_ErrorReporting::A)
RCF_BROKEN_COMPILER_TYPE_TRAITS_SPECIALIZATION(Test_ErrorReporting::MyRemoteException)

int RCF_TEST_MAIN(int argc, char **argv)
{
    printTestHeader(__FILE__);

    using namespace Test_ErrorReporting;

    util::CommandLine::getSingleton().parse(argc, argv);

    // check that what() does the correct error translation
    int rcfError = RCF::RcfError_ClientCancel;
    RCF::Exception e(rcfError);
    std::string what = e.what();
    std::string errorMsg = RCF::getErrorString(rcfError);
    //BOOST_CHECK( what.compare(0, errorMsg.length(), errorMsg) == 0 );
    BOOST_CHECK( what.find(errorMsg) != std::string::npos );

    for (unsigned int i=0; i<RCF::getTransportFactories().size(); ++i)
    {

        RCF::TransportFactoryPtr transportFactoryPtr = RCF::getTransportFactories()[i];
        std::pair<RCF::ServerTransportPtr, RCF::ClientTransportAutoPtrPtr> transports = transportFactoryPtr->createTransports();
        RCF::ServerTransportPtr serverTransportPtr( transports.first );
        RCF::ClientTransportAutoPtr clientTransportAutoPtr( *transports.second );

        RCF::writeTransportTypes(std::cout, *serverTransportPtr, *clientTransportAutoPtr);

        serverTransportPtr->setMaxMessageLength(1000*10);
        clientTransportAutoPtr->setMaxMessageLength(1000*10);

        std::string s0 = "something special";

        Echo echo;
        RCF::RcfServer server( serverTransportPtr );
        server.start();
        //server.bind<I_Echo>(echo);
        server.bind( (I_Echo *) 0, echo);

        //***********************************************
        // message size errors

        // no error
        {
            serverTransportPtr->setMaxMessageLength(1000*10);
            clientTransportAutoPtr->setMaxMessageLength(1000*10);
            BOOST_CHECK( RcfClient<I_Echo>( clientTransportAutoPtr->clone() ).putString(makeString(50)) == 50);
            BOOST_CHECK( RcfClient<I_Echo>( clientTransportAutoPtr->clone() ).getString(50).size() == 50);
        }

        // try to trigger client transport send error
        {
            serverTransportPtr->setMaxMessageLength(1000*10);
            clientTransportAutoPtr->setMaxMessageLength(100);
            RcfClient<I_Echo>( clientTransportAutoPtr->clone() ).putString(makeString(500));
            BOOST_CHECK(1==1);
        }

        // trigger client transport receive error
        {
            serverTransportPtr->setMaxMessageLength(1000*10);
            clientTransportAutoPtr->setMaxMessageLength(500);
            try
            {
                RcfClient<I_Echo>( clientTransportAutoPtr->clone() ).getString(500);
                BOOST_CHECK(1==0);
            }
            catch(RCF::Exception &e)
            {
                BOOST_CHECK(1==1);
                BOOST_CHECK( e.getError() == RCF::RcfError_ClientMessageLength );
            }
        }

        // trigger server transport receive error
        {
            serverTransportPtr->setMaxMessageLength(500);
            clientTransportAutoPtr->setMaxMessageLength(1000*10);
            try
            {
                RcfClient<I_Echo>( clientTransportAutoPtr->clone() ).putString(makeString(500));
                BOOST_CHECK(1==0);
            }
            catch(RCF::RemoteException &e)
            {
                BOOST_CHECK(1==1);
                BOOST_CHECK( e.getError() == RCF::RcfError_ServerMessageLength );
            }
            catch(RCF::Exception &e)
            {
                // server did a hard close, we didn't get any error info
                BOOST_CHECK(1==0);
            }
        }

        // try to trigger server transport send error
        {
            serverTransportPtr->setMaxMessageLength(500);
            clientTransportAutoPtr->setMaxMessageLength(1000*10);
            RcfClient<I_Echo>( clientTransportAutoPtr->clone() ).getString(500);
            BOOST_CHECK(1==1);
        }

        //************************************************
        // serialization errors

        serverTransportPtr->setMaxMessageLength(1000*10);
        clientTransportAutoPtr->setMaxMessageLength(1000*10);

        // no errors
        A a;
        RcfClient<I_Echo>( clientTransportAutoPtr->clone() ).putA(a);
        a = RcfClient<I_Echo>( clientTransportAutoPtr->clone() ).getA(0);

        // outbound client serialization error
        try
        {
            RcfClient<I_Echo>( clientTransportAutoPtr->clone() ).putA( A(1) );
            BOOST_CHECK(1==0);
        }
        catch(const RCF::SerializationException &e)
        {
            std::string msg = e.what();
            BOOST_CHECK(1==1);
            BOOST_CHECK(e.getError() == RCF::RcfError_Serialization);
        }

        // server deserialization error
        try
        {
            RcfClient<I_Echo>( clientTransportAutoPtr->clone() ).putA( A(2) );
            BOOST_CHECK(1==0);
        }
        catch(RCF::RemoteException &e)
        {
            std::string msg = e.what();
            BOOST_CHECK(1==1);
            BOOST_CHECK(e.getError() == RCF::RcfError_Deserialization);
        }

        // server serialization error
        try
        {
            RcfClient<I_Echo>( clientTransportAutoPtr->clone() ).getA(1);
            BOOST_CHECK(1==0);
        }
        catch(RCF::RemoteException &e)
        {
            std::string msg = e.what();
            BOOST_CHECK(1==1);
            BOOST_CHECK(e.getError() == RCF::RcfError_Serialization);
        }

        // inbound client serialization error
        try
        {
            RcfClient<I_Echo>( clientTransportAutoPtr->clone() ).getA(2);
            BOOST_CHECK(1==0);
        }
        catch(const RCF::SerializationException &e)
        {
            std::string msg = e.what();
            BOOST_CHECK(1==1);
            BOOST_CHECK(e.getError() == RCF::RcfError_Deserialization);
        }


        //************************************************
        // returning non RCF error codes and strings, through RemoteException

        int myErrorCode = 12345;
        std::string myErrorString = "qwerty";
        try
        {
            RcfClient<I_Echo>( clientTransportAutoPtr->clone() ).throwRemoteException(myErrorCode, myErrorString);
            BOOST_CHECK(1==0);
        }
        catch(const RCF::RemoteException &e)
        {
            std::string msg = e.what();
            BOOST_CHECK(1==1);
            BOOST_CHECK(e.getError() == myErrorCode);
            //BOOST_CHECK(e.what() == myErrorString);
            BOOST_CHECK( std::string(e.what()).find(myErrorString) != std::string::npos);
        }

        //************************************************
        // throwing and catching RemoteException-derived exceptions across the wire

        try
        {
            RcfClient<I_Echo>( clientTransportAutoPtr->clone() ).throwMyRemoteException(myErrorCode, myErrorString);
            BOOST_CHECK(1==0);
        }
        catch(const MyRemoteException &e)
        {
            std::string msg = e.what();
            BOOST_CHECK(1==1);
            BOOST_CHECK(e.getError() == myErrorCode);
            BOOST_CHECK(e.what() == myErrorString);
        }
        catch(const RCF::RemoteException &e)
        {
            std::string msg = e.what();
            BOOST_CHECK(1==0);
            BOOST_CHECK(e.getError() == myErrorCode);
            BOOST_CHECK(e.what() == myErrorString);
        }


        //************************************************
        // message header errors (eg corruption)

        // TODO


        //************************************************
        // transport filter errors

        // TODO


        //************************************************
        // payload filter errors

        // TODO


    }


    return boost::exit_success;
}






By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Australia Australia
Software developer, from Sweden and now living in Canberra, Australia, working on distributed C++ applications. When he is not programming, Jarl enjoys skiing and playing table tennis. He derives immense satisfaction from referring to himself in third person.

Comments and Discussions