dhcpclient.h

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef _NB_DHCP_CLIENT_H
#define _NB_DHCP_CLIENT_H
 
#include <buffers.h>
#include <nbrtos.h>
#include <nettimer.h>
#include <nettypes.h>
 
// Functions necessary to use DHCP in the simplest form
#define DHCP_OK (0)
#define DHCP_NOTNEEDED (1)
#define DHCP_FALLBACK (2)
#define DHCP_FAILED (-1)
 
#define DHCP_LINK_DOWN_RESTART_TICKS (5 * TICKS_PER_SECOND)
 
#define SDHCP_NOTSTARTED 0      
#define SDHCP_DISCOVER 1        
#define SDHCP_OFFER 2           
#define SDHCP_ACK 3             
#define SDHCP_INIT 4            
#define SDHCP_CMPL 5            
#define SDHCP_RENEW 6           
#define SDHCP_REBIND 7          
#define SDHCP_RELEASE 8         
#define SBOOTP_TRANSMITTING 9   
#define SBOOTP_DONE 10          
#define SDHCP_FAILED 11         
class InterfaceBlock;   // Forward declaration
class DHCPMessage;      // Forward declaration
 
class DhcpObject : public TimeOutElement
{
   private:
    int DhcpState;          // Current state of DHCP engine
    int DhcpRetryCount;     // Number of transmit retries.
    int DhcpTimeCounter;    // Number of seconds til retry
    uint32_t DHCPLastXid;   // Last XID
    int DhcpBackoffTimer;
    volatile int DhcpPendingPacket;
    uint32_t DhcpLeasePendingStart;   // IP address lease start time in seconds
    uint32_t DhcpLeaseDuration;       // Relative duration of lease in seconds
 
    void CreateDhcpRenewMsg(DHCPMessage &NewMsg);
    void CreateDhcpReleaseMsg(DHCPMessage &NewMsg);
    BOOLEAN BootpConfig(DHCPMessage &Msg);
    BOOLEAN DhcpConfig(DHCPMessage &Msg);
    void UpdateIPRuntimeVars(BOOLEAN release);
    void ReTransmitPacket(uint32_t xid = 0);
    void CreateBootpMsg(DHCPMessage &NewMsg);
    uint32_t GetNextEventIntervalSecs();
 
    BOOL bProcessThisDhcp;
    DhcpObject *m_next_in_list;
    uint32_t m_LinkChangeTick;
 
    virtual void TimeElementEvent();
 
   public:
    IPADDR4 DhcpClientIP;      // Allocated IP address
    IPADDR4 DhcpClientMask;    // Allocated subnet mask
    IPADDR4 DhcpServerIP;      // Server ID
    IPADDR4 DhcpRelayIP;       // Relay Agent
    IPADDR4 DhcpRouterIP;      // Gateway IP
    IPADDR4 DhcpDNSIP;         // DNS IP
    IPADDR4 DhcpDNSIP2;        // 2nd DNS IP
    uint32_t DhcpLeaseStart;   // IP address lease start time in seconds
    uint32_t DhcpLeaseTime;    // IP address lease time in seconds
    uint32_t DhcpRenewTime;    // Time to Renewing state in seconds
    uint32_t DhcpRebindTime;   // Time to Rebinding state in seconds
    InterfaceBlock *pIfb;      // Interface to use
    OS_SEM NotifySem;
 
    void StartDHCP();
 
    // Start the BOOTP process
    void StartBOOTP();
 
    // After BOOTP has failed call this to stop BOOTP processing
    void StopBOOTP();
 
    void StopDHCP();
 
    void RestartDHCP();
 
    bool bDoFallBack();
 
    void RenewDHCP();
 
    void RebindDHCP();
 
    BOOL ValidDhcpLease();
 
    uint32_t GetRemainingDhcpLeaseTime();
 
    uint32_t GetDhcpRenewTime() { return DhcpRenewTime; }
 
    uint32_t GetDhcpRebindTime() { return DhcpRebindTime; }
 
    uint32_t GetDhcpExpirationTime() { return DhcpLeaseTime; }
 
    int32_t GetDHCPState();
 
    //---- function prototypes -----
    void PrintDhcpState(int state);
 
    void DHCPTimer();
    void DHCPPacket(PoolPtr p);
 
    static void staticDHCPPacket(PoolPtr p);
 
    void StopProcessing();
 
    DhcpObject(InterfaceBlock *ib);
    ~DhcpObject();
 
    void (*leaseExpiredCallback)(DhcpObject *dhcpClient);
    void (*DHCPFailedCallback)(DhcpObject *dhcpClient);
    void (*leaseObtainedCallback)(DhcpObject *dhcpClient);
 
    void LinkNotify(bool link);
 
    friend void PrintDhcpStatus(DhcpObject &dob);
    friend void PrintDhcpState(int state);
 
};   // End of DHCP Object
 
int32_t GetIntefaceDHCPState(int interface = 0);
 
int32_t WaitForDHCPInterface(int interface = 0, uint16_t TicksToWait = 10 * TICKS_PER_SECOND);
 
#endif