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 #ifndef TCPSOCKETSERVER_H
00019 #define TCPSOCKETSERVER_H
00020 
00021 #include "Socket/Socket.h"
00022 #include "TCPSocketConnection.h"
00023 
00024 class TCPSocketServer : public Socket {
00025   public:
00026     /** Instantiate a TCP Socket.
00027     */
00028     TCPSocketServer();
00029     
00030     ~TCPSocketServer();
00031     
00032     /** Bind a socket to a specific port.
00033     For a listening socket, bind the socket to the following port. The socket will start listening for incoming connections on this port on the call to listen().
00034     \param port The port to listen for incoming connections on.
00035     \return 0 on success, -1 on failure.
00036     */
00037     int bind(int port);
00038 
00039     /** Start listening for incoming connections.
00040     \param max The maximum number of connections that can be accepted.
00041     \return 0 on success, -1 on failure.
00042     */
00043     int listen(int max);
00044 
00045     /** Accept a new connection.
00046     \param socket A socket instance that will handle the incoming connection.
00047     \return 0 on success, -1 on failure.
00048     */
00049     int accept(TCPSocketConnection& connection, int timeout_ms=0);
00050 };
00051 
00052 #endif