imagetransfer.h

/*******************************************************************************
 * Copyright (c) 2024 Allied Vision Technologies GmbH
 *
 * 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.
 *******************************************************************************/
 
#ifndef VISIONTRANSFER_IMAGETRANSFER_H
#define VISIONTRANSFER_IMAGETRANSFER_H
 
#include <string>
#include "visiontransfer/common.h"
#include "visiontransfer/types.h"
#include "visiontransfer/imageprotocol.h"
#include "visiontransfer/imageset.h"
#include "visiontransfer/deviceinfo.h"
 
#if VISIONTRANSFER_CPLUSPLUS_VERSION >= 201103L
#include <functional>
#endif
 
namespace visiontransfer {
 
class VT_EXPORT ImageTransfer {
public:
    enum TransferStatus {
        ALL_TRANSFERRED,
 
        PARTIAL_TRANSFER,
 
        NO_VALID_DATA,
 
        WOULD_BLOCK,
 
        NOT_CONNECTED
    };
 
    ImageTransfer(const char* address, const char* service = "7681",
        ImageProtocol::ProtocolType protType = ImageProtocol::PROTOCOL_UDP,
        bool server = false, int bufferSize = 16*1048576, int maxUdpPacketSize = 1472,
        int autoReconnectDelay=1);
 
    ImageTransfer(const DeviceInfo& device, int bufferSize = 16 * 1048576,
        int maxUdpPacketSize = 1472, int autoReconnectDelay=1);
 
    ~ImageTransfer();
 
    void setRawTransferData(const ImageSet& metaData, const std::vector<unsigned char*>& rawData,
        int firstTileWidth = 0, int middleTileWidth = 0, int lastTileWidth = 0);
 
    void setRawValidBytes(const std::vector<int>& validBytes);
 
    void setTransferImageSet(const ImageSet& imageSet);
 
    TransferStatus transferData();
 
    bool receiveImageSet(ImageSet& imageSet);
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    DEPRECATED("Use receiveImageSet() instead")
    inline bool receiveImagePair(ImageSet& imageSet) {
        return receiveImageSet(imageSet);
    }
#endif
 
    bool receivePartialImageSet(ImageSet& imageSet, int& validRows, bool& complete);
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    DEPRECATED("Use receivePartialImageSet() instead")
    inline bool receivePartialImagePair(ImageSet& imageSet, int& validRows, bool& complete) {
        return receivePartialImageSet(imageSet, validRows, complete);
    }
#endif
 
    int getNumDroppedFrames() const;
 
    bool tryAccept();
 
    bool isConnected() const;
 
    void disconnect();
 
    std::string getRemoteAddress() const;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    std::string statusReport();
#endif
 
#if VISIONTRANSFER_CPLUSPLUS_VERSION >= 201103L
 
    void setConnectionStateChangeCallback(std::function<void(visiontransfer::ConnectionState)> callback);
#endif
 
    /*
     * \brief Configure automatic reconnection behavior (for TCP client mode).
     *
     * When enabled, this functionality is initiated whenever a disconnection
     * is detected, instead of just reporting the disconnection.
     * By default, automatic reconnection is active with a 1-second wait time.
     *
     * NOTE: If enabled, ImageTransfer's receiving and sending functions
     * will block indefinitely on disconnection until the connection has been
     * restored. Disconnection will be reported before blocking (see
     * setConnectionStateChangeCallback).
     * 
     * \param secondsBetweenRetries Number of seconds to wait between
     *   consecutive reconnection attempts, or 0 to disable auto-reconnection.
     */
    void setAutoReconnect(int secondsBetweenRetries=1);
 
private:
    // We follow the pimpl idiom
    class Pimpl;
    Pimpl* pimpl;
 
    // This class cannot be copied
    ImageTransfer(const ImageTransfer& other);
    ImageTransfer& operator=(const ImageTransfer&);
};
 
} // namespace
 
#endif