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 /* Copyright (C) 2013 gsfan, MIT License
00019  *  port to the GainSpan Wi-FI module GS1011
00020  */
00021 #ifndef TCPSOCKETSERVER_H
00022 #define TCPSOCKETSERVER_H
00023 
00024 #include "Socket/Socket.h"
00025 #include "TCPSocketConnection.h"
00026 
00027 /** TCP Server.
00028   */
00029 class TCPSocketServer : public Socket {
00030   public:
00031     /** Instantiate a TCP Server.
00032     */
00033     TCPSocketServer();
00034     
00035     /** Bind a socket to a specific port.
00036     \param port The port to listen for incoming connections on.
00037     \return 0 on success, -1 on failure.
00038     */
00039     int bind(int port);
00040     
00041     /** Start listening for incoming connections.
00042     \param backlog number of pending connections that can be queued up at any
00043                    one time [Default: 1].
00044     \return 0 on success, -1 on failure.
00045     */
00046     int listen(int backlog=1);
00047     
00048     /** Accept a new connection.
00049     \param connection A TCPSocketConnection instance that will handle the incoming connection.
00050     \return 0 on success, -1 on failure.
00051     */
00052     int accept(TCPSocketConnection& connection);
00053 };
00054 
00055 #endif