CascadeWormhole.h

Go to the documentation of this file.

//
// CascadeWormhole.h - header file for class CascadeWormhole
//
// Copyright (c) 2002, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_INTERPROCESS_CASCADEWORMHOLE_H
#define _ROKU_INCLUDE_CASCADE_INTERPROCESS_CASCADEWORMHOLE_H

#include <cascade/interprocess/CascadeMessage.h>
#include <cascade/interprocess/CascadeMessageDefs.h>

class CascadeWormhole : public CascadeObject
{
public:
        CascadeWormhole();
        virtual ~CascadeWormhole();

public: // wormhole public constants
    enum {
        kMaxName = 96,                  
        kMaxNameLen = kMaxName - 1      
    };

public: // wormhole public functions    
    bool Create(const char * pWormholeURL);
    void Destroy();
    CascadeMessage * WaitForMessage(u32 nTimeoutMilliseconds = 0);
    bool PostMessage(const char * pWormholeURL, u32 nMessageID, void * pMessageData = NULL,  u32 nDataSize = 0);
    bool BroadcastMessage(const char * pBroadcastURL, u32 nMessageID, void * pMessageData = NULL,  u32 nDataSize = 0);
    bool SendMessage(const char * pWormholeURL, u32 nMessageID, void * pMessageData, u32 nDataSize, CascadeMessage *& pReplyMessageToSet);
    bool SendReply(u32 nReplyMessageID, void * pMessageData = NULL, u32 nDataSize = 0);
    typedef bool (WormholeEnumProc)(const char * pWormholeURL, void * pClientData);
    static bool EnumerateWormholes(const char * pWormholeURL, WormholeEnumProc * pEnumProc, void * pClientData);
    static bool DoesWormholeExist(const char * pWormholeURL);
#ifndef DOXY_SKIP
    //#define _CW_USE_OLD_WORMHOLE_IMPL
    #ifdef _CW_USE_OLD_WORMHOLE_IMPL
    private:
        void * m_pWormholeInternal;
    #else
    private:
        class Hole;
        Hole * m_pHole;
    #endif
#endif
};

#endif // #ifndef _ROKU_INCLUDE_CASCADE_INTERPROCESS_CASCADEWORMHOLE_H

// LOG
//  20-Dec-02   dwoodward       created
//  20-Jan-03   dwoodward   1.0 STATUS: about 50% complete - needs refinement
//                          and review
//  25-Feb-03   dwoodward   cleared up ambiguity on valid duration of a reply message
//                          by adding more comments to the SendMessage function
//  25-Feb-03   dwoodward   added DoesWormholeExist()
//  03-Feb-03   dwoodward   made EnumerateWormholes static
//  23-Apr-03   dwoodward   increased kMaxName
//  05-May-03   dwoodward   doxygenated

---