mirror of https://github.com/ARMmbed/mbed-os.git
128 lines
4.0 KiB
C++
128 lines
4.0 KiB
C++
|
|
/** \addtogroup netsocket */
|
|
/** @{*/
|
|
/* UDPSocket
|
|
* 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 UDPSOCKET_H
|
|
#define UDPSOCKET_H
|
|
|
|
#include "netsocket/Socket.h"
|
|
#include "netsocket/NetworkStack.h"
|
|
#include "netsocket/NetworkInterface.h"
|
|
#include "rtos/Semaphore.h"
|
|
|
|
|
|
/** UDP socket
|
|
*/
|
|
class UDPSocket : public Socket {
|
|
public:
|
|
/** Create an uninitialized socket
|
|
*
|
|
* Must call open to initialize the socket on a network stack.
|
|
*/
|
|
UDPSocket();
|
|
|
|
/** 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>
|
|
UDPSocket(S *stack)
|
|
: _pending(0), _read_sem(0), _write_sem(0)
|
|
{
|
|
open(stack);
|
|
}
|
|
|
|
/** Destroy a socket
|
|
*
|
|
* Closes socket if the socket is still open
|
|
*/
|
|
virtual ~UDPSocket();
|
|
|
|
/** Send a packet over a UDP socket
|
|
*
|
|
* Sends data to the specified address specified by either a domain name
|
|
* or an IP address and port. Returns the number of bytes sent from the
|
|
* buffer.
|
|
*
|
|
* By default, sendto blocks until data is sent. If socket is set to
|
|
* non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned
|
|
* immediately.
|
|
*
|
|
* @param host Hostname of the remote host
|
|
* @param port Port of the remote host
|
|
* @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
|
|
*/
|
|
nsapi_size_or_error_t sendto(const char *host, uint16_t port,
|
|
const void *data, nsapi_size_t size);
|
|
|
|
/** Send a packet over a UDP socket
|
|
*
|
|
* Sends data to the specified address. Returns the number of bytes
|
|
* sent from the buffer.
|
|
*
|
|
* By default, sendto blocks until data is sent. If socket is set to
|
|
* non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned
|
|
* immediately.
|
|
*
|
|
* @param address The SocketAddress of the remote host
|
|
* @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
|
|
*/
|
|
nsapi_size_or_error_t sendto(const SocketAddress &address,
|
|
const void *data, nsapi_size_t size);
|
|
|
|
/** Receive a packet over a UDP socket
|
|
*
|
|
* Receives data and stores the source address in address if address
|
|
* is not NULL. Returns the number of bytes received into the buffer.
|
|
*
|
|
* By default, recvfrom blocks until data is sent. If socket is set to
|
|
* non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned
|
|
* immediately.
|
|
*
|
|
* @param address Destination for the source address or NULL
|
|
* @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
|
|
*/
|
|
nsapi_size_or_error_t recvfrom(SocketAddress *address,
|
|
void *data, nsapi_size_t size);
|
|
|
|
protected:
|
|
virtual nsapi_protocol_t get_proto();
|
|
virtual void event();
|
|
|
|
volatile unsigned _pending;
|
|
rtos::Semaphore _read_sem;
|
|
rtos::Semaphore _write_sem;
|
|
};
|
|
|
|
|
|
#endif
|
|
|
|
/** @}*/
|