asynctransfer.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_ASYNCTRANSFER_H
#define VISIONTRANSFER_ASYNCTRANSFER_H
 
#include "visiontransfer/common.h"
#include "visiontransfer/types.h"
#include "visiontransfer/imagetransfer.h"
#include "visiontransfer/imageset.h"
#include "visiontransfer/imageprotocol.h"
#include "visiontransfer/deviceinfo.h"
 
#if VISIONTRANSFER_CPLUSPLUS_VERSION >= 201103L
#include <functional>
#endif
 
namespace visiontransfer {
 
class VT_EXPORT AsyncTransfer {
public:
    AsyncTransfer(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);
 
    AsyncTransfer(const DeviceInfo& device, int bufferSize = 16*1048576, int maxUdpPacketSize = 1472,
            int autoReconnectDelay=1);
 
    ~AsyncTransfer();
 
    void sendImageSetAsync(const ImageSet& imageSet, bool deleteData = false);
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    DEPRECATED("Use sendImageSetAsync() instead")
    inline void sendImagePairAsync(const ImageSet& imageSet, bool deleteData = false) {
        sendImageSetAsync(imageSet, deleteData);
    }
#endif
 
    bool collectReceivedImageSet(ImageSet& imageSet, double timeout = -1);
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    DEPRECATED("Use collectReceivedImageSet() instead")
    inline bool collectReceivedImagePair(ImageSet& imageSet, double timeout = -1) {
        return collectReceivedImageSet(imageSet, timeout);
    }
#endif
 
    int getNumDroppedFrames() const;
 
    bool tryAccept();
 
    bool isConnected() const;
 
    void disconnect();
 
    std::string getRemoteAddress() const;
 
#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.
     *
     * In AsyncTransfer, this behavior runs in the background and does not
     * block the user-accessible functionality. For being informed of the
     * current connection state, 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
    AsyncTransfer(const AsyncTransfer& other);
    AsyncTransfer& operator=(const AsyncTransfer&);
};
 
} // namespace
 
#endif