1f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch/* 2f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * libjingle 3f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * Copyright 2004--2005, Google Inc. 4f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * 5f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * Redistribution and use in source and binary forms, with or without 6f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * modification, are permitted provided that the following conditions are met: 7f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * 8f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * 1. Redistributions of source code must retain the above copyright notice, 9f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * this list of conditions and the following disclaimer. 10f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * 2. Redistributions in binary form must reproduce the above copyright notice, 11f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * this list of conditions and the following disclaimer in the documentation 12f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * and/or other materials provided with the distribution. 13f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * 3. The name of the author may not be used to endorse or promote products 14f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * derived from this software without specific prior written permission. 15f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * 16f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 17f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 18f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 19f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 20f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 21f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 22f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 23f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 24f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 25f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch */ 27f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 28f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#ifndef TALK_P2P_BASE_STUNREQUEST_H_ 29f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#define TALK_P2P_BASE_STUNREQUEST_H_ 30f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 31f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#include "talk/base/sigslot.h" 32f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#include "talk/base/thread.h" 33f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#include "talk/p2p/base/stun.h" 34f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#include <map> 35f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#include <string> 36f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 37f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochnamespace cricket { 38f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 39f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochclass StunRequest; 40f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 41f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// Manages a set of STUN requests, sending and resending until we receive a 42f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// response or determine that the request has timed out. 43f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochclass StunRequestManager { 44f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochpublic: 45f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch StunRequestManager(talk_base::Thread* thread); 46f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch ~StunRequestManager(); 47f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 48f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // Starts sending the given request (perhaps after a delay). 49f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch void Send(StunRequest* request); 50f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch void SendDelayed(StunRequest* request, int delay); 51f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 52f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // Removes a stun request that was added previously. This will happen 53f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // automatically when a request succeeds, fails, or times out. 54f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch void Remove(StunRequest* request); 55f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 56f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // Removes all stun requests that were added previously. 57f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch void Clear(); 58f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 59f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // Determines whether the given message is a response to one of the 60f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // outstanding requests, and if so, processes it appropriately. 61f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch bool CheckResponse(StunMessage* msg); 62f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch bool CheckResponse(const char* data, size_t size); 63f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 64f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // Raised when there are bytes to be sent. 65f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch sigslot::signal3<const void*, size_t, StunRequest*> SignalSendPacket; 66f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 67f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochprivate: 68f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch typedef std::map<std::string, StunRequest*> RequestMap; 69f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 70f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch talk_base::Thread* thread_; 71f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch RequestMap requests_; 72f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 73f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch friend class StunRequest; 74f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch}; 75f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 76f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// Represents an individual request to be sent. The STUN message can either be 77f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// constructed beforehand or built on demand. 78f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochclass StunRequest : public talk_base::MessageHandler { 79f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochpublic: 80f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch StunRequest(); 81f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch StunRequest(StunMessage* request); 82f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual ~StunRequest(); 83f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 84f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // Causes our wrapped StunMessage to be Prepared 85f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch void Construct(); 86f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 87f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // The manager handling this request (if it has been scheduled for sending). 88f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch StunRequestManager* manager() { return manager_; } 89f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 90f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // Returns the transaction ID of this request. 91f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch const std::string& id() { return id_; } 92f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 93f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // Returns the STUN type of the request message. 943345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick StunMessageType type(); 95f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 96f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // Handles messages for sending and timeout. 97f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch void OnMessage(talk_base::Message* pmsg); 98f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 99f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // Time elapsed since last send (in ms) 100f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch uint32 Elapsed() const; 101f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 102f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochprotected: 103f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch int count_; 104f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch bool timeout_; 105f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 106f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // Fills in a request object to be sent. Note that request's transaction ID 107f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // will already be set and cannot be changed. 108f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual void Prepare(StunMessage* request) {} 109f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 110f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // Called when the message receives a response or times out. 111f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual void OnResponse(StunMessage* response) {} 112f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual void OnErrorResponse(StunMessage* response) {} 113f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual void OnTimeout() {} 114f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual int GetNextDelay(); 115f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 116f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochprivate: 117f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch StunRequestManager* manager_; 118f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch std::string id_; 119f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch StunMessage* msg_; 120f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch uint32 tstamp_; 121f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 122f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch void set_manager(StunRequestManager* manager); 123f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 124f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch friend class StunRequestManager; 125f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch}; 126f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 127f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch} // namespace cricket 128f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 129f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#endif // TALK_P2P_BASE_STUNREQUEST_H_ 130