English

File content as of revision 37:fc4b4fd6a649:

#pragma once
////////////////////////////////////////////////////////////////////////////////
// NetConfig.h
////////////////////////////////////////////////////////////////////////////////

#include "NyLPC_net.h"



namespace MiMic
{
    /**
     * Network configulation class.
     * The class is used for argument of NetConfig constructor.
     */
    class NetConfig
    {
    private:
        /**service record*/
        struct NyLPC_TMDnsServiceRecord _srv_record;
    public:
        /** dns record*/
        struct NyLPC_TDnsRecord _dns_record;
        NyLPC_TcNetConfig_t _inst;
    public:
        /**
         * The constructor.
         * This function initializes instance by onchip configulation data.
         * @param i_is_factory_default
         * Factory default flag.
         * <ul>
         * <li>true - The function sets factory default setting.
         * <li>false -The function sets onchip memory configulation (default)
         * </ul>
         */
        NetConfig(bool i_is_factory_default=false);
        virtual ~NetConfig();        
        /**
         * Set IPv4 ip address to instance.
         */
        void setIpAddr(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
        /**
         * Set IPv4 network mask value to instance.
         */
        void setNetMask(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);

        /**
         * Set IPv4 default gateway address to instance.
         */
        void setGateway(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
        /**
         * Set Zero configuration enable flag.
         * @param v
         * True, Zero configuration mode. The mimic will try DHCP and AutoIP configuration.
         * ipaddress,netmask,gateway are ignored.
         * False, Manual mode. The mimic will set ip address from on chip data.
         */
        void setZeroconf(bool v);
        /**
         * This function set a recommended HTTP port number to the application.
         */
        void setSrvHttpPort(unsigned short port);
        /**
         * Set mDNS operation flag.
         * This function recommends to the application to provide mDNS service to network.
         */
        void setSrvMdns(bool i_enable);
        void setHostName(const char* i_hostname);
        void setHostName(const char* i_hostname,int len);
        /**
         * Set ethernet mac address to instance.
         */
        void setEmac(unsigned char ip6,unsigned char ip5,unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
        
        /**
         * Load configulation from text file.
         * <p>File format example
         * <pre>
         * macaddr=00:00:00:00:00:00
         * host=MiMic01
         * ipaddr=192.168.0.1
         * netmask=255.255.255.0
         * gateway=192.168.0.254
         * srv_http_port=80
         * srv_mdns=yes
         * </pre>
         * <p>Keys
         * <ul>
         * <li>macaddr=[:macaddr:] - 48bit ethernet mac address that are separated by ':'</li>
         * <li>ipaddr=[:ip:] || AUTO
         * - 32 bit IP address or auto detection. AUTO will be to try DHCP and AUTOIP.
         * </li>
         * <li>netmask=[:ip:]- 32 bit network mask value.</li>
         * <li>gateway=[:ip:] - 32 bit default gateway address.</li>
         * <li>srv_http_port=[:UINT16:] - 16bit http service port number(not ZERO)</li>
         * <li>srv_mdns=[yes|no] - mDNS service flag.</li>
         * </ul>
         * </p>
         * <p>Default setting
         * <ul>
         * <li>macaddr=02:01:02:03:04:05 (In case of mbed it is preset value.)
         * <li>host=MiMic020102030405
         * <li>ipaddr =192.168.0.39
         * <li>netmask=255.255.255.0
         * <li>gateway=192.168.0.254
         * <li>srv_http_port=80
         * <li>srv_mdns=yes</li>
         * </ul>
         * </p>
         * Maximum line length is 31.
         * Specified values are override on-chip setting value.
         * If the same value appeared, then the last one is enabled.
         * In case of ipaddr=AUTO, gateway and netmask are ignored.
         * </p>
         * @return
         * true if file read. false is not read.
         */
         bool loadFromFile(const char* i_file);
   };
}