sitemgr.h
上传用户:dangjiwu
上传日期:2013-07-19
资源大小:42019k
文件大小:10k
源码类别:

Symbian

开发平台:

Visual C++

  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Source last modified: $Id: sitemgr.h,v 1.4.8.1 2004/07/09 02:08:36 hubbe Exp $
  3.  * 
  4.  * Portions Copyright (c) 1995-2004 RealNetworks, Inc. All Rights Reserved.
  5.  * 
  6.  * The contents of this file, and the files included with this file,
  7.  * are subject to the current version of the RealNetworks Public
  8.  * Source License (the "RPSL") available at
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed
  10.  * the file under the current version of the RealNetworks Community
  11.  * Source License (the "RCSL") available at
  12.  * http://www.helixcommunity.org/content/rcsl, in which case the RCSL
  13.  * will apply. You may also obtain the license terms directly from
  14.  * RealNetworks.  You may not use this file except in compliance with
  15.  * the RPSL or, if you have a valid RCSL with RealNetworks applicable
  16.  * to this file, the RCSL.  Please see the applicable RPSL or RCSL for
  17.  * the rights, obligations and limitations governing use of the
  18.  * contents of the file.
  19.  * 
  20.  * Alternatively, the contents of this file may be used under the
  21.  * terms of the GNU General Public License Version 2 or later (the
  22.  * "GPL") in which case the provisions of the GPL are applicable
  23.  * instead of those above. If you wish to allow use of your version of
  24.  * this file only under the terms of the GPL, and not to allow others
  25.  * to use your version of this file under the terms of either the RPSL
  26.  * or RCSL, indicate your decision by deleting the provisions above
  27.  * and replace them with the notice and other provisions required by
  28.  * the GPL. If you do not delete the provisions above, a recipient may
  29.  * use your version of this file under the terms of any one of the
  30.  * RPSL, the RCSL or the GPL.
  31.  * 
  32.  * This file is part of the Helix DNA Technology. RealNetworks is the
  33.  * developer of the Original Code and owns the copyrights in the
  34.  * portions it created.
  35.  * 
  36.  * This file, and the files included with this file, is distributed
  37.  * and made available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY
  38.  * KIND, EITHER EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS
  39.  * ALL SUCH WARRANTIES, INCLUDING WITHOUT LIMITATION, ANY WARRANTIES
  40.  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, QUIET
  41.  * ENJOYMENT OR NON-INFRINGEMENT.
  42.  * 
  43.  * Technology Compatibility Kit Test Suite(s) Location:
  44.  *    http://www.helixcommunity.org/content/tck
  45.  * 
  46.  * Contributor(s):
  47.  * 
  48.  * ***** END LICENSE BLOCK ***** */
  49. #ifndef _SITEMGR_H_
  50. #define _SITEMGR_H_
  51. struct IHXSiteUserSupplier;
  52. class CHXSiteWindowed;
  53. /*
  54.  * element containd in event hook list
  55.  */
  56. class CHXEventHookElement
  57. {
  58. public:
  59.     CHXEventHookElement     (IHXEventHook* pHook,
  60.     UINT16     uLayer);
  61.     ~CHXEventHookElement    ();
  62.     IHXEventHook* m_pHook;
  63.     UINT16    m_uLayer;
  64. };
  65. /****************************************************************************
  66.  * 
  67.  *  Class:
  68.  *
  69.  * CHXSiteManager
  70.  *
  71.  *  Purpose:
  72.  *
  73.  * Implementation for IHXSiteManager in the client core.
  74.  *
  75.  */
  76. class CHXSiteManager : public IHXSiteManager,
  77.        public IHXEventHookMgr,
  78.                        public IHXSiteManager2
  79. {
  80. private:
  81.     LONG32 m_lRefCount;
  82.     BOOL m_bInUnHookAll;
  83.     BOOL m_bNeedFocus;
  84.     CHXMapPtrToPtr m_MasterListOfSites;
  85.     CHXMapStringToOb m_ChannelsToLists;
  86.     CHXMapStringToOb m_LSGNamesToLists;
  87.     CHXMapPtrToPtr m_SitesToSUS;
  88.     CHXMapStringToOb m_PersistentChannelsToLists;
  89.     CHXMapStringToOb m_PersistentLSGNamesToLists;
  90.     CHXMapPtrToPtr m_PersistentSitesToSUS;
  91.     CHXMapPtrToPtr m_PendingValueToSUPlayTo;
  92.     CHXMapPtrToPtr m_PendingValueToSUSinglePlayTo;
  93.     CHXMapPtrToPtr m_PendingValueToSULSG;
  94.     CHXMapPtrToPtr m_PendingValueToSUSingleLSG;
  95. #if !defined(HELIX_CONFIG_NOSTATICS)
  96.     static INT32 zm_nSiteManagerCount;
  97. #else
  98.     static const INT32 zm_nSiteManagerCount;
  99. #endif
  100.     CHXMapStringToOb m_EventHookMap;
  101.     CHXSimpleList m_UnnamedEventHookList;
  102.     STDMETHOD(AddSiteByStringHelper) (THIS_
  103.      const char* pString,
  104. IHXSite* pSite,
  105. CHXMapStringToOb& ByStringMap);
  106.     BOOL IsSiteAvailableByStringHelper (const char* pString,
  107. CHXMapStringToOb& ByStringMap);
  108.     BOOL HookupByStringHelper (const char* pString,
  109. CHXMapStringToOb& ByStringMap,
  110. IHXSiteUserSupplier*   pSUS,
  111. BOOL bIsPersistent);
  112.     BOOL HookupSingleSiteByStringHelper (const char* pString,
  113. CHXMapStringToOb& ByStringMap,
  114. IHXSiteUser* pSU,
  115. BOOL bIsPersistent);
  116.     BOOL HookupSite2SUS (IHXSite* pSite, 
  117. IHXSiteUserSupplier*   pSUS,
  118. BOOL bIsPersistent);
  119.     BOOL HookupByLSGNameWithString (IHXSiteUserSupplier*  pSUS, 
  120. char* pActualString,
  121. BOOL bIsPersistent);
  122.     BOOL HookupByPlayToFromWithString (IHXSiteUserSupplier*  pSUS, 
  123. char* pActualString,
  124. BOOL bIsPersistent);
  125.     BOOL HookupSingleSiteByLSGNameWithString (IHXSiteUser*     pSU,
  126. char*     pActualString,
  127. BOOL     bIsPersistent);
  128.     BOOL HookupSingleSiteByPlayToFromWithString (IHXSiteUser*     pSU,
  129. char*     pActualString,
  130. BOOL     bIsPersistent);
  131.     
  132.     STDMETHOD(AddEventHookElement) (CHXSimpleList*     pList,
  133. CHXEventHookElement*     pElement);
  134.     STDMETHOD(RemoveEventHookElement) (CHXSimpleList*     pList,
  135. IHXEventHook*     pHook,
  136. UINT16     uLayer);
  137.     enum EVENT_TYPE
  138.     {
  139.         SITE_EVENT_GENERAL = 0,
  140.         SITE_EVENT_REMOVED,
  141.         SITE_EVENT_ADDED
  142.     };
  143.     enum PTR_TYPE
  144.     {
  145.         SITE_USER_SUPPLIER = 0,
  146.         SITE_USER
  147.     };
  148.     enum HOOK_TYPE
  149.     {
  150.         HOOKUP_BY_LSGNAMEWITHSTRING = 0,
  151.         HOOKUP_BY_PLAYTOFROMWITHSTRING,
  152.         HOOKUP_SINGLESITE_BY_LSGNAMEWITHSTRING,
  153.         HOOKUP_SINGLESITE_BY_PLAYTOFROMWITHSTRING
  154.     };
  155.     HX_RESULT   ProcessSiteEvent        (CHXEventHookElement* pElement, IHXSite* pSite, 
  156.                                         HXxEvent* pEvent, EVENT_TYPE event_type);
  157.     HX_RESULT   HandleSiteEvent         (const char* pRegionName, IHXSite* pSite, 
  158.                                         HXxEvent* pEvent, EVENT_TYPE event_type);
  159.     void        HookupHelper            (CHXMapPtrToPtr* pMap, char* pActualString, BOOL bIsPersistent, 
  160.                                         PTR_TYPE ptr_type, HOOK_TYPE hook_type);
  161.     void        RemoveMapStrToObj       (CHXMapStringToOb* pMap);
  162.     void        RemoveMapPtrToPtr       (CHXMapPtrToPtr* pMap);
  163.     void        RemoveList              (CHXSimpleList* pList);
  164.     void CleanupPendingValues();
  165.     ~CHXSiteManager();
  166.     PRIVATE_DESTRUCTORS_ARE_NOT_A_CRIME
  167. public:
  168.     CHXSiteManager();
  169.     
  170.     /*
  171.      * IUnknown methods
  172.      */
  173.     STDMETHOD(QueryInterface) (THIS_
  174. REFIID riid,
  175. void** ppvObj);
  176.     STDMETHOD_(ULONG32,AddRef) (THIS);
  177.     STDMETHOD_(ULONG32,Release) (THIS);
  178.     /************************************************************************
  179.      * Method:
  180.      *     IHXSiteManager::AddSite
  181.      * Purpose:
  182.      *   Called to inform the site manager of the existance of a site.
  183.      */
  184.     STDMETHOD(AddSite) (THIS_
  185. IHXSite* pSite);
  186.     /************************************************************************
  187.      * Method:
  188.      *     IHXSiteManager::RemoveSite
  189.      * Purpose:
  190.      *   Called to inform the site manager that a site is no longer 
  191.      *   available.
  192.      */
  193.     STDMETHOD(RemoveSite) (THIS_
  194. IHXSite* pSite);
  195.     /*
  196.      * IHXEventHookMgr methods
  197.      */
  198.     /************************************************************************
  199.      *  Method:
  200.      *      IHXEventHookMgr::AddHook
  201.      *  Purpose:
  202.      *    Called to set an event hook that will get events from a site
  203.      *
  204.      */
  205.     STDMETHOD(AddHook) (THIS_
  206.      IHXEventHook* pHook,
  207. const char* pRegionName,
  208. UINT16 uLayer);
  209.     /************************************************************************
  210.      *  Method:
  211.      *      IHXEventHookMgr::RemoveHook
  212.      *  Purpose:
  213.      *    Called to remove an event hook set in AddHook()
  214.      *
  215.      */
  216.     STDMETHOD(RemoveHook) (THIS_
  217.      IHXEventHook* pHook,
  218. const char* pRegionName,
  219. UINT16 uLayer);
  220.     /************************************************************************
  221.      * Method:
  222.      *     IHXSiteManager2::GetNumberOfSites
  223.      * Purpose:
  224.      *   Called to get the number of sites that the site mananger currently 
  225.      *    knows about.
  226.      */
  227.     STDMETHOD(GetNumberOfSites) (THIS_  REF(UINT32) nNumSites );
  228.     /************************************************************************
  229.      * Method:
  230.      *     IHXSiteManager2::GetSiteAt
  231.      * Purpose:
  232.      *   Used to iterate over the sites.
  233.      *   
  234.      */
  235.     STDMETHOD(GetSiteAt) (THIS_ UINT32 nIndex, REF(IHXSite*) pSite);
  236. public:
  237.     /*
  238.      * Methods called internally in PN only code...
  239.      */
  240.     BOOL IsSiteAvailableByPlayToFrom(IHXValues*     pProps,
  241.     BOOL     bIsPersistent);
  242.     BOOL IsSiteAvailableByLSGName   (IHXValues*     pProps,
  243.     BOOL     bIsPersistent);
  244.     void UnhookSite     (IHXSite*     pSite,
  245.     BOOL     bIsPersistent);
  246.     void UnhookAll     ();
  247.     void RemoveSitesByLSGName     (IHXValues*     pProps,
  248.     BOOL     bIsPersistent);
  249.     BOOL HookupByLSGName     (IHXSiteUserSupplier*  pSUS, 
  250.     IHXValues*     pProps,
  251.     BOOL     bIsPersistent);
  252.     BOOL HookupByPlayToFrom     (IHXSiteUserSupplier*  pSUS, 
  253.     IHXValues*     pProps,
  254.     BOOL     bIsPersistent);
  255.     BOOL HookupSingleSiteByLSGName  (IHXSiteUser*     pSU,
  256.     IHXValues*     pProps,
  257.     BOOL     bIsPersistent);
  258.     BOOL HookupSingleSiteByPlayToFrom(IHXSiteUser*     pSU,
  259.     IHXValues*     pProps,
  260.     BOOL     bIsPersistent);
  261.     // mac only
  262.     static void EventOccurred(HXxEvent* pEvent);
  263.     HX_RESULT HandleHookedEvent (const char* pRegionName,
  264. IHXSite* pSite,
  265. HXxEvent* pEvent);
  266.     void HookedSiteAdded (const char* pRegionName,
  267. IHXSite* pSite);
  268.     void HookedSiteRemoved (const char* pRegionName,
  269. IHXSite* pSite);
  270.     BOOL IsSitePresent              (IHXSite*     pSite);
  271.     void NeedFocus(BOOL bFocus);
  272. #if defined(_MACINTOSH) || defined(_MAC_UNIX)
  273. static CHXSimpleList zm_SiteManagerList;
  274. static BOOL  zm_bWindowRemovedFromList;
  275. // friend class  CHXSiteWindowed;
  276. #endif
  277. };
  278. #endif // _SITEMGR_H_