RetroShare/retroshare-gui/src/util/TokenQueue.h

/*
 * Token Queue.
 *
 * Copyright 2012-2012 by Robert Fernie, Christopher Evi-Parker
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License Version 2.1 as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA.
 *
 * Please report all bugs and problems to "retroshare@lunamutt.com".
 *
 */

#ifndef MRK_TOKEN_QUEUE_V2_H
#define MRK_TOKEN_QUEUE_V2_H

#include <QWidget>
#include <QTimer>
#include <QMutex>
#include <list>
#include <string>
#include <sys/time.h>

#include <gxs/rstokenservice.h>


#define COMPLETED_REQUEST		4

#define TOKENREQ_GROUPINFO		1
#define TOKENREQ_MSGINFO		2
#define TOKENREQ_MSGRELATEDINFO	        3


class TokenQueue;

class TokenRequest
{
public:
	uint32_t mToken;
	uint32_t mType;
	uint32_t mAnsType;
	uint32_t mUserType;
	struct timeval mRequestTs;
	struct timeval mPollTs;
};

class TokenResponse
{
public:
	//virtual ~TokenResponse() { return; }
	// These Functions are overloaded to get results out.
	virtual void loadRequest(const TokenQueue *queue, const TokenRequest &req) = 0;
};


/*!
 * An important thing to note is that all requests are stacked (so FIFO)
 * This is to prevent overlapped loads on GXS UIs
 */
class TokenQueue: public QObject
{
	Q_OBJECT

public:
	TokenQueue(RsTokenService *service, TokenResponse *resp);

	/* generic handling of token / response update behaviour */

	/*!
	 *
	 * @token the token to be redeem is assigned here
	 *
	 */
	bool requestGroupInfo(uint32_t &token, uint32_t anstype, const RsTokReqOptions &opts,
						  std::list<RsGxsGroupId>& ids, uint32_t usertype);

	bool requestGroupInfo(uint32_t &token, uint32_t anstype, const RsTokReqOptions &opts, uint32_t usertype);

	bool requestMsgInfo(uint32_t &token, uint32_t anstype, const RsTokReqOptions &opts,
						const std::list<RsGxsGroupId>& grpIds, uint32_t usertype);

	bool requestMsgInfo(uint32_t &token, uint32_t anstype, const RsTokReqOptions &opts,
						const GxsMsgReq& grpIds, uint32_t usertype);

	bool requestMsgRelatedInfo(uint32_t &token, uint32_t anstype,  const RsTokReqOptions &opts, const std::vector<RsGxsGrpMsgIdPair>& msgId, uint32_t usertype);

	bool cancelRequest(const uint32_t token);

	void queueRequest(uint32_t token, uint32_t basictype, uint32_t anstype, uint32_t usertype);
	bool checkForRequest(uint32_t token);
	void loadRequest(const TokenRequest &req);

	bool activeRequestExist(const uint32_t& userType);
	void activeRequestTokens(const uint32_t& userType, std::list<uint32_t>& tokens);

protected:
	void doPoll(float dt);

private slots:
	void pollRequests();

private:
	/* Info for Data Requests */
	std::list<TokenRequest> mRequests;

	RsTokenService *mService;
	TokenResponse *mResponder;
	QMutex mTokenMtx;

	QTimer *mTrigger;
};

#endif