device.hpp

Go to the documentation of this file.

//
// Copyright 2010-2011 Ettus Research LLC
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//

#ifndef INCLUDED_UHD_DEVICE_HPP
#define INCLUDED_UHD_DEVICE_HPP

#include <uhd/config.hpp>
#include <uhd/types/device_addr.hpp>
#include <uhd/types/metadata.hpp>
#include <uhd/types/io_type.hpp>
#include <uhd/types/ref_vector.hpp>
#include <uhd/wax.hpp>
#include <boost/utility.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/function.hpp>

namespace uhd{

class property_tree; //forward declaration

class UHD_API device : boost::noncopyable, public wax::obj{

public:
    typedef boost::shared_ptr<device> sptr;
    typedef boost::function<device_addrs_t(const device_addr_t &)> find_t;
    typedef boost::function<sptr(const device_addr_t &)> make_t;

    static void register_device(
        const find_t &find,
        const make_t &make
    );

    static device_addrs_t find(const device_addr_t &hint);

    static sptr make(const device_addr_t &hint, size_t which = 0);

    enum send_mode_t{
        SEND_MODE_FULL_BUFF = 0,
        SEND_MODE_ONE_PACKET = 1
    };

    enum recv_mode_t{
        RECV_MODE_FULL_BUFF = 0,
        RECV_MODE_ONE_PACKET = 1
    };

    typedef ref_vector<const void *> send_buffs_type;

    typedef ref_vector<void *> recv_buffs_type;

    virtual size_t send(
        const send_buffs_type &buffs,
        size_t nsamps_per_buff,
        const tx_metadata_t &metadata,
        const io_type_t &io_type,
        send_mode_t send_mode,
        double timeout = 0.1
    ) = 0;

    virtual size_t recv(
        const recv_buffs_type &buffs,
        size_t nsamps_per_buff,
        rx_metadata_t &metadata,
        const io_type_t &io_type,
        recv_mode_t recv_mode,
        double timeout = 0.1
    ) = 0;

    virtual size_t get_max_send_samps_per_packet(void) const = 0;

    virtual size_t get_max_recv_samps_per_packet(void) const = 0;

    virtual bool recv_async_msg(
        async_metadata_t &async_metadata, double timeout = 0.1
    ) = 0;

    virtual boost::shared_ptr<property_tree> get_tree(void) const = 0;

};

} //namespace uhd

#endif /* INCLUDED_UHD_DEVICE_HPP */