Serial Framework C++ Edition
Public Member Functions | Protected Member Functions | List of all members
CwclServerClientConnection Class Referenceabstract

The base class for all server client connection. More...

#include <wclConnections.h>

Inheritance diagram for CwclServerClientConnection:
CwclCustomConnection CwclServerClientDataConnection

Public Member Functions

 CwclServerClientConnection ()
 Creates a new server client connection.
 
virtual ~CwclServerClientConnection ()
 Frees the connection.
 
int Disconnect ()
 Disconnects from the connected remote device.
 
CwclServerConnectionGetServer () const
 Gets the client owner.
 
 __declspec (property(get=GetServer)) CwclServerConnection *Server
 
__event void OnConnect (void *Sender, const int Error)
 The event fires when a connection to a remote device has been completed (with or without success).
 
__event void OnDisconnect (void *Sender, const int Reason)
 The event fires when the remote connected device has been disconnected.
 
- Public Member Functions inherited from CwclCustomConnection
 CwclCustomConnection ()
 Creates a new connection.
 
virtual ~CwclCustomConnection ()
 Frees the connection.
 
CwclMessageReceiverGetReceiver () const
 Gets the connection message receiver object.
 
 __declspec (property(get=GetReceiver)) CwclMessageReceiver *Receiver
 Gets the connection message receiver object.
 
DWORD GetThreadId () const
 Gets the connection's thread ID.
 
 __declspec (property(get=GetThreadId)) DWORD ThreadId
 Gets the connection's thread ID.
 

Protected Member Functions

void NotifyClosed (const int Reason)
 Send a Disconnect notification message.
 
virtual void MessageReceived (const CwclMessage *const Message) override
 The message receiver calls this method when a new notification message has been received.
 
virtual void DoConnect (const int Error)
 Fires the OnConnect event.
 
virtual void DoDisconnect (const int Reason)
 Fires the OnDisconnect event.
 
virtual int Accept (CwclServerConnection *const Server, const void *const Params, const unsigned long ParamsSize)
 The method accepts the client connection request.
 
virtual int HalAccept ()=0
 Hardware-dependent method that prepares to communicate with a connected remote client device.
 
virtual int HalCommunicate (const HANDLE Event)
 Implements a hardware-dependent code that communicate with the connected remote device.
 
virtual int HalDisconnect ()=0
 Implements a hardware-dependent code that disconnects from the connected remote device.
 
bool GetDisconnected () const
 Gets the connection state.
 
 __declspec (property(get=GetDisconnected)) bool Disconnected
 Gets the connection state.
 
void * GetParams () const
 Custom connection parameters.
 
 __declspec (property(get=GetParams)) void *Params
 
- Protected Member Functions inherited from CwclCustomConnection
virtual void MessageReceived (const CwclMessage *const Message)
 The message receiver calls this method when a new notification message has been received.
 
void Enter ()
 Enters the connection's critical section.
 
void Leave ()
 Exists *leaves) the connection's critical section.
 

Detailed Description

The base class for all server client connection.

The class provides the basic methods for server connections.

See also
CwclCustomConnection