UT/UT_Message.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Mark Elendt
 *      Side Effects
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        UT library (C++)
 *
 * COMMENTS:    Message based IPC
 *
 */

#ifndef __UT_Message_h__
#define __UT_Message_h__

#include "UT_API.h"
class UT_String;
class UT_SharedMem;

class UT_API UT_MessagePort
{
public:
    //
    //  This port will only receive messages tagged with it's receive tag.
    //  Every message it sends will have a tag of it's sendTag.
    //  The tag numbers must be greater than 0
     UT_MessagePort(int receiveTag, int sendTag);
    ~UT_MessagePort();

    //
    // Open a message port.  If create is 1, the port will be created if it
    //  doesn't exist.  Return codes:   0 = failure, > 0 success, 2 = created
    int         open(int port_number, int create = 1);

    // This method will attempt to destroy a message port (even if we didn't
    // create it).  Returns 1 if removed, 0 if not.
    static int  destroy(int port_number);

    // Destructing will automatically close the port...
    void        close();

    int         isAlive()       { return myPort >= 0; }

    //
    //  Send returns 0 on error, 1 on success
    int         send(const char *message, int tag = -1);

    //
    //  Receive returns 0 on error, 1 on success.  The wait callback is
    //  only used on windows.  It is there so the help browser can keep
    //  pumping messages while it blocks on a response from Houdini.
    //  Otherwise, if Houdini implicitly sends a message to the help browser
    //  (by moving it's window, etc.) that needs a response, deadlock will
    //  occur.
    int         get(UT_String &str, int waitForMsg = 1,
                    void (*wait_callback)() = 0);

    //  TODO: Write binary routines...

private:
    int         myReceiveTag;
    int         mySendTag;
    int         myPort;
    int         myCreatedMemory;
#ifdef WIN32
    UT_SharedMem        *myPortMem;
#endif
};

#endif

---