MlpMessage Class Reference

MlpMessage. More...

#include <MlpMessage.hpp>

Collaboration diagram for MlpMessage:

[legend]

List of all members.

Public Member Functions
	MlpMessage ()
	Constructor.
	~MlpMessage ()
	Destructor.
void	setSessionId (std::string sessionId)
	Setter for session ID.
std::string	getSessionId ()
	Getter for session ID.
void	setMsgVer (std::string ver)
	Setter for message version.
std::string	getMsgVer ()
	Getter for message version.
void	setMsgType (int type)
	Setter for message type.
int	getMsgType ()
	Getter for messager type.
void	setServiceVer (std::string ver)
	Setter for.
std::string	getServiceVer ()
	Getter for.
void	setServiceType (int type)
	Setter for.
int	getServiceType ()
	Getter for.
void	setServiceResType (int responseType)
	Setter for.
int	getServiceResType ()
	Getter for.
void	setReqId (std::string reqId)
	Setter for.
std::string	getReqId ()
	Getter for.
void	setResult (std::string result)
std::string	getResult ()
void	setResId (std::string resId)
std::string	getResId ()
void	setAddInfo (std::string addInfo)
std::string	getAddInfo ()
MlpHdr *	createHdr ()
MlpHdr *	getMlpHdr ()
	Getter for.
MlpSubscriberList *	createSubscriberList ()
MlpSubscriberList *	getSubscriberList ()
	Getter for.
MlpPositionList *	createPositionList ()
MlpPositionList *	getPositionList ()
	Getter for.
std::string	toString ()
Protected Attributes
std::string	_msgBody
std::string	_sessionId
std::string	_msgVersion
int	_msgType
std::string	_serviceVersion
int	_serviceType
int	_serviceResType
std::string	_reqId
std::string	_result
std::string	_resId
std::string	_addInfo
MlpHdr *	_hdr
MlpSubscriberList *	_subscriberList
MlpPositionList *	_positionList

---

Detailed Description

MlpMessage.

This class implements MLP message. It holds some message parameters and pointers to message header, subscriber list or position list.

---

Constructor & Destructor Documentation

MlpMessage::MlpMessage

(

)

Constructor.

Constructor

Constructor sets the default values of private parameters.

MlpMessage::~MlpMessage

(

)

Destructor.

Destructor

Deletes all parts of MLP message.

---

Member Function Documentation

MlpHdr * MlpMessage::createHdr

(

)

Create MlpHdr

MlpPositionList * MlpMessage::createPositionList

(

)

Generate MlpPositionList

MlpSubscriberList * MlpMessage::createSubscriberList

(

)

Generate MlpSubscriberList

std::string MlpMessage::getAddInfo

(

)

Get Info in case of error.

MlpHdr * MlpMessage::getMlpHdr

(

)

Getter for.

Getter for MlpHdr pointer

int MlpMessage::getMsgType

(

)

Getter for messager type.

Getter for message type

Returns MLP message type.

Returns:

MLP message type in form of integer value. (See MlpConstants.hpp )

std::string MlpMessage::getMsgVer

(

)

Getter for message version.

Getter for message version

Returns MLP message version.

Returns:

Mlp message version in form of std::string.

MlpPositionList * MlpMessage::getPositionList

(

)

Getter for.

Getter for MlpPositionList

std::string MlpMessage::getReqId

(

)

Getter for.

Getter for request id

std::string MlpMessage::getResId

(

)

Get result id in case of error.

std::string MlpMessage::getResult

(

)

Get result in case of error.

int MlpMessage::getServiceResType

(

)

Getter for.

Getter for service response type

int MlpMessage::getServiceType

(

)

Getter for.

Getter for service type

std::string MlpMessage::getServiceVer

(

)

Getter for.

Getter for service version

std::string MlpMessage::getSessionId

(

)

Getter for session ID.

Getter for session id

Returns session ID from MLP message.

Returns:

Session ID in form of std::string.

MlpSubscriberList * MlpMessage::getSubscriberList

(

)

Getter for.

Getter for MlpSubscriberList

void MlpMessage::setAddInfo

(

std::string

addInfo

)

Add Info in case of error.

void MlpMessage::setMsgType

(

int

type

)

Setter for message type.

Setter for message type

Sets the MLP message type.

Parameters:

type

MLP message type.

void MlpMessage::setMsgVer

(

std::string

ver

)

Setter for message version.

Setter for message version

Sets version of MLP message.

Parameters:

ver

MLP message version.

void MlpMessage::setReqId

(

std::string

reqId

)

Setter for.

Setter for request id

void MlpMessage::setResId

(

std::string

resId

)

Set result id in case of error.

void MlpMessage::setResult

(

std::string

result

)

Set result in case of error.

void MlpMessage::setServiceResType

(

int

responseType

)

Setter for.

Setter for service response type

void MlpMessage::setServiceType

(

int

type

)

Setter for.

Setter for service type

void MlpMessage::setServiceVer

(

std::string

ver

)

Setter for.

Setter for service version

void MlpMessage::setSessionId

(

std::string

sessionId

)

Setter for session ID.

Setter for session id

Sets session ID. Session ID is used to identify users that are sending requests.

Parameters:

sessionId

MLP session ID in form of std::string.

std::string MlpMessage::toString

(

)

Convert message to XML string

---

Member Data Documentation

std::string MlpMessage::_addInfo [protected]

add Info in case of error.

MlpHdr* MlpMessage::_hdr [protected]

Pointer to MlpHdr

std::string MlpMessage::_msgBody [protected]

int MlpMessage::_msgType [protected]

Message type

std::string MlpMessage::_msgVersion [protected]

Message version

MlpPositionList* MlpMessage::_positionList [protected]

Pointer to MlpPoistionList

std::string MlpMessage::_reqId [protected]

request ID

std::string MlpMessage::_resId [protected]

Result id in case of error.

std::string MlpMessage::_result [protected]

Result in case of message does not contain position.

int MlpMessage::_serviceResType [protected]

Service response type

int MlpMessage::_serviceType [protected]

Service type

std::string MlpMessage::_serviceVersion [protected]

Service version

std::string MlpMessage::_sessionId [protected]

Session ID

MlpSubscriberList* MlpMessage::_subscriberList [protected]

Pointer to MlpSubscriberList

---

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

• MlpMessage.hpp
• MlpMessage.cpp