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 "api/types/Socket/Socket.h"
00022 #include "api/types/Socket/TCPSocketConnection.h"
00023 
00024 /** TCP Server.
00025  *
00026  *
00027  *
00028  * NOTE: This class is not currently supported
00029  *
00030  *
00031  *
00032   */
00033 class TCPSocketServer : public Socket {
00034   public:
00035     /** Instantiate a TCP Server.
00036     */
00037     TCPSocketServer();
00038 
00039     /** Bind a socket to a specific port.
00040     \param port The port to listen for incoming connections on.
00041     \return 0 on success, -1 on failure.
00042     */
00043     int bind(int port);
00044 
00045     /** Start listening for incoming connections.
00046     \param backlog number of pending connections that can be queued up at any
00047                    one time [Default: 1].
00048     \return 0 on success, -1 on failure.
00049     */
00050     int listen(int backlog=1);
00051 
00052     /** Accept a new connection.
00053     \param connection A TCPSocketConnection instance that will handle the incoming connection.
00054     \return 0 on success, -1 on failure.
00055     */
00056     int accept(TCPSocketConnection& connection);
00057 };
00058 
00059 #endif