InternetSocket.h

 
/** \addtogroup NetSocket */
/** @{*/
/* Socket
 * Copyright (c) 2015 ARM Limited
 * SPDX-License-Identifier: Apache-2.0
 *
 * 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 INTERNETSOCKET_H
#define INTERNETSOCKET_H
 
#include "netsocket/Socket.h"
#include "netsocket/NetworkStack.h"
#include "rtos/Mutex.h"
#include "rtos/EventFlags.h"
#include "Callback.h"
#include "mbed_atomic.h"
#include "mbed_toolchain.h"
#include "SocketStats.h"
 
/** Socket implementation that uses IP network stack.
 * Not to be directly used by applications. Cannot be directly instantiated.
 */
class InternetSocket : public Socket {
public:
    /** Destroy the socket.
     *
     *  @note Closes socket if it's still open.
     */
    ~InternetSocket() override;
 
    /** Open a network socket on the network stack of the given
     *  network interface.
     *
     *  @note Not needed if stack is passed to the socket's constructor.
     *
     *  @param stack    Network stack as target for socket.
     *  @retval         NSAPI_ERROR_OK on success.
     *  @retval         NSAPI_ERROR_PARAMETER in case the provided stack was invalid
     *                  or a stack was already created and socket opened successfully.
     *  @retval         int negative error codes for stack-related failures.
     *                  See @ref NetworkStack::socket_open.
     */
    nsapi_error_t open(NetworkStack *stack);
 
#if !defined(DOXYGEN_ONLY)
    template <typename S>
    nsapi_error_t open(S *stack)
    {
        return open(nsapi_create_stack(stack));
    }
#endif //!defined(DOXYGEN_ONLY)
 
    /** Close any open connection, and deallocate any memory associated
     *  with the socket. Called from destructor if socket is not closed.
     *
     *  @retval         NSAPI_ERROR_OK on success.
     *  @retval         NSAPI_ERROR_NO_SOCKET if socket is not open.
     *  @retval         int negative error codes for stack-related failures.
     *                  See @ref NetworkStack::socket_close.
     */
    nsapi_error_t close() override;
 
    /** Subscribe to an IP multicast group.
     *
     * @param address   Multicast group IP address.
     *  @return         NSAPI_ERROR_OK on success, negative error code on failure (@see InternetSocket::setsockopt).
     */
    int join_multicast_group(const SocketAddress &address);
 
    /** Leave an IP multicast group.
     *
     * @param address   Multicast group IP address.
     *  @return         NSAPI_ERROR_OK on success, negative error code on failure (@see InternetSocket::setsockopt).
     */
    int leave_multicast_group(const SocketAddress &address);
 
    /** Get estimated round trip time to destination address.
     *
     * Use estimated round trip time to adjust application retry timers to work in networks
     * that have low data rate and high latency.
     *
     * @param address   Destination address to use in rtt estimate.
     * @param rtt_estimate   Returned round trip time value in milliseconds.
     *  @return         NSAPI_ERROR_OK on success.
     *  @return         NSAPI_ERROR_PARAMETER if the provided pointer is invalid.
     *  @return         negative error code on other failures (@see InternetSocket::getsockopt).
     */
    int get_rtt_estimate_to_address(const SocketAddress &address, uint32_t *rtt_estimate);
 
    /** Get estimated stagger value.
     *
     * Stagger value is a time that application should wait before using heavy network operations after connecting to network.
     * Purpose of staggering is to avoid network congestion that may happen in low bandwith networks if multiple
     * applications simultaneously start heavy network usage after joining to the network.
     *
     * @param address       Destination added used to estimate stagger value.
     * @param data_amount   Amount of bytes to transfer in kilobytes.
     * @param stagger_min   Minimum stagger value in seconds.
     * @param stagger_max   Maximum stagger value in seconds.
     * @param stagger_rand  Randomized stagger value between stagger_min and stagger_max in seconds.
     * @return              NSAPI_ERROR_OK on success.
     * @return              negative error code on other failures (@see InternetSocket::getsockopt).
     */
    int get_stagger_estimate_to_address(const SocketAddress &address, uint16_t data_amount, uint16_t *stagger_min, uint16_t *stagger_max, uint16_t *stagger_rand);
 
    /** Bind the socket to a port on which to receive data.
     *
     *  @param port     Local port to bind.
     *  @retval         NSAPI_ERROR_OK on success.
     *  @retval         NSAPI_ERROR_NO_SOCKET if socket is not open.
     *  @retval         int negative error codes for stack-related failures.
     *                  See @ref NetworkStack::socket_bind.
     */
    nsapi_error_t bind(uint16_t port);
 
    /** @copydoc Socket::bind
     */
    nsapi_error_t bind(const SocketAddress &address) override;
 
    /** @copydoc Socket::set_blocking
     */
    void set_blocking(bool blocking) override;
 
    /** @copydoc Socket::set_timeout
     */
    void set_timeout(int timeout) override;
 
    /** @copydoc Socket::setsockopt
     */
    nsapi_error_t setsockopt(int level, int optname, const void *optval, unsigned optlen) override;
 
    /** @copydoc Socket::getsockopt
     */
    nsapi_error_t getsockopt(int level, int optname, void *optval, unsigned *optlen) override;
 
    /** @copydoc Socket::sigio
     */
    void sigio(mbed::Callback<void()> func) override;
 
    /** @copydoc Socket::getpeername
     */
    nsapi_error_t getpeername(SocketAddress *address) override;
 
 
#if !defined(DOXYGEN_ONLY)
 
protected:
    InternetSocket();
    virtual nsapi_protocol_t get_proto() = 0;
    void event();
    int modify_multicast_group(const SocketAddress &address, nsapi_socket_option_t socketopt);
    char _interface_name[NSAPI_INTERFACE_NAME_MAX_SIZE];
    NetworkStack *_stack = nullptr;
    nsapi_socket_t _socket = nullptr;
    uint32_t _timeout = osWaitForever;
    mbed::Callback<void()> _event;
    mbed::Callback<void()> _callback;
    rtos::EventFlags _event_flag;
    rtos::Mutex _lock;
    SocketAddress _remote_peer;
    uint8_t _readers = 0;
    uint8_t _writers = 0;
    core_util_atomic_flag _pending = CORE_UTIL_ATOMIC_FLAG_INIT;
    bool _factory_allocated = false;
 
    // Event flags
    static const int READ_FLAG     = 0x1u;
    static const int WRITE_FLAG    = 0x2u;
    static const int FINISHED_FLAG = 0x3u;
 
    friend class DTLSSocket;  // Allow DTLSSocket::connect() to do name resolution on the _stack
    SocketStats _socket_stats;
 
#endif //!defined(DOXYGEN_ONLY)
};
 
#endif // INTERNETSOCKET_H
 
/** @}*/