IProtocolManager Class Reference

Interface class for protocol manager. More...

#include <iprotocolmanager.h>

Inheritance diagram for IProtocolManager:

Public Member Functions
virtual XsMessage	convertToMessage (XsProtocolType &type, MessageLocation &location, const XsByteArray &raw)=0
	Converts raw data using location into a XsMessage object. More...
virtual MessageLocation	findMessage (XsProtocolType &type, const XsByteArray &raw)=0
	Will let all supported protocols attempt finding a raw message in the given raw data. More...
virtual bool	validateMessage (XsMessage const &msg) const =0
	Performs a sanity check on the given message. More...
virtual	~IProtocolManager ()
	Destructor. More...

Detailed Description

Interface class for protocol manager.

Describes the interfaces of a manager of different protocols

See also

ProtocolHandler

Definition at line 75 of file iprotocolmanager.h.

Constructor & Destructor Documentation

~IProtocolManager()

virtual IProtocolManager::~IProtocolManager ( )

inlinevirtual

Destructor.

Definition at line 80 of file iprotocolmanager.h.

Member Function Documentation

convertToMessage()

virtual XsMessage IProtocolManager::convertToMessage ( XsProtocolType &  type, MessageLocation &  location, const XsByteArray &  raw  )

pure virtual

Converts raw data using location into a XsMessage object.

Parameters

type	The protocol type to use.
location	The location of a message to convert from raw data.
raw	The raw byte stream.

Returns

A XsMessage object that was converted from raw byte stream.

Implemented in ProtocolManager, and SimpleProtocolManager.

findMessage()

virtual MessageLocation IProtocolManager::findMessage ( XsProtocolType &  type, const XsByteArray &  raw  )

pure virtual

Will let all supported protocols attempt finding a raw message in the given raw data.

Parameters

type	The protocol type to us
raw	The input raw byte array in which to look for a message

Returns

A MessageLocation object describing the best possible found message

See also

MessageLocation

Implemented in ProtocolManager, and SimpleProtocolManager.

validateMessage()

virtual bool IProtocolManager::validateMessage ( XsMessage const &  msg ) const

pure virtual

Performs a sanity check on the given message.

Parameters

msg	The message to check

Returns

true if the message passes the protocol managers sanity checks

Implemented in SimpleProtocolManager, and ProtocolManager.

---

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

• iprotocolmanager.h