Diff: features/netsocket/UDPSocket.h

Revision:

0:5b88d5760320

Child:

1:9db0e321a9f4

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/features/netsocket/UDPSocket.h	Tue Dec 17 23:23:45 2019 +0000
@@ -0,0 +1,184 @@
+
+/** \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/InternetSocket.h"
+#include "netsocket/NetworkStack.h"
+#include "netsocket/NetworkInterface.h"
+#include "rtos/EventFlags.h"
+
+
+/** UDP socket implementation.
+ */
+class UDPSocket : public InternetSocket {
+public:
+    /** Create an uninitialized socket.
+     *
+     *  @note Must call open to initialize the socket on a network stack.
+     */
+    UDPSocket();
+
+    /** Create and open a socket on the network stack of the given
+     *  network interface.
+     *
+     *  @tparam S    Type of the Network stack.
+     *  @param stack Network stack as target for socket.
+     *  @deprecated since mbed-os-5.11
+     */
+    template <typename S>
+    MBED_DEPRECATED_SINCE("mbed-os-5.11",
+                          "The UDPSocket(S *stack) constructor is deprecated"
+                          "It discards the open() call return value."
+                          "Use another constructor and call open() explicitly, instead.")
+    UDPSocket(S *stack)
+    {
+        open(stack);
+    }
+
+    /** Destroy a socket.
+     *
+     *  @note Closes socket if the socket is still open.
+     */
+    virtual ~UDPSocket();
+
+    /** Send data to the specified host and port.
+     *
+     *  By default, sendto blocks until data is sent. If socket is set to
+     *  nonblocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned
+     *  immediately.
+     *
+     *  @param host     Domain name of the remote host or a dotted notation IP address.
+     *  @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.
+     */
+    virtual nsapi_size_or_error_t sendto(const char *host, uint16_t port,
+                                         const void *data, nsapi_size_t size);
+
+    /** Send data to the specified address.
+     *
+     *  By default, sendto blocks until data is sent. If socket is set to
+     *  nonblocking 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.
+     */
+    virtual nsapi_size_or_error_t sendto(const SocketAddress &address,
+                                         const void *data, nsapi_size_t size);
+
+    /** Receive a datagram and store the source address in address if it's not NULL.
+     *
+     *  By default, recvfrom blocks until a datagram is received. If socket is set to
+     *  nonblocking or times out with no datagram, NSAPI_ERROR_WOULD_BLOCK
+     *  is returned.
+     *
+     *  @note If the datagram is larger than the buffer, the excess data is silently discarded.
+     *
+     *  @note If socket is connected, only packets coming from connected peer address
+     *  are accepted.
+     *
+     *  @note recvfrom() is allowed write to address and data buffers even if error occurs.
+     *
+     *  @param address  Destination for the source address or NULL.
+     *  @param data     Destination buffer for datagram received from the host.
+     *  @param size     Size of the buffer in bytes.
+     *  @return         Number of received bytes on success, negative error
+     *                  code on failure.
+     */
+    virtual nsapi_size_or_error_t recvfrom(SocketAddress *address,
+                                           void *data, nsapi_size_t size);
+
+    /** Set the remote address for next send() call and filtering
+     *  of incoming packets. To reset the address, zero initialized
+     *  SocketAddress must be in the address parameter.
+     *
+     *  @param address  The SocketAddress of the remote host.
+     *  @return         0 on success, negative error code on failure.
+     */
+    virtual nsapi_error_t connect(const SocketAddress &address);
+
+    /** Send a datagram to connected remote address.
+     *
+     *  By default, send blocks until all data is sent. If socket is set to
+     *  nonblocking or times out, a partial amount can be written.
+     *  NSAPI_ERROR_WOULD_BLOCK is returned if no data was written.
+     *
+     *  @note The socket must be connected to a remote host before send() call.
+     *
+     *  @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.
+     */
+    virtual nsapi_size_or_error_t send(const void *data, nsapi_size_t size);
+
+    /** Receive data from a socket.
+     *
+     *  This is equivalent to calling recvfrom(NULL, data, size).
+     *
+     *  If the socket is connected, only packets coming from a connected peer address
+     *  are accepted.
+     *
+     *  By default, recv blocks until some data is received. If socket is set to
+     *  nonblocking or times out, NSAPI_ERROR_WOULD_BLOCK can be returned to
+     *  indicate no data.
+     *
+     *  @note recv() is allowed write to data buffer even if error occurs.
+     *
+     *  @param data     Pointer to 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.
+     */
+    virtual nsapi_size_or_error_t recv(void *data, nsapi_size_t size);
+
+    /** Not implemented for UDP.
+     *
+     *  @param error      Not used.
+     *  @return           NSAPI_ERROR_UNSUPPORTED
+     */
+    virtual Socket *accept(nsapi_error_t *error = NULL);
+
+    /** Not implemented for UDP.
+     *
+     *  @param backlog    Not used.
+     *  @return           NSAPI_ERROR_UNSUPPORTED
+     */
+    virtual nsapi_error_t listen(int backlog = 1);
+
+#if !defined(DOXYGEN_ONLY)
+
+protected:
+    virtual nsapi_protocol_t get_proto();
+
+#endif //!defined(DOXYGEN_ONLY)
+};
+
+
+#endif
+
+/** @}*/