Protocol_IP_Over_ETHERNET.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Protocol_IP_Over_ETHERNET.h
//! @brief      Communication protocol IP over Ethernet class header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Common/PRT_Sensor.h $
//!             $Revision: 2075 $
//!             $Date: 2020-09-12 14:00:31 +0500 (Sa, 12 Sep 2020) $
//!             $Author: minch $
//------------------------------------------------------------------------------
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of ANVILEX nor the names of its contributors may be
//    used to endorse or promote products derived from this software without
//    specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include system files
//------------------------------------------------------------------------------
 
#include "Protocol_Base.h"
 
//------------------------------------------------------------------------------
//
//------------------------------------------------------------------------------
 
#include "ip_addr.h"
#include "udp.h"
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief Communication protocol IP over ETHERNET class
class TProtocol_IP_Over_ETHERNET : public TProtocol_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
  
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TProtocol_IP_Over_ETHERNET();
    
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TProtocol_IP_Over_ETHERNET();
     
    // Initialisation and finalisation
    VOID Init();
    VOID Done();
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    // Protocol status methods
    virtual VOID Enter_Terminal_Mode();
    virtual VOID Enter_Protocol_Mode();
    virtual BOOL Is_Terminal_Mode();
    virtual BOOL Is_Protocol_Mode();
 
    // Receive related methods
//    virtual VOID Receive_Char( C8 c8_Character );
    virtual VOID Receive_String( C8 *c8_String );
    virtual VOID Receive_String( C8 *c8_String, U32 u32_Length );
 
    // Execute method
    virtual VOID Execute();
    virtual VOID Execute_1ms();
    
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
  
  protected:
  
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
  
  private:
  
    VOID Process_UDP();
  
    //! @brief Global network interface structure
    struct netif gnetif;
 
    //! @brief IP address
    uint8_t IP_ADDRESS[ 4 ];
  
    //! @brief Netmask address
    uint8_t NETMASK_ADDRESS[ 4 ];
  
    //! @brief Gateway address
    uint8_t GATEWAY_ADDRESS[ 4 ];
    ip4_addr_t ipaddr;
    ip4_addr_t netmask;
    ip4_addr_t gw;
 
    //! @brief Pointer to PCB structure to use with UDP
    udp_pcb *pcb_UDP;
  
};
 
//------------------------------------------------------------------------------
// End Of File 
//------------------------------------------------------------------------------