eoMessageHandler Class Reference

#include <eoMessageHandler.h>

Public Member Functions
eoReturn	ProcessTelegram (eoTelegram &tel, eoMessage &msg)
eoReturn	ProcessTelegram (eoTelegram &tel, eoReManMessage &msg)
eoReturn	ProcessTelegram (eoTelegram &tel, eoMaintenanceMessage &msg)
void	CleanUpChainerLists ()
eoReturn	ComposeChainedMessage (const eoMessage &msg, eoGateway &gateway)
eoReturn	ComposeChainedMessage (const eoMaintenanceMessage &msg, eoGateway &gateway)
eoReturn	ComposeChainedMessage (const eoReManMessage &reMsg, eoGateway &gateway, bool shallBeRepeated=false)

Detailed Description

Helper class converting telegrams to messages and chaining.

Member Function Documentation

CleanUpChainerLists()

void eoMessageHandler::CleanUpChainerLists

(

)

Calls the CleanUpList() function of each Message Chainer to delete eoChainedMessages that are timed out

Returns

ComposeChainedMessage() [1/3]

eoReturn eoMessageHandler::ComposeChainedMessage	(	const eoMessage &	msg,
		eoGateway &	gateway
	)

Sends a long eoMessage in multiple telegrams

Parameters

msg	eoMessage to be sent
gateway	The eoGateway the telegrams are to be sent with

Returns

ComposeChainedMessage() [2/3]

eoReturn eoMessageHandler::ComposeChainedMessage	(	const eoMaintenanceMessage &	msg,
		eoGateway &	gateway
	)

Sends a eoMaintenanceMessage

Parameters

msg	eoMaintenanceMessage to be sent
gateway	The eoGateway the telegrams are to be sent with

Returns

ComposeChainedMessage() [3/3]

eoReturn eoMessageHandler::ComposeChainedMessage	(	const eoReManMessage &	reMsg,
		eoGateway &	gateway,
		bool	shallBeRepeated = false
	)

Sends a long eoReManMessage in multiple telegrams

Parameters

reMsg	eoReManMessage
gateway	The eoGateway the telegrams are to be sent with

Returns

ProcessTelegram() [1/3]

eoReturn eoMessageHandler::ProcessTelegram	(	eoTelegram &	tel,
		eoMessage &	msg
	)

Processes a telegram that is part of a chained message

Parameters

tel	incoming telegram
msg	resulting eoMessage

Returns

ProcessTelegram() [2/3]

eoReturn eoMessageHandler::ProcessTelegram	(	eoTelegram &	tel,
		eoReManMessage &	msg
	)

Processes a telegram that is part of a chained message

Parameters

tel	incoming telegram
msg	resulting eoReManMessage

Returns

ProcessTelegram() [3/3]

eoReturn eoMessageHandler::ProcessTelegram	(	eoTelegram &	tel,
		eoMaintenanceMessage &	msg
	)

Processes a telegram that is part of a chained message

Parameters

tel	incoming telegram
msg	resulting eoReManMessage

Returns