EthernetTcpClient.h

Go to the documentation of this file.

/*
 * 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.
 */

#ifndef __ETHERNETTCPCLIENT_H__
#define __ETHERNETTCPCLIENT_H__

#include <stdint.h>
#include "EthernetTcp.h"
#include "IpAddress.h"

namespace ClearCore {

#define TCP_CONNECTION_TIMEOUT_MIN 100

#define TCP_CONNECTION_TIMEOUT_MAX 15000

class EthernetTcpClient : public EthernetTcp {

public:
#ifndef HIDE_FROM_DOXYGEN

    EthernetTcpClient();

    explicit EthernetTcpClient(TcpData *tcpData);
#endif // !HIDE_FROM_DOXYGEN

    bool Connect(IpAddress ip, uint16_t port);

    bool Connected();

    int16_t BytesAvailable();

    int16_t Read();

    int16_t Read(uint8_t *dataPtr, uint32_t length);

    int16_t Peek();

    void Flush();

    void FlushInput();

    void Close();

    uint32_t Send(const uint8_t *buff, uint32_t size) override;

    uint32_t Send(uint8_t charToSend) {
        return EthernetTcp::Send(charToSend);
    }

    uint32_t Send(const char *nullTermStr) {
        return EthernetTcp::Send(nullTermStr);
    }

    uint16_t RemotePort();

    using EthernetTcp::LocalPort;

    IpAddress RemoteIp();

    uint16_t ConnectionTimeout() {
        return m_connectionTimeout;
    }

    void ConnectionTimeout(uint16_t timeout);

#ifndef HIDE_FROM_DOXYGEN
    virtual bool operator == (const EthernetTcpClient);
#endif // !HIDE_FROM_DOXYGEN

private:
    uint16_t m_connectionTimeout;
    bool m_dnsInitialized;

}; // EthernetTcpClient

} // ClearCore namespace

#endif // !__ETHERNETTCPCLIENT_H__