Serial Framework C++ Edition
Public Member Functions | Protected Member Functions | List of all members
CwclCustomClientDataProcessor Class Reference

The base class for all WCL Client Data Processors. More...

#include <wclConnections.h>

Inheritance diagram for CwclCustomClientDataProcessor:
CwclCustomDataProcessor CwclCustomObexClient CwclObexFileClient CwclObexFtpClient CwclObexOppClient

Public Member Functions

 CwclCustomClientDataProcessor (CwclClientDataConnection *const Connection)
 Creates new Client Data Processor.
 
virtual ~CwclCustomClientDataProcessor ()
 Frees the Data Processor.
 
CwclClientDataConnectionGetConnection () const
 Gets the connection object used to communicate with a remote device.
 
 __declspec (property(get=GetConnection)) CwclClientDataConnection *Connection
 
- Public Member Functions inherited from CwclCustomDataProcessor
 CwclCustomDataProcessor ()
 Creates new Data Processor object.
 
virtual ~CwclCustomDataProcessor ()
 Frees the Data Processor object.
 
virtual void ProcessData (const void *const Data, const unsigned long Size)=0
 The method called by the Connection when data has been received from a remote device.
 
__event void OnWrite (void *Sender, const void *const Data, const unsigned long Size, unsigned long &Written, int &WriteResult)
 The event fires when the Data Processor needs to write data to a connection but a connection is not assigned.
 

Protected Member Functions

virtual int WriteData (const void *const Data, const unsigned long Size, unsigned long &Written) override
 Writes data to the Client Connection.
 
- Protected Member Functions inherited from CwclCustomDataProcessor
virtual void DoWrite (const void *const Data, const unsigned long Size, unsigned long &Written, int &WriteResult)
 Fires the OnWrite event.
 
virtual int WriteData (const void *const Data, const unsigned long Size, unsigned long &Written)=0
 Implements a connection-dependent code that sends data to the connected device.
 
int Write (const void *const Data, const unsigned long Size)
 Sends data to the connected device.
 

Detailed Description

The base class for all WCL Client Data Processors.

The Client Data Processor allows to add additional data processing for the Client Data Connections.

See also
CwclCustomDataProcessor, CwclClientDataConnection