EthernetUdp.h

/*
 * Copyright (c) 2020 Teknic, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/*
    \file EthernetUdp.h
**/

#ifndef __ETHERNETUDP_H__
#define __ETHERNETUDP_H__

#include "IpAddress.h"
#include "lwip/udp.h"

namespace ClearCore {

class EthernetUdp {

public:
#ifndef HIDE_FROM_DOXYGEN

    typedef struct {
        struct udp_pcb *pcb; 
        struct pbuf *packet; 
        uint16_t available;  
        ip_addr_t remoteIp;  
        u16_t remotePort;    
    } UdpData;
#endif // !HIDE_FROM_DOXYGEN

    EthernetUdp();

    bool Begin(uint16_t localPort);

    void End();

    bool Connect(IpAddress remoteIp, uint16_t remotePort);

    bool PacketSend();

    uint32_t PacketWrite(uint8_t c);

    uint32_t PacketWrite(const char *nullTermStr);

    uint32_t PacketWrite(const uint8_t *buffer, uint32_t size);

    uint16_t PacketParse();

    uint16_t BytesAvailable();

    int32_t PacketRead(unsigned char *dataPtr, uint16_t len);

    int16_t Peek();

    void PacketFlush();

    IpAddress RemoteIp();

    uint16_t RemotePort();

private:
    UdpData m_udpData;
    uint16_t m_udpLocalPort;

    struct pbuf *m_outgoingPacket;

    struct pbuf *m_incomingPacket;
    uint16_t m_udpBytesAvailable;
    IpAddress m_udpRemoteIpReceived;
    uint16_t m_udpRemotePortReceived;
    IpAddress m_udpRemoteIpDestination;
    uint16_t m_udpRemotePortDestination;

    // Begin() was called.
    bool m_initialized;
    // Connect() was called and we can write to a packet.
    bool m_packetBegun;
    // PacketWrite() was called and we can send a packet.
    bool m_packetReadyToSend;
    // PacketParse() was called and we can read a packet.
    bool m_packetParsed;

    uint16_t UdpPacketRead(pbuf *packet, uint16_t *available,
                           unsigned char *buffer, uint16_t size);
}; // EthernetUdp

#ifndef HIDE_FROM_DOXYGEN

void UdpReceive(void *arg, struct udp_pcb *pcb, struct pbuf *p,
                const ip_addr_t *addr, u16_t port);

#endif // !HIDE_FROM_DOXYGEN
} // ClearCore namespace
#endif // !__ETHERNETUDP_H__