Click here to Skip to main content
Click here to Skip to main content
Add your own
alternative version

Push Framework - A C++ toolkit for high performance server development

, 23 May 2012 Apache
Write asynchronous, multithreaded servers in a few lines of code. Monitor realtime activity with a deploy-only dashboard.
ChatApplication.zip
ChatAPI
ChatClient
res
.svn
entries
prop-base
ChatClient.ico.svn-base
props
text-base
ChatClient.ico.svn-base
ChatClient.rc2.svn-base
tmp
prop-base
props
text-base
ChatClient.ico
ChatPackets
ChatProtocol
ChatServer
ChatServer.vcproj.INTERNAL.Ahmed.Charfeddine.user
output
ChatServer.ini
TCPSocket
TCPSocket.zip
XMLProtocol
XMLProtocol.zip
ChatRobots.zip
ChatRobots
ChatRobots.ini
ProtoBufExample.zip
ProtoBufExampleClient
ProtoBufExampleProtocol
requests.pb.cc
responses.pb.cc
ProtoBufExampleServer
PushFramework_Essentials.zip
include
PushFramework.dll
PushFramework.lib
PushFramework_Sources.zip
private
QoS.zip
QoSExampleClient
QoSExampleProtocol
QoSExampleServer
/********************************************************************
	File :			Protocol.h
	Creation date :	2010/6/27
		
	License :			Copyright 2010 Ahmed Charfeddine, http://www.pushframework.com

				   Licensed under the Apache License, Version 2.0 (the "License");
				   you may not use this file except in compliance with the License.
				   You may obtain a copy of the License at
				
					   http://www.apache.org/licenses/LICENSE-2.0
				
				   Unless required by applicable law or agreed to in writing, software
				   distributed under the License is distributed on an "AS IS" BASIS,
				   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
				   See the License for the specific language governing permissions and
				   limitations under the License.
	
	
*********************************************************************/
#ifndef Protocol__INCLUDED
#define Protocol__INCLUDED

#pragma once

#include "PushFramework.h"
#include "DataBuffer.h"
namespace PushFramework{

class OutgoingPacket;
class IncomingPacket;


/**
	A subclass of this class defines a communication protocol between Push Framework and remote clients (or a category of remote
	clients if you are using multiple protocols). Server business code is expected to send responses in form of OutgoingPacket
	instances. The framework requests the protocol instance to serialize these instances by triggering encoding and framing jobs.
	Incoming data is handed to the de-serialization functions which in turns calls on user-defined deframing and decoding in order
	to construct the IncomingPacket instance and its accompanying service id.
	*/
class PUSHFRAMEWORK_API Protocol
{
public:
	typedef enum Result
	{
		Success = 0,
		eInsufficientBuffer,
		eIncompletePacket,
		eCorruptPacket,
		eEncodingFailure,
		eDecodingFailure,
		eUndefinedFailure,
		ePacketizingError,
	};

	/** @name TORs **/
	//@{
	Protocol(void);
	~Protocol(void);
	//@}

	/** @name Consumed by Push Framework internal code. **/
	int serializeOutgoingPacket(OutgoingPacket& packet, DataBuffer& buffer, unsigned int& nWrittenBytes);
	int tryDeserializeIncomingPacket(DataBuffer& buffer, IncomingPacket*& pPacket, int& serviceId, unsigned int& nExtractedBytes);
	//@}
public:
	/** @name Serialization. **/
	/**
		\param packet OutgoingPacket instance to encode.

		Override to encode the OutgoingPacket instance. Save the result into the same input.
	*/
	virtual int encodeOutgoingPacket(OutgoingPacket& packet) =  0;
	/**
	\param packet OutgoingPacket instance to encode.
	\param buffer Buffer to write the result to.
	\param nWrittenBytes Report the total bytes written.

		Override to write the encoded packet into the intermediate sending buffer.
	*/
	virtual int frameOutgoingPacket(OutgoingPacket& packet, DataBuffer& buffer, unsigned int& nWrittenBytes) = 0;
	//@}
	/** @name De-serialization. **/
	/**
	\param buffer to read data from.
	\param pPacket Reference to the output pointer that should store the address of the potentially created instance.
	\param serviceId Service id value used to route the created instance.
	\param nExtractedBytes Number of bytes extracted from the buffer.

	Override to deframe incoming packets from within the received bytes.
	*/
	virtual int tryDeframeIncomingPacket(DataBuffer& buffer, IncomingPacket*& pPacket, int& serviceId, unsigned int& nExtractedBytes) = 0;
	/**
	\param pPacket The previously deframed instance.
	\param serviceId Service id value used to route the created instance.

	Override to decode the created instance.
	*/
	virtual int decodeIncomingPacket(IncomingPacket* pPacket, int& serviceId) = 0;
	/**
	\param pPacket IncomingPacket instance to delete.

	Incoming requests are created by the Protocol at time of de-serialization. When the servicing job that treats
	a requests finishes, the instance is handed back to its creator for deletion. Developer can call on delete or
	any other way of releasing the instance if a pool of requests is organized.
	*/
	virtual void disposeIncomingPacket(IncomingPacket* pPacket) = 0;
	//@}

};

}

#endif // Protocol__INCLUDED

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Apache License, Version 2.0

Share

About the Author

Ahmed Charfeddine
Technical Lead
Tunisia Tunisia
Services:
http://www.pushframework.com/?page_id=890
Follow on   Twitter

| Advertise | Privacy | Terms of Use | Mobile
Web01 | 2.8.1411023.1 | Last Updated 23 May 2012
Article Copyright 2011 by Ahmed Charfeddine
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid