CwclObexOppClient Class Reference

The data processor implements the OBEX Object Push Profile (OPP) client. More...

#include <wclObex.h>

Inheritance diagram for CwclObexOppClient:

Public Member Functions
	CwclObexOppClient (CwclClientDataConnection *const Connection)
	Creates new ObjectPush Profile client.
virtual	~CwclObexOppClient ()
	Frees the object.
int	Connect (const unsigned short PacketSize=0xFFFF)
	Connects to an OBEX server.
int	Get (const tstring &aType, CwclStream *const Stream)
	The function reads the default object with given type from an OBEX Push server.
Public Member Functions inherited from CwclObexFileClient
	CwclObexFileClient (CwclClientDataConnection *const Connection)
	Creates new OBEX File Client Data Processor.
virtual	~CwclObexFileClient ()
	Frees the object.
int	Put (const tstring &Name, const tstring &Description, CwclStream *const Stream)
	Sends one object from the client to the server.
__event void	OnGetComplete (void *Sender, const int Error, const tstring &Description, CwclStream *const Stream)
	The event fires when the Get operation has been completed.
__event void	OnPutComplete (void *Sender, const int Error, const tstring &Description, CwclStream *const Stream)
	The event fires when the Put operation has been completed.
Public Member Functions inherited from CwclCustomObexClient
	CwclCustomObexClient (CwclClientDataConnection *const Connection)
	Creates new OBEX Client Data Processor.
virtual	~CwclCustomObexClient ()
	Frees the Data Processor.
virtual void	ProcessData (const void *const Data, const unsigned long Size) override
	The method called by the Connection when data has been received from a remote device.
int	Abort (const tstring &Description)
	Aborts current operation executing.
int	Disconnect (const tstring &Description)
	Disconnects from an OBEX server.
bool	GetConnected () const
	Gets the connected state.
	__declspec (property(get=GetConnected)) bool Connected
	Gets the connected state.
__event void	OnConnect (void *Sender, const int Error, const tstring &Description)
	The event fires when the Connect operation has been completed completed.
__event void	OnDisconnect (void *Sender, const int Error, const tstring &Description)
	The event fires when the Disconnect operation completed.
__event void	OnProgress (void *Sender, const unsigned long Length, const unsigned long Position)
	The event fires during sending or receiving an object to indicate operation progress.
Public Member Functions inherited from CwclCustomClientDataProcessor
	CwclCustomClientDataProcessor (CwclClientDataConnection *const Connection)
	Creates new Client Data Processor.
virtual	~CwclCustomClientDataProcessor ()
	Frees the Data Processor.
CwclClientDataConnection *	GetConnection () 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.
__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.

Additional Inherited Members
Protected Member Functions inherited from CwclObexFileClient
virtual void	DoGetComplete (const int Error, const tstring &Description, CwclStream *const Stream) override
	Fires the OnGetComplete event.
virtual void	DoPutComplete (const int Error, const tstring &Description, CwclStream *const Stream) override
	Fires the OnPutComplete event.
Protected Member Functions inherited from CwclCustomObexClient
int	Connect (const GUID &Target, const GUID &Who, const tstring &Description, const unsigned short PacketSize)
	Connects to an OBEX server.
int	Get (const tstring &Name, const tstring &Mime, CwclStream *const Stream, const unsigned char *const AppParams, const unsigned short AppParamsLength)
	Requests an object from a server.
int	Put (const tstring &Name, const tstring &Mime, const tstring &Description, CwclStream *const Stream, const unsigned char *const AppParams, const unsigned short AppParamsLength)
	Sends one object from the client to the server.
int	SetPath (const tstring &Dir, const bool Create)
	Changes the current directory on the server's side.
virtual void	DoConnect (const int Error, const tstring &Description)
	Fires the OnConnect event.
virtual void	DoDisconnect (const int Error, const tstring &Description)
	Fires the OnDisconnect event.
virtual void	DoProgress (const unsigned long Length, const unsigned long Position)
	Fires the OnProgress event.
virtual void	DoSetPathComplete (const int Error, const tstring &Description)
	The method called when the OBEX SET_PATH operation has been completed.
Protected Member Functions inherited from CwclCustomClientDataProcessor
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.
int	Write (const void *const Data, const unsigned long Size)
	Sends data to the connected device.

Detailed Description

The data processor implements the OBEX Object Push Profile (OPP) client.

See also

CwclObexFileClient