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

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

#include <wclObex.h>

Inheritance diagram for CwclObexOppServer:
CwclCustomObexServer CwclCustomServerClientDataProcessor CwclCustomDataProcessor

Public Member Functions

 CwclObexOppServer (CwclServerClientDataConnection *const Connection)
 Creates new OBEX Server Client Data Processor.
 
virtual ~CwclObexOppServer ()
 
__event void OnConnect (void *Sender, const tstring &Description)
 The event fires when a client connects to the server.
 
__event void OnGetRequest (void *Sender, const tstring &aType, wclObexServerOperationResult &Result, CwclStream *&Stream)
 The event fires when a remote connected client requests the OBEX object (sends the get request).
 
- Public Member Functions inherited from CwclCustomObexServer
 CwclCustomObexServer (CwclServerClientDataConnection *const Connection)
 Creates new OBEX Server Client Data Processor.
 
virtual ~CwclCustomObexServer ()
 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 Accept (const tstring &Description, const unsigned short PacketSize=0xFFFF)
 Accepts the client's connection request.
 
int Reject (const tstring &Description)
 Rejects the connection request.
 
bool GetConnected () const
 Gets the connected state.
 
 __declspec (property(get=GetConnected)) bool Connected
 Gets the connected state.
 
unsigned long GetConnectionId () const
 Connection ID.
 
 __declspec (property(get=GetConnectionId)) unsigned long ConnectionId
 Connection ID.
 
tstring GetDescription () const
 The current server's description.
 
 __declspec (property(get=GetDescription)) tstring Description
 The current server's description.
 
GUID GetTarget () const
 The current connected client's ID.
 
 __declspec (property(get=GetTarget)) GUID Target
 The current connected client's ID.
 
__event void OnDisconnected (void *Sender, const int Reason, const tstring &Description)
 The event fires when a remote client closes the OBEX session (disconnects).
 
__event void OnGetCompleted (void *Sender, const int Error, CwclStream *const Stream)
 The event fires when the get request completed.
 
__event void OnProgress (void *Sender, const unsigned long Length, const unsigned long Position)
 The event fires during sending the object.
 
__event void OnPutBegin (void *Sender, const tstring &Name, const tstring &Description, const tstring &Mime, const unsigned long Length, bool &Accept)
 The event fires when client started object sending (OBEX PUT) operation. An application must accept or reject the object.
 
__event void OnPutCompleted (void *Sender, const int Error, CwclStream *const Stream, bool &Accept)
 The event fires when all object has been received.
 
__event void OnPutProgress (void *Sender, const unsigned long Position, const unsigned long Length, bool &Continue)
 The event fires during receiving the object.
 
- Public Member Functions inherited from CwclCustomServerClientDataProcessor
 CwclCustomServerClientDataProcessor (CwclServerClientDataConnection *const Connection)
 Creates new Client Data Processor.
 
virtual ~CwclCustomServerClientDataProcessor ()
 Frees the Data Processor.
 
CwclServerClientDataConnectionGetConnection () const
 Gets the connection object used to communicate with a remote device.
 
 __declspec (property(get=GetConnection)) CwclServerClientDataConnection *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 void DoConnect (const GUID &Target, const GUID &Who, const tstring &Description) override
 The method called when a remote client opens OBEX session (connects).
 
virtual void DoGetRequest (const tstring &Name, const tstring &Mime, wclObexServerOperationResult &Result, CwclStream *&Stream) override
 Fires the OnGetRequest event.
 
- Protected Member Functions inherited from CwclCustomObexServer
virtual void DoConnect (const GUID &Target, const GUID &Who, const tstring &Description)
 The method called when a remote client opens OBEX session (connects).
 
virtual void DoDisconnected (const int Reason, const tstring &Description)
 Fires the OnDisconnected event.
 
virtual void DoGetCompleted (const int Error, CwclStream *const Stream)
 Fires the OnGetCompleted event.
 
virtual void DoGetRequest (const tstring &Name, const tstring &Mime, wclObexServerOperationResult &Result, CwclStream *&Stream)
 The method called when the GET request received from a OBEX OPP Client.
 
virtual void DoProgress (const unsigned long Length, const unsigned long Position)
 Fires the OnProgress event.
 
virtual void DoPutBegin (const tstring &Name, const tstring &Description, const tstring &Mime, const unsigned long Length, bool &Accept)
 Fires the OnPutBegin event.
 
virtual void DoPutCompleted (const int Error, CwclStream *const Stream, bool &Accept)
 Fires the OnPutCompleted event.
 
virtual void DoPutProgress (const unsigned long Position, const unsigned long Length, bool &Continue)
 Fires the OnPutProgress event.
 
virtual GUID GetWho () const
 The service ID that is implemented by the server.
 
 __declspec (property(get=GetWho)) GUID Who
 
- Protected Member Functions inherited from CwclCustomServerClientDataProcessor
virtual int WriteData (const void *const Data, const unsigned long Size, unsigned long &Written) override
 Writes data to the 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 data processor implements the OBEX Object Push Profile (OPP) server.

See also
CwclCustomObexServer