TCPSocketServer.h

00001 /* Copyright (C) 2012 mbed.org, MIT License
00002  *
00003  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
00004  * and associated documentation files (the "Software"), to deal in the Software without restriction,
00005  * including without limitation the rights to use, copy, modify, merge, publish, distribute,
00006  * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
00007  * furnished to do so, subject to the following conditions:
00008  *
00009  * The above copyright notice and this permission notice shall be included in all copies or
00010  * substantial portions of the Software.
00011  *
00012  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
00013  * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00014  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
00015  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00016  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00017  *
00018  * Changes relative to mbed official version and others as identified
00019  * in the thread http://mbed.org/forum/team-165-components-community/topic/4844/?page=1#comment-24108
00020  * TCPSocketServer:
00021  * @li Improve documentation
00022  * @li revise timeout on store command from default to 5000 msec
00023  * @li reduced some of the C++ string processing for reduced memory
00024  * @li add support for non-blocking mode
00025  * @li derived from 4:0bcec6272784
00026  */
00027 #ifndef TCPSOCKETSERVER_H
00028 #define TCPSOCKETSERVER_H
00029 
00030 #include "Socket/Socket.h"
00031 #include "TCPSocketConnection.h"
00032 
00033 /** TCP Server.
00034   */
00035 class TCPSocketServer : public Socket {
00036   public:
00037     /** Instantiate a TCP Server.
00038     */
00039     TCPSocketServer();
00040     
00041     /** Bind a socket to a specific port.
00042     @param port The port to listen for incoming connections on.
00043     @return 0 on success, -1 on failure.
00044     */
00045     int bind(int port);
00046     
00047     /** Start listening for incoming connections.
00048     @param backlog number of pending connections that can be queued up at any
00049                    one time [Default: 1].
00050     @return 0 on success, -1 on failure.
00051     */
00052     int listen(int backlog=1);
00053     
00054     /** Accept a new connection.
00055     *
00056     * For the Wifly module, this looks for *OPEN* in the stream, and
00057     * then indicates success.
00058     *
00059     * @param connection A TCPSocketConnection instance that will handle the incoming connection.
00060     * @return 0 on success, -1 on failure.
00061     */
00062     int accept(TCPSocketConnection& connection);
00063     
00064   private:
00065     Timer acceptTimer;
00066     
00067     void acceptTimerStart();
00068     bool acceptTimeout();
00069     int acceptIndex;
00070 };
00071 
00072 #endif