summaryrefslogtreecommitdiff
path: root/indra/newview/llattachmentsmgr.h
blob: c84229475a8932a332b065dc04607da3181879a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/** 
 * @file llattachmentsmgr.h
 * @brief Batches up attachment requests and sends them all
 * in one message.
 *
 * $LicenseInfo:firstyear=2004&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 * 
 * 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * 
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_LLATTACHMENTSMGR_H
#define LL_LLATTACHMENTSMGR_H

#include "llsingleton.h"

class LLViewerInventoryItem;

//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// LLAttachmentsMgr
// 
// The sole purpose of this class is to take attachment
// requests, queue them up, and send them all at once.
// This handles situations where the viewer may request
// a bunch of attachments at once in a short period of
// time, where each of the requests would normally be
// sent as a separate message versus being batched into
// one single message.
// 
// The intent of this batching is to reduce viewer->server
// traffic.
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
class LLAttachmentsMgr: public LLSingleton<LLAttachmentsMgr>
{
public:
	struct AttachmentsInfo
	{
		LLUUID mItemID;
		U8 mAttachmentPt;
		BOOL mAdd;
	};
	typedef std::vector<AttachmentsInfo> attachments_vec_t;

	LLAttachmentsMgr();
	virtual ~LLAttachmentsMgr();

	void addAttachmentRequest(const LLUUID& item_id,
                              const U8 attachment_pt,
                              const BOOL add);
	void requestAttachments(const attachments_vec_t& attachment_requests);
	static void onIdle(void *);

	BOOL attachmentWasRequestedRecently(const LLUUID& inv_item_id, F32 seconds) const;
	void addAttachmentRequestTime(const LLUUID& inv_item_id);
    void onAttachmentArrived(const LLUUID& inv_item_id);

private:
	void removeAttachmentRequestTime(const LLUUID& inv_item_id);
	void onIdle();
	void requestPendingAttachments();
	void linkRecentlyArrivedAttachments();

    // Attachments that we are planning to rez but haven't requested from the server yet.
	attachments_vec_t mPendingAttachments;

	// Attachments that have been requested from server but have not arrived yet.
	std::map<LLUUID,LLTimer> mAttachmentRequests;

    // Attachments that have arrived but have not been linked in the COF yet.
    std::set<LLUUID> mRecentlyArrivedAttachments;
    LLTimer mCOFLinkBatchTimer;
};

#endif