IrDA Framework C++ Edition
Public Member Functions | Protected Member Functions | List of all members
CwclIrDAServer Class Reference

The IrDA Server component. More...

#include <wclIrDAServers.h>

Public Member Functions

 CwclIrDAServer ()
 Create a new IrDA server.
 
virtual ~CwclIrDAServer ()
 Frees the component.
 
int Close ()
 Closes the server.
 
int Listen ()
 Initializes the server and waits for incoming connections.
 
int AddIasRecord (const tstring &ClassName, const tstring &AttribName, const int Value)
 The function adds the integer value into the server's IAS database.
 
int AddIasRecord (const tstring &ClassName, const tstring &AttribName, const unsigned short Len, const unsigned char *const Value)
 The function adds the octet sequence value into the server's IAS database.
 
int AddIasRecord (const tstring &ClassName, const tstring &AttribName, const wclIrDACharSet CharSet, const unsigned char Len, const unsigned char *const Value)
 The function adds the string value into the server's IAS database.
 
CwclIrDAServerClientConnectionGetClients (const size_t Index) const
 Gets a connected client by its index.
 
 __declspec (property(get=GetClients)) CwclIrDAServerClientConnection *Clients[]
 Gets a connected client by its index.
 
size_t GetClientsCount () const
 Gets the number of connected clients.
 
 __declspec (property(get=GetClientsCount)) size_t ClientsCount
 Gets the number of connected clients.
 
wclServerState _GetState () const
 Gets the server state.
 
 __declspec (property(get=_GetState)) wclServerState State
 Gets the server state.
 
wclIrDAConnectionMode GetMode () const
 Gets the IrDA connection mode.
 
void SetMode (const wclIrDAConnectionMode Value)
 Sets the IrDA connection mode.
 
 __declspec (property(get=GetMode, put=SetMode)) wclIrDAConnectionMode Mode
 Gets and sets the IrDA connection mode.
 
tstring GetService () const
 Gets the IrDA service that should be used to connect. It can be a TinyTP service name or LSAP selector number. In case of using LSAP selector number the format is 'LSAP-SELn' where n is a select number in range from 1 to 127.
 
void SetService (const tstring &Value)
 Sets the IrDA service that should be used to connect. It can be a TinyTP service name or LSAP selector number. In case of using LSAP selector number the format is 'LSAP-SELn' where n is a select number in range from 1 to 127.
 
 __declspec (property(get=GetService, put=SetService)) tstring Service
 Gets and sets the IrDA service that should be used to connect. It can be a TinyTP service name or LSAP selector number. In case of using LSAP selector number the format is 'LSAP-SELn' where n is a select number in range from 1 to 127.
 
__event void OnClosed (void *Sender, const int Reason)
 The event fires when the server is closed.
 
__event void OnConnect (void *Sender, CwclIrDAServerClientConnection *const Client, const int Error)
 The event fires when a remote client is connected to the server.
 
__event void OnCreateProcessor (void *Sender, CwclServerClientDataConnection *const Connection)
 The event fires when connection to a remote device has been established with success to allow application provide a data processor for the connection.
 
__event void OnData (void *Sender, CwclIrDAServerClientConnection *const Client, const void *const Data, const unsigned long Size)
 The event fires when new data is received from the connected remote device.
 
__event void OnDestroyProcessor (void *Sender, CwclServerClientDataConnection *const Connection)
 The event fires when connection to a remote device has been terminated. An application must destroy the Data Processor created for the connection.
 
__event void OnDisconnect (void *Sender, CwclIrDAServerClientConnection *const Client, const int Reason)
 The event fires when a remote client has disconnected from the server.
 
__event void OnListen (void *Sender)
 The event fires when the server is ready to accept incoming connections (is in listening state).
 

Protected Member Functions

virtual void DoClosed (const int Reason)
 Fires the OnClosed event.
 
virtual void DoConnect (CwclIrDAServerClientConnection *const Client, const int Error)
 Fires the OnConnect event.
 
virtual void DoCreateProcessor (CwclServerClientDataConnection *const Connection)
 Fires the OnCreateProcessor event.
 
virtual void DoData (CwclIrDAServerClientConnection *const Client, const void *const Data, const unsigned long Size)
 Fires the OnData event.
 
virtual void DoDestroyProcessor (CwclServerClientDataConnection *const Connection)
 Fires the OnDestroyProcessor event.
 
virtual void DoDisconnect (CwclIrDAServerClientConnection *const Client, const int Reason)
 Fires the OnDisconnect event.
 
virtual void DoListen ()
 Fires the OnListen event.
 

Detailed Description

The IrDA Server component.