1 /* 2 * libjingle 3 * Copyright 2004--2005, Google Inc. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, 9 * this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright notice, 11 * this list of conditions and the following disclaimer in the documentation 12 * and/or other materials provided with the distribution. 13 * 3. The name of the author may not be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 19 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 */ 27 28 #ifndef TALK_BASE_SOCKETSERVER_H_ 29 #define TALK_BASE_SOCKETSERVER_H_ 30 31 #include "talk/base/socketfactory.h" 32 33 namespace talk_base { 34 35 class MessageQueue; 36 37 // Provides the ability to wait for activity on a set of sockets. The Thread 38 // class provides a nice wrapper on a socket server. 39 // 40 // The server is also a socket factory. The sockets it creates will be 41 // notified of asynchronous I/O from this server's Wait method. 42 class SocketServer : public SocketFactory { 43 public: 44 // When the socket server is installed into a Thread, this function is 45 // called to allow the socket server to use the thread's message queue for 46 // any messaging that it might need to perform. 47 virtual void SetMessageQueue(MessageQueue* queue) {} 48 49 // Sleeps until: 50 // 1) cms milliseconds have elapsed (unless cms == kForever) 51 // 2) WakeUp() is called 52 // While sleeping, I/O is performed if process_io is true. 53 virtual bool Wait(int cms, bool process_io) = 0; 54 55 // Causes the current wait (if one is in progress) to wake up. 56 virtual void WakeUp() = 0; 57 }; 58 59 } // namespace talk_base 60 61 #endif // TALK_BASE_SOCKETSERVER_H_ 62
