Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/netsocket/TCPServer.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1 /*
kenjiArai 0:5b88d5760320 2 * Copyright (c) 2015 ARM Limited
kenjiArai 0:5b88d5760320 3 *
kenjiArai 0:5b88d5760320 4 * Licensed under the Apache License, Version 2.0 (the "License");
kenjiArai 0:5b88d5760320 5 * you may not use this file except in compliance with the License.
kenjiArai 0:5b88d5760320 6 * You may obtain a copy of the License at
kenjiArai 0:5b88d5760320 7 *
kenjiArai 0:5b88d5760320 8 * http://www.apache.org/licenses/LICENSE-2.0
kenjiArai 0:5b88d5760320 9 *
kenjiArai 0:5b88d5760320 10 * Unless required by applicable law or agreed to in writing, software
kenjiArai 0:5b88d5760320 11 * distributed under the License is distributed on an "AS IS" BASIS,
kenjiArai 0:5b88d5760320 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kenjiArai 0:5b88d5760320 13 * See the License for the specific language governing permissions and
kenjiArai 0:5b88d5760320 14 * limitations under the License.
kenjiArai 0:5b88d5760320 15 */
kenjiArai 0:5b88d5760320 16
kenjiArai 0:5b88d5760320 17 /** @file TCPServer.h Deprecated TCPServer class */
kenjiArai 0:5b88d5760320 18 /** \addtogroup netsocket
kenjiArai 0:5b88d5760320 19 * @{*/
kenjiArai 0:5b88d5760320 20
kenjiArai 0:5b88d5760320 21 #ifndef TCPSERVER_H
kenjiArai 0:5b88d5760320 22 #define TCPSERVER_H
kenjiArai 0:5b88d5760320 23
kenjiArai 0:5b88d5760320 24 #include "netsocket/InternetSocket.h"
kenjiArai 0:5b88d5760320 25 #include "netsocket/TCPSocket.h"
kenjiArai 0:5b88d5760320 26 #include "netsocket/NetworkStack.h"
kenjiArai 0:5b88d5760320 27 #include "netsocket/NetworkInterface.h"
kenjiArai 0:5b88d5760320 28
kenjiArai 0:5b88d5760320 29
kenjiArai 0:5b88d5760320 30 /** TCP socket server
kenjiArai 0:5b88d5760320 31 */
kenjiArai 0:5b88d5760320 32 class TCPServer : public TCPSocket {
kenjiArai 0:5b88d5760320 33 public:
kenjiArai 0:5b88d5760320 34 /** Create an uninitialized socket
kenjiArai 0:5b88d5760320 35 *
kenjiArai 0:5b88d5760320 36 * Must call open to initialize the socket on a network stack.
kenjiArai 0:5b88d5760320 37 */
kenjiArai 0:5b88d5760320 38 MBED_DEPRECATED_SINCE("mbed-os-5.10",
kenjiArai 0:5b88d5760320 39 "TCPServer is deprecated, use TCPSocket")
kenjiArai 0:5b88d5760320 40 TCPServer();
kenjiArai 0:5b88d5760320 41
kenjiArai 0:5b88d5760320 42 /** Create a socket on a network interface
kenjiArai 0:5b88d5760320 43 *
kenjiArai 0:5b88d5760320 44 * Creates and opens a socket on the network stack of the given
kenjiArai 0:5b88d5760320 45 * network interface.
kenjiArai 0:5b88d5760320 46 *
kenjiArai 0:5b88d5760320 47 * @param stack Network stack as target for socket
kenjiArai 0:5b88d5760320 48 */
kenjiArai 0:5b88d5760320 49 template <typename S>
kenjiArai 0:5b88d5760320 50 MBED_DEPRECATED_SINCE("mbed-os-5.10",
kenjiArai 0:5b88d5760320 51 "TCPServer is deprecated, use TCPSocket")
kenjiArai 0:5b88d5760320 52 TCPServer(S *stack)
kenjiArai 0:5b88d5760320 53 {
kenjiArai 0:5b88d5760320 54 open(stack);
kenjiArai 0:5b88d5760320 55 }
kenjiArai 0:5b88d5760320 56
kenjiArai 0:5b88d5760320 57 /** Destroy a socket
kenjiArai 0:5b88d5760320 58 *
kenjiArai 0:5b88d5760320 59 * Closes socket if the socket is still open
kenjiArai 0:5b88d5760320 60 */
kenjiArai 0:5b88d5760320 61 virtual ~TCPServer();
kenjiArai 0:5b88d5760320 62
kenjiArai 0:5b88d5760320 63 // Allow legacy TCPServer::accept() to override inherited Socket::accept()
kenjiArai 0:5b88d5760320 64 using TCPSocket::accept;
kenjiArai 0:5b88d5760320 65
kenjiArai 0:5b88d5760320 66 /** Accepts a connection on a TCP socket
kenjiArai 0:5b88d5760320 67 *
kenjiArai 0:5b88d5760320 68 * The server socket must be bound and set to listen for connections.
kenjiArai 0:5b88d5760320 69 * On a new connection, creates a network socket using the specified
kenjiArai 0:5b88d5760320 70 * socket instance.
kenjiArai 0:5b88d5760320 71 *
kenjiArai 0:5b88d5760320 72 * By default, accept blocks until data is sent. If socket is set to
kenjiArai 0:5b88d5760320 73 * non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned
kenjiArai 0:5b88d5760320 74 * immediately.
kenjiArai 0:5b88d5760320 75 *
kenjiArai 0:5b88d5760320 76 * @param connection TCPSocket instance that will handle the incoming connection.
kenjiArai 0:5b88d5760320 77 * @param address Destination for the remote address or NULL
kenjiArai 0:5b88d5760320 78 * @return 0 on success, negative error code on failure
kenjiArai 0:5b88d5760320 79 */
kenjiArai 0:5b88d5760320 80 MBED_DEPRECATED_SINCE("mbed-os-5.10",
kenjiArai 0:5b88d5760320 81 "TCPServer::accept() is deprecated, use Socket *Socket::accept() instead")
kenjiArai 0:5b88d5760320 82 nsapi_error_t accept(TCPSocket *connection, SocketAddress *address = NULL);
kenjiArai 0:5b88d5760320 83 };
kenjiArai 0:5b88d5760320 84
kenjiArai 0:5b88d5760320 85 #endif
kenjiArai 0:5b88d5760320 86
kenjiArai 0:5b88d5760320 87 /** @} */