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