/*
 Itay Marom
 Cisco Systems, Inc.
*/

/*
Copyright (c) 2015-2015 Cisco Systems, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#ifndef __TREX_STATELESS_API_H__
#define __TREX_STATELESS_API_H__

#include <stdint.h>
#include <string>
#include <stdexcept>

#include <trex_stream_api.h>

/**
 * generic exception for errors
 * TODO: move this to a better place
 */
class TrexException : public std::runtime_error 
{
public:
    TrexException() : std::runtime_error("") {

    }
    TrexException(const std::string &what) : std::runtime_error(what) {
    }
};

/**
 * describes a stateless port
 * 
 * @author imarom (31-Aug-15)
 */
class TrexStatelessPort {
public:

    /**
     * port state
     */
    enum port_state_e {
        PORT_STATE_DOWN,
        PORT_STATE_UP_IDLE,
        PORT_STATE_TRANSMITTING
    };

    /**
     * describess different error codes for port operations
     */
    enum rc_e {
        RC_OK,
        RC_ERR_BAD_STATE_FOR_OP,
        RC_ERR_NO_STREAMS,
        RC_ERR_FAILED_TO_COMPILE_STREAMS
    };

    TrexStatelessPort(uint8_t port_id);

    /**
     * start traffic
     * 
     */
    rc_e start_traffic(void);

    /**
     * stop traffic
     * 
     */
    void stop_traffic(void);

    /**
     * access the stream table
     * 
     */
    TrexStreamTable *get_stream_table();

    /**
     * get the port state
     * 
     */
    port_state_e get_state() {
        return m_port_state;
    }

    /**
     * fill up properties of the port
     * 
     * @author imarom (16-Sep-15)
     * 
     * @param driver 
     * @param speed 
     */
    void get_properties(std::string &driver, std::string &speed);

    /**
    * query for ownership
    * 
    */
    const std::string &get_owner() {
        return m_owner;
    }

    /**
     * owner handler 
     * for the connection 
     * 
     */
    const std::string &get_owner_handler() {
        return m_owner_handler;
    }

    bool is_free_to_aquire() {
        return (m_owner == "none");
    }

    /**
    * take ownership of the server array 
    * this is static 
    * ownership is total 
    * 
    */
    void set_owner(const std::string &owner) {
        m_owner = owner;
        m_owner_handler = generate_handler();
    }

    void clear_owner() {
        m_owner = "none";
        m_owner_handler = "";
    }

    bool verify_owner_handler(const std::string &handler) {

        return ( (m_owner != "none") && (m_owner_handler == handler) );

    }

private:

    std::string generate_handler();

    TrexStreamTable  m_stream_table;
    uint8_t          m_port_id;
    port_state_e     m_port_state;
    std::string      m_owner;
    std::string      m_owner_handler;
};

/**
 * defines the T-Rex stateless operation mode
 * 
 */
class TrexStateless {
public:

    /**
     * configure the stateless object singelton 
     * reconfiguration is not allowed
     * an exception will be thrown
     */
    static void configure(uint8_t port_count);

    /**
     * singleton public get instance
     * 
     */
    static TrexStateless& get_instance() {
        TrexStateless& instance = get_instance_internal();

        if (!instance.m_is_configured) {
            throw TrexException("object is not configured");
        }

        return instance;
    }

    TrexStatelessPort *get_port_by_id(uint8_t port_id);
    uint8_t            get_port_count();

protected:
    TrexStateless();
    ~TrexStateless();

    static TrexStateless& get_instance_internal () {
        static TrexStateless instance;
        return instance;
    }

     /* c++ 2011 style singleton */
    TrexStateless(TrexStateless const&)      = delete;  
    void operator=(TrexStateless const&)     = delete;

    bool                m_is_configured;
    TrexStatelessPort  **m_ports;
    uint8_t             m_port_count;
};

#endif /* __TREX_STATELESS_API_H__ */