WiFi Framework C++ Edition
CwclMessageReceiver Class Reference

The Wireless Communication Library message receiver. More...

#include <wclMessaging.h>

Public Member Functions

 CwclMessageReceiver ()
 Creates new message receiver object.
 
virtual ~CwclMessageReceiver ()
 Frees the message receiver.
 
int Close ()
 Closes the message receiver.
 
int Open (const wclMessageProcessingMethod Method)
 Opens the message receiver.
 
int Post (CwclMessage *const Message, const bool Sync=false)
 Places a message to the messages queue and starts processing the messages.
 
int ProcessAllMessages ()
 Processes all messages in the messages queue.
 
long GetId () const
 Gets the receiver's ID.
 
 __declspec (property(get=GetId)) long Id
 Gets the receiver's ID.
 
bool GetListening () const
 Gets the receiver status.
 
 __declspec (property(get=GetListening)) bool Listening
 Gets the receiver status.
 
wclMessageProcessingMethod GetMethod () const
 Get a message processing method supported by the message receiver.
 
 __declspec (property(get=GetMethod)) wclMessageProcessingMethod Method
 Gets a message processing method supported by the message receiver.
 
ULONG GetOpenThreadId () const
 Gets an ID of a thread that was used to call the Open method.
 
 __declspec (property(get=GetOpenThreadId)) ULONG OpenThreadId
 Gets an ID of a thread that was used to call the Open method.
 
__event void OnMessage (const CwclMessage *const Message)
 The event called when new message was received.
 

Protected Member Functions

virtual void DoMessage (const CwclMessage *const Message)
 Calls the OnMessage event.
 

Detailed Description

The Wireless Communication Library message receiver.