ns-3-dev/src/internet-stack/ipv6-end-point.h

/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2007-2009 Strasbourg University
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Sebastien Vincent <vincent@clarinet.u-strasbg.fr>
 */

#ifndef IPV6_END_POINT_H
#define IPV6_END_POINT_H

#include <stdint.h>

#include "ns3/ipv6-address.h"
#include "ns3/callback.h"

namespace ns3
{

class Header;
class Packet;

/**
 * \class Ipv6EndPoint
 * \brief An IPv6 end point, four tuples identification.
 */
class Ipv6EndPoint
{
  public:
    /**
     * \brief Constructor.
     * \param addr the IPv6 address
     * \param port the port
     */
    Ipv6EndPoint (Ipv6Address addr, uint16_t port);

    /**
     * \brief Destructor.
     */
    ~Ipv6EndPoint ();

    /**
     * \brief Get the local address.
     * \return the local address
     */
    Ipv6Address GetLocalAddress ();

    /**
     * \brief Set the local address.
     * \param addr the address to set
     */
    void SetLocalAddress (Ipv6Address addr);

    /**
     * \brief Get the local port.
     * \return the local port
     */
    uint16_t GetLocalPort ();

    /**
     * \brief Set the local port.
     * \param port the port to set
     */
    void SetLocalPort (uint16_t port);

    /**
     * \brief Get the peer address.
     * \return the peer address
     */
    Ipv6Address GetPeerAddress ();

    /**
     * \brief Get the peer port.
     * \return the peer port
     */
    uint16_t GetPeerPort ();

    /**
     * \brief Set the peer informations (address and port).
     * \param addr peer address
     * \param port peer port
     */
    void SetPeer (Ipv6Address addr, uint16_t port);

    /**
     * \brief Set the reception callback.
     * \param callback callback function
     */
    void SetRxCallback (Callback<void, Ptr<Packet>, Ipv6Address, uint16_t> callback);
    
    /**
     * \brief Set the ICMP callback.
     * \param callback callback function
     */
    void SetIcmpCallback (Callback<void, Ipv6Address, uint8_t, uint8_t, uint8_t, uint32_t> callback);

    /**
     * \brief Set the default destroy callback.
     * \param callback callback function
     */
    void SetDestroyCallback (Callback<void> callback);

    /**
     * \brief Forward the packet to the upper level.
     * \param p the packet
     * \param addr source address
     * \param port source port
     */
    void ForwardUp (Ptr<Packet> p, Ipv6Address addr, uint16_t port);

    /** 
     * \brief Function called from an L4Protocol implementation 
     * to notify an endpoint of an icmp message reception.
     * \param src source IPv6 address
     * \param ttl time-to-live
     * \param type ICMPv6 type
     * \param code ICMPv6 code
     * \param info ICMPv6 info
     */
    void ForwardIcmp (Ipv6Address src, uint8_t ttl, uint8_t type,
                      uint8_t code, uint32_t info);

  private:
    /**
     * \brief ForwardUp wrapper.
     * \param p packet
     * \param saddr source IPv6 address
     * \param sport source port
     */ 
    void DoForwardUp (Ptr<Packet> p, Ipv6Address saddr, uint16_t sport);

    /**
     * \brief ForwardIcmp wrapper.
     * \param src source IPv6 address
     * \param ttl time-to-live
     * \param type ICMPv6 type
     * \param code ICMPv6 code
     * \param info ICMPv6 info
     */ 
    void DoForwardIcmp (Ipv6Address src, uint8_t ttl, uint8_t type,
                        uint8_t code, uint32_t info);

    /**
     * \brief The local address.
     */
    Ipv6Address m_localAddr;

    /**
     * \brief The local port.
     */
    uint16_t m_localPort;

    /**
     * \brief The peer address.
     */
    Ipv6Address m_peerAddr;

    /**
     * \brief The peer port.
     */
    uint16_t m_peerPort;

    /**
     * \brief The RX callback.
     */
    Callback<void, Ptr<Packet>, Ipv6Address, uint16_t> m_rxCallback;

    /**
     * \brief The ICMPv6 callback.
     */
    Callback<void, Ipv6Address, uint8_t, uint8_t, uint8_t, uint32_t> m_icmpCallback;

    /**
     * \brief The destroy callback.
     */
    Callback<void> m_destroyCallback;
};

} /* namespace ns3 */

#endif /* IPV6_END_POINT_H */