Foundry::Katana::CloseMessage Class Reference

The CloseMessage class encapsulates the message sent to Katana instructing it that there is no more data for the specified channel. More...

#include <CloseMessage.h>

Inheritance diagram for Foundry::Katana::CloseMessage:

List of all members.

Public Member Functions
	CloseMessage (const NewChannelMessage &channel)
	Create a new instance of a CloseMessage message that, when sent to Katana will let the Catalog Server know that there is no more data to be sent through for this specified channel.
	CloseMessage (const uint8_t *frameID, uint16_t channelID=0)
	Create a new instance of a CloseMessage message that, when sent to Katana will let the Catalog Server know that there is no more data to be sent through for this specified channel.

---

Detailed Description

The CloseMessage class encapsulates the message sent to Katana instructing it that there is no more data for the specified channel.

The CloseMessage message should only be sent down the pipe when no more data is to be sent for the channel.

It is un-likely you will ever need to directly instantiate this class as it is handled for you in the closeChannel method of the KatanaPipe.

See also:

KatanaPipe.

---

Constructor & Destructor Documentation

Foundry::Katana::CloseMessage::CloseMessage

(

const NewChannelMessage &

channel

)

[explicit]

Create a new instance of a CloseMessage message that, when sent to Katana will let the Catalog Server know that there is no more data to be sent through for this specified channel.

Parameters:

[in]

channel

the channel object that will be closed

Foundry::Katana::CloseMessage::CloseMessage	(	const uint8_t *	frameID,
		uint16_t	channelID = 0
	)		[explicit]

Create a new instance of a CloseMessage message that, when sent to Katana will let the Catalog Server know that there is no more data to be sent through for this specified channel.

Parameters:

[in]	frameID	a pointer to a 16 byte array containing a unique frameID
[in]	channelID	the channel ID for the channel that should be closed.

---

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

• CloseMessage.h