Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

CascadeUPnP Class Reference

#include <CascadeUPnP.h>

Inheritance diagram for CascadeUPnP:

CascadeAppMessageSink CascadeObject List of all members.

Public Types

typedef bool() MountListEnumCallback (const CascadeString &deviceUUID, void *pClientData)
enum  DeviceStatus { kOnline = 0, kOffline = 1 }
enum  TransactionResult {
  kUnknownDevice = 0, kDeviceNotUPnPAVServer, kDeviceNotWMCServer, kDeviceOffline,
  kDeviceError, kTimeout, kResourceBusy, kDeviceDescriptionNotCached,
  kRemoteSystemElementNotResponding, kAllocationError, kDataError, kParameterError,
  kEnumerationAborted, kObjectArrayInUse, kReissueTransaction, kSuccess
}

Public Member Functions

 CascadeUPnP ()
virtual ~CascadeUPnP ()
virtual u32 CatalogLocalDevices ()
virtual u32 RequestDeviceDescription (const CascadeString &deviceUUID)
virtual u32 RequestDeviceMount (const CascadeString &deviceUUID)
virtual u32 RequestWMCAuthorizationStatus (const CascadeString &deviceUUID)
virtual u32 RequestAVSearchCapabilities (const CascadeString &deviceUUID)
virtual u32 InitiateAVSearch (const CascadeString &deviceUUID, const CascadeString &containerObjectID, const CascadeString &searchTerm, const CascadeString &filterTerm, const CascadeString &sortTerm, u32 nStartIndex, u32 nCount, AVObjectArray &arrayToFill)
virtual u32 InitiateAVBrowse (const CascadeString &deviceUUID, const CascadeString &containerObjectID, const CascadeString &filterTerm, const CascadeString &sortTerm, u32 nStartIndex, u32 nCount, AVObjectArray &arrayToFill)
virtual u32 InitiateAVObjectFetch (const CascadeString &deviceUUID, const CascadeString &objectID, const CascadeString &filterTerm, AVObject &objectToSet)
virtual void CancelTransaction (u32 nTransactionID)
virtual void OnCatalogResult (const Device &device)
virtual void OnDeviceDescriptionResult (u32 nTransactionID, TransactionResult result, const DeviceDescription &deviceDescription)
virtual void OnDeviceMountResult (u32 nTransactionID, TransactionResult result, bool bMounted)
virtual void OnWMCAuthorizationStatusResult (u32 nTransactionID, TransactionResult result, bool bAuthorized)
virtual void OnAVSearchCapabilitiesResult (u32 nTransactionID, TransactionResult result, const CascadeString &searchCapabilities)
virtual void OnAVSearchResult (u32 nTransactionID, TransactionResult result, u32 nMatchCount, AVObjectArray &objectArray, bool bComplete)
virtual void OnAVBrowseResult (u32 nTransactionID, TransactionResult result, u32 nMatchCount, AVObjectArray &objectArray, bool bComplete)
virtual void OnAVObjectFetchResult (u32 nTransactionID, TransactionResult result, AVObject &object)
virtual bool GetDeviceFromUUID (const CascadeString &deviceUUID, Device &deviceToSet)
virtual bool GetCachedDeviceDescription (const CascadeString &deviceUUID, DeviceDescription &deviceDescriptionToSet)
virtual bool UnmountDevice (const CascadeString &deviceUUID)
virtual bool IsDeviceMounted (const CascadeString &deviceUUID)
virtual bool AddDeviceToPersistentMountList (const CascadeString &deviceUUID)
virtual bool RemoveDeviceFromPersistentMountList (const CascadeString &deviceUUID)
virtual bool RemoveAllDevicesFromPersistentMountList ()
virtual bool IsDeviceInPersistentMountList (const CascadeString &deviceUUID)
virtual bool EnumerateMountedDevices (MountListEnumCallback *pCallback, void *pClientData)
virtual bool EnumeratePersistentMountList (MountListEnumCallback *pCallback, void *pClientData)
virtual bool IsDeviceOnline (const CascadeString &deviceUUID)
virtual bool IsWindowsMediaConnect (const DeviceDescription &deviceDescription)
TransactionResult GetLastTransactionResult ()

Static Public Member Functions

static const char * MediaServerDeviceType ()
static const char * TransactionResultToString (TransactionResult result)

Classes

class  AVObject
class  AVObjectArray
class  Device
class  DeviceDescription
class  DeviceIcon
class  Service

Member Typedef Documentation

typedef bool() CascadeUPnP::MountListEnumCallback(const CascadeString &deviceUUID, void *pClientData)
 

Member Enumeration Documentation

enum CascadeUPnP::DeviceStatus
 

Enumeration values:
kOnline 
kOffline 

enum CascadeUPnP::TransactionResult
 

Enumeration values:
kUnknownDevice 
kDeviceNotUPnPAVServer 
kDeviceNotWMCServer 
kDeviceOffline 
kDeviceError 
kTimeout 
kResourceBusy 
kDeviceDescriptionNotCached 
kRemoteSystemElementNotResponding 
kAllocationError 
kDataError 
kParameterError 
kEnumerationAborted 
kObjectArrayInUse 
kReissueTransaction 
kSuccess 

Constructor & Destructor Documentation

CascadeUPnP::CascadeUPnP (   ) 
 

virtual CascadeUPnP::~CascadeUPnP (   )  [virtual]
 

Member Function Documentation

virtual bool CascadeUPnP::AddDeviceToPersistentMountList (  const CascadeString &  deviceUUID  )  [virtual]
 

virtual void CascadeUPnP::CancelTransaction (  u32  nTransactionID  )  [virtual]
 

virtual u32 CascadeUPnP::CatalogLocalDevices (   )  [virtual]
 

virtual bool CascadeUPnP::EnumerateMountedDevices (  MountListEnumCallback *  pCallback,
void *  pClientData
)  [virtual]
 

virtual bool CascadeUPnP::EnumeratePersistentMountList (  MountListEnumCallback *  pCallback,
void *  pClientData
)  [virtual]
 

virtual bool CascadeUPnP::GetCachedDeviceDescription (  const CascadeString &  deviceUUID,
DeviceDescription &  deviceDescriptionToSet
)  [virtual]
 

virtual bool CascadeUPnP::GetDeviceFromUUID (  const CascadeString &  deviceUUID,
Device &  deviceToSet
)  [virtual]
 

TransactionResult CascadeUPnP::GetLastTransactionResult (   ) 
 

virtual u32 CascadeUPnP::InitiateAVBrowse (  const CascadeString &  deviceUUID,
const CascadeString &  containerObjectID,
const CascadeString &  filterTerm,
const CascadeString &  sortTerm,
u32  nStartIndex,
u32  nCount,
AVObjectArray &  arrayToFill
)  [virtual]
 

virtual u32 CascadeUPnP::InitiateAVObjectFetch (  const CascadeString &  deviceUUID,
const CascadeString &  objectID,
const CascadeString &  filterTerm,
AVObject &  objectToSet
)  [virtual]
 

virtual u32 CascadeUPnP::InitiateAVSearch (  const CascadeString &  deviceUUID,
const CascadeString &  containerObjectID,
const CascadeString &  searchTerm,
const CascadeString &  filterTerm,
const CascadeString &  sortTerm,
u32  nStartIndex,
u32  nCount,
AVObjectArray &  arrayToFill
)  [virtual]
 

virtual bool CascadeUPnP::IsDeviceInPersistentMountList (  const CascadeString &  deviceUUID  )  [virtual]
 

virtual bool CascadeUPnP::IsDeviceMounted (  const CascadeString &  deviceUUID  )  [virtual]
 

virtual bool CascadeUPnP::IsDeviceOnline (  const CascadeString &  deviceUUID  )  [virtual]
 

virtual bool CascadeUPnP::IsWindowsMediaConnect (  const DeviceDescription &  deviceDescription  )  [virtual]
 

static const char* CascadeUPnP::MediaServerDeviceType (   )  [static]
 

virtual void CascadeUPnP::OnAVBrowseResult (  u32  nTransactionID,
TransactionResult  result,
u32  nMatchCount,
AVObjectArray &  objectArray,
bool  bComplete
)  [virtual]
 

virtual void CascadeUPnP::OnAVObjectFetchResult (  u32  nTransactionID,
TransactionResult  result,
AVObject &  object
)  [virtual]
 

virtual void CascadeUPnP::OnAVSearchCapabilitiesResult (  u32  nTransactionID,
TransactionResult  result,
const CascadeString &  searchCapabilities
)  [virtual]
 

virtual void CascadeUPnP::OnAVSearchResult (  u32  nTransactionID,
TransactionResult  result,
u32  nMatchCount,
AVObjectArray &  objectArray,
bool  bComplete
)  [virtual]
 

virtual void CascadeUPnP::OnCatalogResult (  const Device &  device  )  [virtual]
 

virtual void CascadeUPnP::OnDeviceDescriptionResult (  u32  nTransactionID,
TransactionResult  result,
const DeviceDescription &  deviceDescription
)  [virtual]
 

virtual void CascadeUPnP::OnDeviceMountResult (  u32  nTransactionID,
TransactionResult  result,
bool  bMounted
)  [virtual]
 

virtual void CascadeUPnP::OnWMCAuthorizationStatusResult (  u32  nTransactionID,
TransactionResult  result,
bool  bAuthorized
)  [virtual]
 

virtual bool CascadeUPnP::RemoveAllDevicesFromPersistentMountList (   )  [virtual]
 

virtual bool CascadeUPnP::RemoveDeviceFromPersistentMountList (  const CascadeString &  deviceUUID  )  [virtual]
 

virtual u32 CascadeUPnP::RequestAVSearchCapabilities (  const CascadeString &  deviceUUID  )  [virtual]
 

virtual u32 CascadeUPnP::RequestDeviceDescription (  const CascadeString &  deviceUUID  )  [virtual]
 

virtual u32 CascadeUPnP::RequestDeviceMount (  const CascadeString &  deviceUUID  )  [virtual]
 

virtual u32 CascadeUPnP::RequestWMCAuthorizationStatus (  const CascadeString &  deviceUUID  )  [virtual]
 

static const char* CascadeUPnP::TransactionResultToString (  TransactionResult  result  )  [static]
 

virtual bool CascadeUPnP::UnmountDevice (  const CascadeString &  deviceUUID  )  [virtual]
 

The documentation for this class was generated from the following file:
Generated on Sun Jul 24 14:27:21 2005 for Cascade Library by  doxygen 1.4.1