---

     

---

CHMllpWrapper Class Reference

#include <CHMllpWrapper.h>

Inheritance diagram for CHMllpWrapper:

---

Detailed Description

Lower Layer Protocol (LLP) wrapper.

This is an implementation of the CHMwrapper object that supports the LLP protocol. The LLP protocol consists of preceding the message with a "\x0B" character and trailing it with "\x1C\x0D"

Deprecated:

Public Member Functions
	CHMllpWrapper ()
	Constructor.
virtual	~CHMllpWrapper ()
	Destructor.
virtual void	AddWrapper (CHMstring &MessageData)
	Wrap an outgoing message MessageDate.
virtual CHMboolean	DetectMessage (CHMstring &Buffer, CHMstring &Message)
	Detect and unwrap a message in an incoming stream.
const CHMchar *	LLPheader () const
	Get the LLP header.
const CHMchar *	LLPtrailer () const
	Get the LLP trailer.
void	setLLPheader (const CHMchar *NewValue)
	Set the LLP header.
void	setLLPtrailer (const CHMchar *NewValue)
	Set the LLPtrailer.

---

Constructor & Destructor Documentation

CHMllpWrapper::CHMllpWrapper (   )

Constructor.

virtual CHMllpWrapper::~CHMllpWrapper (   )  [virtual]

Destructor.

---

Member Function Documentation

virtual void CHMllpWrapper::AddWrapper (  CHMstring &  MessageData  )  [virtual]

Wrap an outgoing message MessageDate. Implements CHMwrapper.

virtual CHMboolean CHMllpWrapper::DetectMessage (  CHMstring &  Buffer, CHMstring &  Message )  [virtual]

Detect and unwrap a message in an incoming stream. This routine removes the read data from Buffer and sets the Message string to be equal to the message data and returns true if a message is present in the buffer; otherwise, it just returns false and leaves Buffer unaltered and the content of Message is undefined. Implements CHMwrapper.

const CHMchar* CHMllpWrapper::LLPheader (   )  const

Get the LLP header. By default this is a "\x0B" character.

const CHMchar* CHMllpWrapper::LLPtrailer (   )  const

Get the LLP trailer. By default this is "\x1C\x0D".

void CHMllpWrapper::setLLPheader (  const CHMchar *  NewValue  )

Set the LLP header. By default this is a "\x0B" character.

void CHMllpWrapper::setLLPtrailer (  const CHMchar *  NewValue  )

Set the LLPtrailer. By default this is "\x1C\x0D".

---

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

• CHMllpWrapper.h

---