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 28dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#ifndef TALK_BASE_SOCKETPOOL_H_ 29dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#define TALK_BASE_SOCKETPOOL_H_ 30f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 31f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#include <deque> 32f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#include <list> 33f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#include "talk/base/logging.h" 34f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#include "talk/base/sigslot.h" 35f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#include "talk/base/socketaddress.h" 36f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 37f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochnamespace talk_base { 38f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 39f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochclass AsyncSocket; 40f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochclass LoggingAdapter; 41f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochclass SocketFactory; 42f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochclass SocketStream; 43f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochclass StreamInterface; 44f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 45f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch////////////////////////////////////////////////////////////////////// 46f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// StreamPool 47f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch////////////////////////////////////////////////////////////////////// 48f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 49f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochclass StreamPool { 50f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochpublic: 51f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual ~StreamPool() { } 52f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 53f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual StreamInterface* RequestConnectedStream(const SocketAddress& remote, 54f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch int* err) = 0; 55f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual void ReturnConnectedStream(StreamInterface* stream) = 0; 56f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch}; 57f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 58f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch/////////////////////////////////////////////////////////////////////////////// 59f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// StreamCache - Caches a set of open streams, defers creation/destruction to 60f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// the supplied StreamPool. 61f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch/////////////////////////////////////////////////////////////////////////////// 62f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 63f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochclass StreamCache : public StreamPool, public sigslot::has_slots<> { 64f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochpublic: 65f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch StreamCache(StreamPool* pool); 66f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual ~StreamCache(); 67f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 68f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // StreamPool Interface 69f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual StreamInterface* RequestConnectedStream(const SocketAddress& remote, 70f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch int* err); 71f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual void ReturnConnectedStream(StreamInterface* stream); 72f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 73f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochprivate: 74f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch typedef std::pair<SocketAddress, StreamInterface*> ConnectedStream; 75f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch typedef std::list<ConnectedStream> ConnectedList; 76f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 77f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch void OnStreamEvent(StreamInterface* stream, int events, int err); 78f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 79f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // We delegate stream creation and deletion to this pool. 80f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch StreamPool* pool_; 81f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // Streams that are in use (returned from RequestConnectedStream). 82f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch ConnectedList active_; 83f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // Streams which were returned to us, but are still open. 84f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch ConnectedList cached_; 85f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch}; 86f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 87f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch/////////////////////////////////////////////////////////////////////////////// 88f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// NewSocketPool 89f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// Creates a new stream on every request 90f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch/////////////////////////////////////////////////////////////////////////////// 91f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 92f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochclass NewSocketPool : public StreamPool { 93f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochpublic: 94f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch NewSocketPool(SocketFactory* factory); 95f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual ~NewSocketPool(); 96f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 97f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // StreamPool Interface 98f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual StreamInterface* RequestConnectedStream(const SocketAddress& remote, 99f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch int* err); 100f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual void ReturnConnectedStream(StreamInterface* stream); 101f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 102f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochprivate: 103f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch SocketFactory* factory_; 104f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch}; 105f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 106f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch/////////////////////////////////////////////////////////////////////////////// 107f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// ReuseSocketPool 108f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// Maintains a single socket at a time, and will reuse it without closing if 109f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// the destination address is the same. 110f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch/////////////////////////////////////////////////////////////////////////////// 111f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 112f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochclass ReuseSocketPool : public StreamPool, public sigslot::has_slots<> { 113f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochpublic: 114f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch ReuseSocketPool(SocketFactory* factory); 115f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual ~ReuseSocketPool(); 116f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 117f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // StreamPool Interface 118f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual StreamInterface* RequestConnectedStream(const SocketAddress& remote, 119f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch int* err); 120f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual void ReturnConnectedStream(StreamInterface* stream); 121f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 122f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochprivate: 123f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch void OnStreamEvent(StreamInterface* stream, int events, int err); 124f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 125f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch SocketFactory* factory_; 126f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch SocketStream* stream_; 127f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch SocketAddress remote_; 128f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch bool checked_out_; // Whether the stream is currently checked out 129f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch}; 130f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 131f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch/////////////////////////////////////////////////////////////////////////////// 132f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// LoggingPoolAdapter - Adapts a StreamPool to supply streams with attached 133f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// LoggingAdapters. 134f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch/////////////////////////////////////////////////////////////////////////////// 135f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 136f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochclass LoggingPoolAdapter : public StreamPool { 137f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochpublic: 138f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch LoggingPoolAdapter(StreamPool* pool, LoggingSeverity level, 139f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch const std::string& label, bool binary_mode); 140f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual ~LoggingPoolAdapter(); 141f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 142f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // StreamPool Interface 143f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual StreamInterface* RequestConnectedStream(const SocketAddress& remote, 144f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch int* err); 145f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual void ReturnConnectedStream(StreamInterface* stream); 146f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 147f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochprivate: 148f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch StreamPool* pool_; 149f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch LoggingSeverity level_; 150f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch std::string label_; 151f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch bool binary_mode_; 152f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch typedef std::deque<LoggingAdapter*> StreamList; 153f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch StreamList recycle_bin_; 154f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch}; 155f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 156f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch////////////////////////////////////////////////////////////////////// 157f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 158dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen} // namespace talk_base 159f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 160dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#endif // TALK_BASE_SOCKETPOOL_H_ 161