TPProto::ProtocolLayer Class Reference

Central lower layer class. More...

#include <protocollayer.h>

List of all members.

Public Member Functions
	ProtocolLayer ()
	Constructs object and sets up defaults.
	~ProtocolLayer ()
	Destructor, deletes contained objects.
void	setFrameCodec (FrameCodec *fc)
	Sets the FrameCodec Deletes the previous FrameCodec if any. If NULL is passed in, the default FrameCodec is created.
void	setFrameFactory (FrameFactory *ff)
	Sets the FrameFactory Deletes the previous FrameFactory if any. If NULL is passed in, the default FrameFactory is created.
void	setFrameBuilder (FrameBuilder *fb)
	Sets the FrameBuilder Deletes the previous FrameBuilder if any. If NULL is passed in, the default FrameBuilder is created.
FrameCodec *	getFrameCodec () const
	Gets the FrameCodec.
FrameFactory *	getFrameFactory () const
	Gets the FrameFactory.
FrameBuilder *	getFrameBuilder () const
	Gets the FrameBuilder.

---

Detailed Description

Central lower layer class.

The ProtocolLayer class centrally holds the pointers to the FrameCodec, FrameBuilder and FrameFactory. This class is then referenced by the three classes and provides access to them as necessary.

---

Constructor & Destructor Documentation

TPProto::ProtocolLayer::ProtocolLayer

(

)

Constructs object and sets up defaults.

Defaults are

• FrameFactory base impl
• FrameBuilder base impl
• FrameCodec.

References TPProto::FrameBuilder::setProtocolLayer(), TPProto::FrameFactory::setProtocolLayer(), and TPProto::FrameCodec::setProtocolLayer().

---

Member Function Documentation

FrameBuilder * TPProto::ProtocolLayer::getFrameBuilder

(

)

const

Gets the FrameBuilder.

Returns:

The FrameBuilder.

Referenced by TPProto::AdminLayer::AdminLayer(), and TPProto::GameLayer::GameLayer().

FrameCodec * TPProto::ProtocolLayer::getFrameCodec

(

)

const

Gets the FrameCodec.

Returns:

The FrameCodec.

Referenced by TPProto::CategoryCache::addCategory(), TPProto::DesignCache::addDesign(), TPProto::AdminLayer::AdminLayer(), TPProto::FrameBuilder::buildFrame(), TPProto::GameLayer::connect(), TPProto::AdminLayer::connect(), TPProto::GameLayer::createAccount(), TPProto::GameLayer::finishedTurn(), TPProto::GameLayer::GameLayer(), TPProto::CacheNoneMethod::getById(), TPProto::CacheNoneMethod::getIdList(), TPProto::GameLayer::getTimeRemaining(), TPProto::GameLayer::login(), TPProto::AdminLayer::login(), TPProto::DesignCache::modifyDesign(), TPProto::FrameBuilder::processCommandDescription(), TPProto::FrameBuilder::processObjectDescription(), TPProto::FrameBuilder::processOrderDescription(), TPProto::CategoryCache::removeCategory(), TPProto::DesignCache::removeDesign(), TPProto::AdminLayer::sendCommand(), TPProto::GameLayer::setEventLoop(), TPProto::AdminLayer::setEventLoop(), TPProto::GameLayer::setLogger(), TPProto::AdminLayer::setLogger(), TPProto::PlayerCache::update(), and TPProto::BoardCache::update().

FrameFactory * TPProto::ProtocolLayer::getFrameFactory

(

)

const

Gets the FrameFactory.

Returns:

The FrameFactory.

Referenced by TPProto::CategoryCache::addCategory(), TPProto::DesignCache::addDesign(), TPProto::FrameBuilder::buildFrame(), TPProto::GameLayer::connect(), TPProto::AdminLayer::connect(), TPProto::GameLayer::createAccount(), TPProto::ResourceCache::createGetByIdFrame(), TPProto::PropertyCache::createGetByIdFrame(), TPProto::PlayerCache::createGetByIdFrame(), TPProto::OrderDescCache::createGetByIdFrame(), TPProto::ObjectDescCache::createGetByIdFrame(), TPProto::ObjectCache::createGetByIdFrame(), TPProto::DesignCache::createGetByIdFrame(), TPProto::ComponentCache::createGetByIdFrame(), TPProto::CommandDescCache::createGetByIdFrame(), TPProto::CategoryCache::createGetByIdFrame(), TPProto::BoardCache::createGetByIdFrame(), TPProto::ResourceCache::createGetIdSequenceFrame(), TPProto::PropertyCache::createGetIdSequenceFrame(), TPProto::PlayerCache::createGetIdSequenceFrame(), TPProto::OrderDescCache::createGetIdSequenceFrame(), TPProto::ObjectDescCache::createGetIdSequenceFrame(), TPProto::ObjectCache::createGetIdSequenceFrame(), TPProto::DesignCache::createGetIdSequenceFrame(), TPProto::ComponentCache::createGetIdSequenceFrame(), TPProto::CommandDescCache::createGetIdSequenceFrame(), TPProto::CategoryCache::createGetIdSequenceFrame(), TPProto::BoardCache::createGetIdSequenceFrame(), TPProto::GameLayer::createMessage(), TPProto::GameLayer::finishedTurn(), TPProto::GameLayer::getTimeRemaining(), TPProto::GameLayer::login(), TPProto::AdminLayer::login(), TPProto::DesignCache::modifyDesign(), TPProto::CategoryCache::removeCategory(), TPProto::DesignCache::removeDesign(), TPProto::AdminLayer::sendCommand(), TPProto::PlayerCache::update(), and TPProto::BoardCache::update().

void TPProto::ProtocolLayer::setFrameBuilder

(

FrameBuilder *

fb

)

Sets the FrameBuilder Deletes the previous FrameBuilder if any. If NULL is passed in, the default FrameBuilder is created.

Parameters:

fb

The FrameBuilder, or NULL.

References TPProto::FrameBuilder::setProtocolLayer().

void TPProto::ProtocolLayer::setFrameCodec

(

FrameCodec *

fc

)

Sets the FrameCodec Deletes the previous FrameCodec if any. If NULL is passed in, the default FrameCodec is created.

Parameters:

fc

The FrameCodec, or NULL.

References TPProto::FrameCodec::setProtocolLayer().

void TPProto::ProtocolLayer::setFrameFactory

(

FrameFactory *

ff

)

Sets the FrameFactory Deletes the previous FrameFactory if any. If NULL is passed in, the default FrameFactory is created.

Parameters:

ff

The FrameFactory, or NULL.

References TPProto::FrameFactory::setProtocolLayer().

---

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

• tpproto/protocollayer.h
• tpproto/protocollayer.cpp