mirror of https://github.com/ARMmbed/mbed-os.git
130 lines
3.8 KiB
C++
130 lines
3.8 KiB
C++
|
|
/** \addtogroup netsocket */
|
|
/** @{*/
|
|
/* TCPSocket
|
|
* Copyright (c) 2015 ARM Limited
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef TCPSOCKET_H
|
|
#define TCPSOCKET_H
|
|
|
|
#include "netsocket/Socket.h"
|
|
#include "netsocket/NetworkStack.h"
|
|
#include "netsocket/NetworkInterface.h"
|
|
#include "rtos/Semaphore.h"
|
|
|
|
|
|
/** TCP socket connection
|
|
*/
|
|
class TCPSocket : public Socket {
|
|
public:
|
|
/** Create an uninitialized socket
|
|
*
|
|
* Must call open to initialize the socket on a network stack.
|
|
*/
|
|
TCPSocket();
|
|
|
|
/** Create a socket on a network interface
|
|
*
|
|
* Creates and opens a socket on the network stack of the given
|
|
* network interface.
|
|
*
|
|
* @param stack Network stack as target for socket
|
|
*/
|
|
template <typename S>
|
|
TCPSocket(S *stack)
|
|
: _pending(0), _read_sem(0), _write_sem(0),
|
|
_read_in_progress(false), _write_in_progress(false)
|
|
{
|
|
open(stack);
|
|
}
|
|
|
|
/** Destroy a socket
|
|
*
|
|
* Closes socket if the socket is still open
|
|
*/
|
|
virtual ~TCPSocket();
|
|
|
|
/** Connects TCP socket to a remote host
|
|
*
|
|
* Initiates a connection to a remote server specified by either
|
|
* a domain name or an IP address and a port.
|
|
*
|
|
* @param host Hostname of the remote host
|
|
* @param port Port of the remote host
|
|
* @return 0 on success, negative error code on failure
|
|
*/
|
|
int connect(const char *host, uint16_t port);
|
|
|
|
/** Connects TCP socket to a remote host
|
|
*
|
|
* Initiates a connection to a remote server specified by the
|
|
* indicated address.
|
|
*
|
|
* @param address The SocketAddress of the remote host
|
|
* @return 0 on success, negative error code on failure
|
|
*/
|
|
int connect(const SocketAddress &address);
|
|
|
|
/** Send data over a TCP socket
|
|
*
|
|
* The socket must be connected to a remote host. Returns the number of
|
|
* bytes sent from the buffer.
|
|
*
|
|
* By default, send blocks until data is sent. If socket is set to
|
|
* non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned
|
|
* immediately.
|
|
*
|
|
* @param data Buffer of data to send to the host
|
|
* @param size Size of the buffer in bytes
|
|
* @return Number of sent bytes on success, negative error
|
|
* code on failure
|
|
*/
|
|
int send(const void *data, unsigned size);
|
|
|
|
/** Receive data over a TCP socket
|
|
*
|
|
* The socket must be connected to a remote host. Returns the number of
|
|
* bytes received into the buffer.
|
|
*
|
|
* By default, recv blocks until data is sent. If socket is set to
|
|
* non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned
|
|
* immediately.
|
|
*
|
|
* @param data Destination buffer for data received from the host
|
|
* @param size Size of the buffer in bytes
|
|
* @return Number of received bytes on success, negative error
|
|
* code on failure
|
|
*/
|
|
int recv(void *data, unsigned size);
|
|
|
|
protected:
|
|
friend class TCPServer;
|
|
|
|
virtual nsapi_protocol_t get_proto();
|
|
virtual void event();
|
|
|
|
volatile unsigned _pending;
|
|
rtos::Semaphore _read_sem;
|
|
rtos::Semaphore _write_sem;
|
|
bool _read_in_progress;
|
|
bool _write_in_progress;
|
|
};
|
|
|
|
|
|
#endif
|
|
|
|
/** @}*/
|