IrDA Framework C++ Edition
Public Member Functions | Protected Member Functions | List of all members
CwclIrDAReceiver Class Reference

Represents the IrDA receiver. More...

#include <wclIrDADevices.h>

Public Member Functions

 CwclIrDAReceiver ()
 Create a new component.
 
virtual ~CwclIrDAReceiver ()
 Frees the component.
 
int Discover (wclIrDADevices &Devices)
 Discovers nearby IrDA devices.
 
int StartLazyDiscovering ()
 Starts Lazy Discovering for IrDA devices.
 
int StopLazyDiscovering ()
 Stops monitoring Lazy Discovering.
 
int QueryAttribute (const unsigned long Address, const tstring &ClassName, const tstring &AttributeName, wclIrDAAttribute &Attribute)
 Query an IrDA IAS attribute value.
 
int Subscribe ()
 Subscribes for IrDA hardware changes notifications.
 
int Unsubscribe ()
 Unsubscribes from IrDA hardware changes notifications.
 
bool GetAvailable () const
 Gets the IrDA hardware status.
 
 __declspec (property(get=GetAvailable)) bool Available
 Gets the IrDA hardware status.
 
bool GetDiscovering () const
 Gets the Lazy Discovering state.
 
 __declspec (property(get=GetDiscovering)) bool Discovering
 Gets the Lazy Discovering state.
 
bool GetSubscribed () const
 Gets the subscription state.
 
 __declspec (property(get=GetSubscribed)) bool Subscribed
 Gets the subscription state.
 
__event void OnChange (void *Sender)
 The event fires when the state of the IrDA hardware is changed. To check real status an application should read the Available property.
 
__event void OnDevicesFound (void *Sender, const wclIrDADevice &Device)
 The even fires when new IrDA devices were found during Lazy Discovering.
 

Protected Member Functions

virtual void MessageReceived (const CwclMessage *const Message)
 The message receiver calls this method when a new notification message has been received.
 
virtual void DoChange ()
 Fires the OnChange event.
 
virtual void DoDevicesFound (const wclIrDADevice &Device)
 Fires the OnDevicesFound event.
 

Detailed Description

Represents the IrDA receiver.

The component provides methods to discover IrDA devices and to monitor changes in the IrDA hardware.

The component is not thread-safe and must be used in the same thread it was created.