/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2005,2006,2007 INRIA

 *

 * 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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>

 */

#ifndef UDP_L4_PROTOCOL_H

#define UDP_L4_PROTOCOL_H

#include <stdint.h>

#include "ns3/packet.h"

#include "ns3/ipv4-address.h"

#include "ns3/ipv6-address.h"

#include "ns3/ptr.h"

#include "ns3/ip-l4-protocol.h"

#include "ipv6-interface.h"

#include "ipv6-header.h"

namespace ns3 {

class Node;

class Socket;

class Ipv4EndPointDemux;

class Ipv4EndPoint;

class Ipv6EndPointDemux;

class Ipv6EndPoint;

class UdpSocketImpl;

/**

 * \ingroup udp

 * \brief Implementation of the UDP protocol

 */

class UdpL4Protocol : public IpL4Protocol {

public:

  static TypeId GetTypeId (void);

  UdpL4Protocol ();

  virtual ~UdpL4Protocol ();

  void SetNode (Ptr<Node> node);

  virtual int GetProtocolNumber (void) const;

  /**

   * \return A smart Socket pointer to a UdpSocket, allocated by this instance

   * of the UDP protocol

   */

  Ptr<Socket> CreateSocket (void);

  Ipv4EndPoint *Allocate (void);

  Ipv4EndPoint *Allocate (Ipv4Address address);

  Ipv4EndPoint *Allocate (uint16_t port);

  Ipv4EndPoint *Allocate (Ipv4Address address, uint16_t port);

  Ipv4EndPoint *Allocate (Ipv4Address localAddress, uint16_t localPort,

                          Ipv4Address peerAddress, uint16_t peerPort);

  Ipv6EndPoint *Allocate6 (void);

  Ipv6EndPoint *Allocate6 (Ipv6Address address);

  Ipv6EndPoint *Allocate6 (uint16_t port);

  Ipv6EndPoint *Allocate6 (Ipv6Address address, uint16_t port);

  Ipv6EndPoint *Allocate6 (Ipv6Address localAddress, uint16_t localPort,

  void DeAllocate (Ipv4EndPoint *endPoint);

  void DeAllocate (Ipv6EndPoint *endPoint);

  // called by UdpSocket.

  /**

   * \param packet The packet to send

   * \param saddr The source Ipv4Address

   * \param daddr The destination Ipv4Address

   * \param sport The source port number

   * \param dport The destination port number

   */

  void Send (Ptr<Packet> packet,

             Ipv4Address saddr, Ipv4Address daddr, 

             uint16_t sport, uint16_t dport);

  void Send (Ptr<Packet> packet,

             Ipv4Address saddr, Ipv4Address daddr, 

             uint16_t sport, uint16_t dport, Ptr<Ipv4Route> route);

  void Send (Ptr<Packet> packet,

             Ipv6Address saddr, Ipv6Address daddr, 

             uint16_t sport, uint16_t dport);

  void Send (Ptr<Packet> packet,

             Ipv6Address saddr, Ipv6Address daddr, 

             uint16_t sport, uint16_t dport, Ptr<Ipv6Route> route);

  // inherited from Ipv4L4Protocol

  virtual enum IpL4Protocol::RxStatus Receive (Ptr<Packet> p,

  virtual enum IpL4Protocol::RxStatus Receive (Ptr<Packet> p,

  virtual void ReceiveIcmp (Ipv4Address icmpSource, uint8_t icmpTtl,

                            uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo,

                            Ipv4Address payloadSource,Ipv4Address payloadDestination,

                            const uint8_t payload[8]);

  virtual void ReceiveIcmp (Ipv6Address icmpSource, uint8_t icmpTtl,

                            uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo,

                            Ipv6Address payloadSource,Ipv6Address payloadDestination,

                            const uint8_t payload[8]);

  // From IpL4Protocol

  virtual void SetDownTarget (IpL4Protocol::DownTargetCallback cb);

  virtual void SetDownTarget6 (IpL4Protocol::DownTargetCallback6 cb);

  // From IpL4Protocol

  virtual IpL4Protocol::DownTargetCallback GetDownTarget (void) const;

  virtual IpL4Protocol::DownTargetCallback6 GetDownTarget6 (void) const;

protected:

  virtual void DoDispose (void);

  /*

   * This function will notify other components connected to the node that a new stack member is now connected

   * This will be used to notify Layer 3 protocol of layer 4 protocol stack to connect them together.

   */

  virtual void NotifyNewAggregate ();

private:

};

} // namespace ns3

#endif /* UDP_L4_PROTOCOL_H */