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

CascadePowerMessage Class Reference

message sent whenever a change in power state occurs More...

#include <cascade/app/CascadePowerMessage.h>

List of all members.

Public Types

enum  PowerState { kStandby = 0, kOn = 1 }

Static Public Member Functions

static u32 MessageID ()

Public Attributes

PowerState m_oldState
PowerState m_newState

Detailed Description

message sent whenever a change in power state occurs

Skip the description

CascadePowerMessage is broadcast to all local wormholes whenever the system power state is changed. Power messages are automatically dispatched by class CascadeApp.

See also:
CascadeApp::OnPowerMessage

class CascadePowerMessage

Member Enumeration Documentation

enum CascadePowerMessage::PowerState
 

represents a system power state

CascadePowerMessage contain two member variables of this type indicating the old system power state and the new system power state for a power state transition.

See also:
m_oldState, m_newState
Enumeration values:
kStandby  indicates power standby mode
kOn  indicates power on mode

Member Function Documentation

static u32 CascadePowerMessage::MessageID (   )  [static]
 

returns the messageID of the CascadePowerMessage

MessageID() is used to determine if a wormhole message is a CascadePowerMessage Use it as follows: 

        CascadeMessage * pMessage = wormhole.WaitForMessage();
        if ((NULL != pMessage) && (pMessage->ID() == CascadePowerMessage::MessageID()))
        {
            // we have a power message 
        }
Returns:
the messageID of the CascadePowerMessage

Member Data Documentation

PowerState CascadePowerMessage::m_newState
 

the new system power state of a power state transition

m_newState contains new power state of the power state transition represented by this power message.

See also:
PowerState

PowerState CascadePowerMessage::m_oldState
 

the old system power state of a power state transition

m_oldState contains old power state of the power state transition represented by this power message.

See also:
PowerState

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