dvmhost/modem/port/UDPPort.cpp

/**
* Digital Voice Modem - Host Software
* GPLv2 Open Source. Use is subject to license terms.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* @package DVM / Host Software
*
*/
//
// Based on code from the MMDVMHost project. (https://github.com/g4klx/MMDVMHost)
// Licensed under the GPLv2 License (https://opensource.org/licenses/GPL-2.0)
//
/*
*   Copyright (C) 2021 by Jonathan Naylor G4KLX
*   Copyright (C) 2021 by Bryan Biedenkapp N2PLL
*
*   This program is free software; you can redistribute it and/or modify
*   it under the terms of the GNU General Public License as published by
*   the Free Software Foundation; either version 2 of the License, or
*   (at your option) any later version.
*
*   This program is distributed in the hope that it will be useful,
*   but WITHOUT ANY WARRANTY; without even the implied warranty of
*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*   GNU General Public License for more details.
*
*   You should have received a copy of the GNU General Public License
*   along with this program; if not, write to the Free Software
*   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include "Defines.h"
#include "modem/port/UDPPort.h"
#include "Log.h"
#include "Utils.h"

using namespace modem::port;
using namespace network;

#include <cstring>
#include <cassert>

// ---------------------------------------------------------------------------
//  Constants
// ---------------------------------------------------------------------------

const uint32_t BUFFER_LENGTH = 2000U;

// ---------------------------------------------------------------------------
//  Public Class Members
// ---------------------------------------------------------------------------

/// <summary>
/// Initializes a new instance of the UDPPort class.
/// </summary>
/// <param name="address">Hostname/IP address to connect to.</param>
/// <param name="modemPort">Port number.</param>
/// <param name="master"></param>
UDPPort::UDPPort(const std::string& address, uint16_t modemPort) :
    m_socket(modemPort),
    m_addr(),
    m_addrLen(0U),
    m_buffer(2000U, "UDP Port Ring Buffer")
{
    assert(!address.empty());
    assert(modemPort > 0U);

    if (UDPSocket::lookup(address, modemPort, m_addr, m_addrLen) != 0)
        m_addrLen = 0U;

    if (m_addrLen > 0U) {
        std::string addrStr = UDPSocket::address(m_addr);
        LogWarning(LOG_HOST, "SECURITY: Remote modem expects IP address; %s for remote modem control", addrStr.c_str());
    }
}

/// <summary>
/// Finalizes a instance of the UDPPort class.
/// </summary>
UDPPort::~UDPPort()
{
    /* stub */
}

/// <summary>
/// Opens a connection to the port.
/// </summary>
/// <returns>True, if connection is opened, otherwise false.</returns>
bool UDPPort::open()
{
    if (m_addrLen == 0U) {
        LogError(LOG_NET, "Unable to resolve the address of the modem");
        return false;
    }

    return m_socket.open(m_addr);
}

/// <summary>
/// Reads data from the port.
/// </summary>
/// <param name="buffer">Buffer to read data from the port to.</param>
/// <param name="length">Length of data to read from the port.</param>
/// <returns>Actual length of data read from serial port.</returns>
int UDPPort::read(uint8_t* buffer, uint32_t length)
{
    assert(buffer != NULL);
    assert(length > 0U);

    uint8_t data[BUFFER_LENGTH];
    ::memset(data, 0x00U, BUFFER_LENGTH);

    sockaddr_storage addr;
    uint32_t addrLen;
    int ret = m_socket.read(data, BUFFER_LENGTH, addr, addrLen);

    // An error occurred on the socket
    if (ret < 0)
        return ret;

    // Add new data to the ring buffer
    if (ret > 0) {
        if (UDPSocket::match(addr, m_addr)) {
            m_buffer.addData(data, ret);
        }
        else {
            std::string addrStr = UDPSocket::address(addr);
            LogWarning(LOG_HOST, "SECURITY: Remote modem mode encountered invalid IP address; %s", addrStr.c_str());
        }
    }

    // Get required data from the ring buffer
    uint32_t avail = m_buffer.dataSize();
    if (avail < length)
        length = avail;

    if (length > 0U)
        m_buffer.getData(buffer, length);

    return int(length);
}

/// <summary>
/// Writes data to the port.
/// </summary>
/// <param name="buffer">Buffer containing data to write to port.</param>
/// <param name="length">Length of data to write to port.</param>
/// <returns>Actual length of data written to the port.</returns>
int UDPPort::write(const uint8_t* buffer, uint32_t length)
{
    assert(buffer != NULL);
    assert(length > 0U);

    return m_socket.write(buffer, length, m_addr, m_addrLen) ? int(length) : -1;
}

/// <summary>
/// Closes the connection to the port.
/// </summary>
void UDPPort::close()
{
    m_socket.close();
}