Transfer.h

Go to the documentation of this file.

/***************************************************/
#ifndef SEABREEZE_TRANSFER_H
#define SEABREEZE_TRANSFER_H

#include <vector>
#include "common/protocols/Exchange.h"
#include "common/protocols/ProtocolHint.h"
#include "common/Data.h"

typedef unsigned int direction_t;

namespace seabreeze {

    class Transfer : public Exchange {
    public:

        /* Note that the size of the provided buffer and the specified length
         * of the transfer itself do not need to agree.  If the transfer requires
         * more space than the buffer provides, the buffer will be resized.
         * If the buffer is created larger than is needed, only the given length
         * will be sent or received.  This allows for some freedom in buffer
         * management.
         */
        Transfer(std::vector<ProtocolHint *> *hints, std::vector<byte> *buffer,
                direction_t direction, unsigned int length);

        virtual ~Transfer();
        virtual Data *transfer(TransferHelper *helper) throw (ProtocolException);

        static const direction_t TO_DEVICE;
        static const direction_t FROM_DEVICE;

    protected:
        Transfer();
        void checkBufferSize();

        unsigned int length;
        std::vector<byte> *buffer;
        direction_t direction;
    };

}

#endif /* SEABREEZE_TRANSFER_H */