tcp_model.h

浏览该文件的文档.

#ifndef AUBO_SCOP_TCP_MODEL_H
#define AUBO_SCOP_TCP_MODEL_H
 
#include <vector>
#include <functional>
#include <aubo_caps/domain/tcp/tcp.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(TcpModel);
 
/**
 * @ingroup ApplicationApi
 * \chinese
 * TCP 模型
 * 此接口提供对 AuboScope 中当前可用的 TCP 的访问。
 * \endchinese
 * \english
 * TcpModel
 * This interface provides access to the TCPs that are currently available in
 * AuboScope.
 * \endenglish
 */
class ARCS_ABI_EXPORT TcpModel
{
public:
    TcpModel(TcpModel &f);
    TcpModel(TcpModel &&f);
    virtual ~TcpModel();
 
    /**
     * @ingroup TcpModel
     * \chinese
     * 获取AuboScope中所有TCP的集合
     * @return 所有TCP的集合。
     * \endchinese
     * \english
     * Returns a collection of all the TCPs in AuboScope.
     * @return A collection of all the TCPs in AuboScope.
     * \endenglish
     */
    std::vector<TCPPtr> getAll();
 
    /**
     * @ingroup TcpModel
     * @ref TCP
     * \chinese
     * 根据名称获取TCP
     * @param name TCP名称。
     * @return 对应名称的TCP。
     * \endchinese
     * \english
     * Get a TCP by name.
     * @param name the name of the TCP.
     * @return the TCP with the given name.
     * \endenglish
     */
    TCPPtr getTcp(const std::string &name);
 
    /**
     * @ingroup TcpModel
     * @ref TCP
     * \chinese
     * 获取默认TCP
     * @return 默认TCP。
     * \endchinese
     * \english
     * Returns the default TCP.
     * @return the default TCP.
     * \endenglish
     */
    TCPPtr getDefaultTcp();
 
    /**
     * @ingroup TcpModel
     * \chinese
     * 注册变更回调
     * @param receiver 接收者标识。
     * @param slot 回调函数。
     * @return 连接标识符。
     * \endchinese
     * \english
     * Register callback for changed.
     * @param receiver the receiver identifier.
     * @param slot the callback function.
     * @return the connection identifier.
     * \endenglish
     */
    std::string connectedTo(const std::string &receiver,
                            const std::function<void(TcpModel *)> &slot);
    /**
     * @ingroup TcpModel
     * \chinese
     * 断开回调连接
     * @param receiver 接收者标识。
     * \endchinese
     * \english
     * Disconnect a callback.
     * @param receiver the receiver identifier.
     * \endenglish
     */
    void disconnectFrom(const std::string &receiver);
 
private:
    friend class DataSwitch;
    TcpModel();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOP_TCP_MODEL_H