DongEun Koak / NetworkSocketAPI

NetworkSocketAPI

Dependencies:   DnsQuery

Dependents:   HelloWizFi250Interface

Fork of NetworkSocketAPI by NetworkSocketAPI

TCPServer.h@72:6a8b52ee83ed, 2016-04-05 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 05 05:40:43 2016 -0500
Revision:
72:6a8b52ee83ed
Child:
73:968f7b32278f
Added initial design for user-facing API

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Christopher Haster 72:6a8b52ee83ed 1 /* Copyright (C) 2012 mbed.org, MIT License
Christopher Haster 72:6a8b52ee83ed 2 *
Christopher Haster 72:6a8b52ee83ed 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
Christopher Haster 72:6a8b52ee83ed 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
Christopher Haster 72:6a8b52ee83ed 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
Christopher Haster 72:6a8b52ee83ed 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
Christopher Haster 72:6a8b52ee83ed 7 * furnished to do so, subject to the following conditions:
Christopher Haster 72:6a8b52ee83ed 8 *
Christopher Haster 72:6a8b52ee83ed 9 * The above copyright notice and this permission notice shall be included in all copies or
Christopher Haster 72:6a8b52ee83ed 10 * substantial portions of the Software.
Christopher Haster 72:6a8b52ee83ed 11 *
Christopher Haster 72:6a8b52ee83ed 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
Christopher Haster 72:6a8b52ee83ed 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Christopher Haster 72:6a8b52ee83ed 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
Christopher Haster 72:6a8b52ee83ed 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Christopher Haster 72:6a8b52ee83ed 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Christopher Haster 72:6a8b52ee83ed 17 */
Christopher Haster 72:6a8b52ee83ed 18 #ifndef TCPSERVER_H
Christopher Haster 72:6a8b52ee83ed 19 #define TCPSERVER_H
Christopher Haster 72:6a8b52ee83ed 20
Christopher Haster 72:6a8b52ee83ed 21 #include "Socket.h"
Christopher Haster 72:6a8b52ee83ed 22 #include "TCPSocket.h"
Christopher Haster 72:6a8b52ee83ed 23
Christopher Haster 72:6a8b52ee83ed 24 /** TCP Server.
Christopher Haster 72:6a8b52ee83ed 25 */
Christopher Haster 72:6a8b52ee83ed 26 class TCPServer : public Socket {
Christopher Haster 72:6a8b52ee83ed 27 public:
Christopher Haster 72:6a8b52ee83ed 28 /** TCP Server lifetime
Christopher Haster 72:6a8b52ee83ed 29 */
Christopher Haster 72:6a8b52ee83ed 30 TCPServer();
Christopher Haster 72:6a8b52ee83ed 31 ~TCPServer();
Christopher Haster 72:6a8b52ee83ed 32
Christopher Haster 72:6a8b52ee83ed 33 /** Bind a socket to a specific port
Christopher Haster 72:6a8b52ee83ed 34 \param port The port to listen for incoming connections on
Christopher Haster 72:6a8b52ee83ed 35 \return 0 on success, negative on failure
Christopher Haster 72:6a8b52ee83ed 36 */
Christopher Haster 72:6a8b52ee83ed 37 int bind(int port);
Christopher Haster 72:6a8b52ee83ed 38
Christopher Haster 72:6a8b52ee83ed 39 /** Start listening for incoming connections
Christopher Haster 72:6a8b52ee83ed 40 \param backlog Number of pending connections that can be queued up at any
Christopher Haster 72:6a8b52ee83ed 41 one time [Default: 1]
Christopher Haster 72:6a8b52ee83ed 42 \return 0 on success, negative on failure
Christopher Haster 72:6a8b52ee83ed 43 */
Christopher Haster 72:6a8b52ee83ed 44 int listen(int backlog=1);
Christopher Haster 72:6a8b52ee83ed 45
Christopher Haster 72:6a8b52ee83ed 46 /** Accept a new connection.
Christopher Haster 72:6a8b52ee83ed 47 \param socket A TCPSocket instance that will handle the incoming connection.
Christopher Haster 72:6a8b52ee83ed 48 \return 0 on success, negative on failure.
Christopher Haster 72:6a8b52ee83ed 49 */
Christopher Haster 72:6a8b52ee83ed 50 int accept(TCPSocket &connection);
Christopher Haster 72:6a8b52ee83ed 51 };
Christopher Haster 72:6a8b52ee83ed 52
Christopher Haster 72:6a8b52ee83ed 53 #endif