CascadeMountMessage Class Reference

message sent whenever a file system mount point changes More...

#include <cascade/app/CascadeMountMessage.h>

List of all members.

Public Types
enum	MountType { kMounted = 0, kUnmounted = 1 }
enum	MediaType {   kInternalFlash = 0, kCompactFlash = 1, kSmartMedia = 2, kMemoryStick = 3,   kSDMedia = 4, kExternalMedia = 5, kNFSMount = 6, kSMBMount = 7,   kFTPMount = 8, kUPnPAVMount = 9, kNumMediaTypes = kUPnPAVMount + 1 }
enum	{ kMaxMediaDescLen = 127, kMaxMediaDesc = kMaxMediaDescLen + 1, kMaxMountPointLen = 255, kMaxMountPoint = kMaxMountPointLen + 1 }
Static Public Member Functions
static u32	MessageID ()
Public Attributes
MountType	m_mountType
MediaType	m_mediaType
char	m_mountPoint [kMaxMountPoint]
char	m_mediaDesc [kMaxMediaDesc]
bool	m_bReadOnly

---

Detailed Description

message sent whenever a file system mount point changes

Skip the description

CascadeMountMessage is broadcast to all local wormholes whenever a new mount point is added, removed, or changed. Mount messages are automatically dispatched by class CascadeApp.

See also:

CascadeApp::OnMountMessage

---

class CascadeMountMessage

---

Member Enumeration Documentation

anonymous enum

Enumeration values: kMaxMediaDescLen  max number of characters of a media description string kMaxMediaDesc  size of a buffer for a media description string kMaxMountPointLen  max number of characters in a mount point string kMaxMountPoint  size of a buffer for a mount point string

enum CascadeMountMessage::MediaType

represents the type of the media being mounted or unmounted CascadeMountMessages contain a member variable (m_mediaType) that indicates the type of media that was mounted or unmounted. See also: m_mountType Enumeration values: kInternalFlash  kCompactFlash  kSmartMedia  kMemoryStick  kSDMedia  kExternalMedia  kNFSMount  kSMBMount  kFTPMount  kUPnPAVMount  kNumMediaTypes

enum CascadeMountMessage::MountType

represents the type of the mount message CascadeMountMessages contain a member variable (m_mountType) of this type that indicates whether the mount message is notifying that a file system has been mounted or unmounted. See also: m_mountType Enumeration values: kMounted  indicates a file system was mounted kUnmounted  indicates a file system was unmounted

---

Member Function Documentation

static u32 CascadeMountMessage::MessageID (   )  [static]

returns the messageID of the CascadeMountMessage MessageID() is used to determine if a wormhole message is a CascadeMountMessage Use it as follows: CascadeMessage * pMessage = wormhole.WaitForMessage(); if ((NULL != pMessage) && (pMessage->ID() == CascadeMountMessage::MessageID())) { // we have a mount message } Returns: the messageID of the CascadeMountMessage

---

Member Data Documentation

bool CascadeMountMessage::m_bReadOnly

indicates whether the file system is read-only m_bReadOnly is true if the file system the message applies to is read-only, false if the file system is read-write

char CascadeMountMessage::m_mediaDesc[kMaxMediaDesc]

the description of the media being mounted or unmounted m_mediaDesc the description of the media being mounted or unmounted

MediaType CascadeMountMessage::m_mediaType

the type of media that was mounted or unmounted m_mediaType contains type of media the message applies to See also: MediaType

char CascadeMountMessage::m_mountPoint[kMaxMountPoint]

the file system mount point m_mountPoint contains the file system mount point (path) that is being notified

MountType CascadeMountMessage::m_mountType

the type of the mount message m_mountType contains the type of the mount message See also: MountType

---

The documentation for this class was generated from the following file:

• CascadeMountMessage.h

---