Class Hierarchy   Class Index   Method Index  

CHMtransport Class Reference

#include <CHMtransport.h>

Inheritance diagram for CHMtransport:

CHMmfcSocketTransport

Detailed Description

Abstract interface class for message transport.

This is a pure virtual class which forms the interface to the transport layer. Sub-classes of this can implement various types of transports whether they be TCP/IP sockets, serial links, etc.

Deprecated:
New applications should use CHMllpConnection.


Public Member Functions

 CHMtransport ()
 Constructor.
virtual ~CHMtransport ()
 Destructor.
CHMengine * Engine ()
 Get the CHMengine object associated with this CHMtransport class.
CHMoutputLog * Log ()
 Get the CHMoutputLog object associated with the CHMengine object that is associated with this CHMtransport class.
virtual void OnError (size_t Code, const CHMchar *Description)
 OnError event.
virtual void SendResponseMessage (const CHMstring &MessageData, size_t TransportIndex)=0
 Send a response message.
void SetEngine (CHMengine *pEngine)
 Assign the CHMengine object pEngine to this CHMtransport class.
CHMwrapper * Wrapper ()
 Get the CHMwrapper object associated with the CHMengine object that is associated with this CHMtransport class.

Constructor & Destructor Documentation

CHMtransport::CHMtransport (   ) 
 

Constructor.

virtual CHMtransport::~CHMtransport (   )  [virtual]
 

Destructor.

Member Function Documentation

CHMengine* CHMtransport::Engine (   )  [inline]
 

Get the CHMengine object associated with this CHMtransport class.

CHMoutputLog* CHMtransport::Log (   ) 
 

Get the CHMoutputLog object associated with the CHMengine object that is associated with this CHMtransport class.

virtual void CHMtransport::OnError (  size_t  Code,
const CHMchar *  Description
)  [virtual]
 

OnError event.

This event may be invoked when an error occurs.

virtual void CHMtransport::SendResponseMessage (  const CHMstring &  MessageData,
size_t  TransportIndex
)  [pure virtual]
 

Send a response message.

This method is called by the CHMwrapper class to send the response back to the counter party at TransportIndex. It should be overridden in the child class to provide an implementation.

Implemented in CHMmfcSocketTransport.

void CHMtransport::SetEngine (  CHMengine *  pEngine  )  [inline]
 

Assign the CHMengine object pEngine to this CHMtransport class.

The CHMtransport class does not take ownership of the engine.

CHMwrapper* CHMtransport::Wrapper (   ) 
 

Get the CHMwrapper object associated with the CHMengine object that is associated with this CHMtransport class.

The CHMwrapper object is responsible for implementing the wrapping protocol associated with this class

The documentation for this class was generated from the following file: