blob: a83ed70d96d184a3fbee01d22cd6616b4fed19a0 [file] [log] [blame]
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
2/*
Ilya Moiseenko956d0542012-01-02 15:26:40 -08003 * Copyright (c) 2011 University of California, Los Angeles
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -07004 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Authors: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
19 */
20
21#ifndef CCNX_NET_DEVICE_FACE_H
22#define CCNX_NET_DEVICE_FACE_H
23
24#include "ccnx-face.h"
25#include "ns3/net-device.h"
26
27namespace ns3 {
28
29class Address;
30
31/**
32 * \ingroup ccnx-face
33 * \brief Implementation of layer-2 (Ethernet) CCNx face
34 *
35 * This class defines basic functionality of CCNx face. Face is core
36 * component responsible for actual delivery of data packet to and
37 * from CCNx stack
38 *
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -070039 * CcnxNetDevice face is permanently associated with one NetDevice
40 * object and this object cannot be changed for the lifetime of the
41 * face
42 *
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070043 * \see CcnxLocalFace, CcnxNetDeviceFace, CcnxIpv4Face, CcnxUdpFace
44 */
45class CcnxNetDeviceFace : public CcnxFace
46{
47public:
Alexander Afanasyevcbe92ae2011-12-16 13:06:18 -080048 static TypeId
49 GetTypeId ();
50
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070051 /**
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -070052 * \brief Constructor
53 *
54 * \param netDevice a smart pointer to NetDevice object to which
55 * this face will be associate
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070056 */
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080057 CcnxNetDeviceFace (Ptr<Node> node, const Ptr<NetDevice> &netDevice);
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070058 virtual ~CcnxNetDeviceFace();
59
60 ////////////////////////////////////////////////////////////////////
61 // methods overloaded from CcnxFace
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070062 virtual void
63 RegisterProtocolHandler (ProtocolHandler handler);
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070064
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080065protected:
66 // also from CcnxFace
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070067 virtual void
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080068 SendImpl (Ptr<Packet> p);
69
70public:
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070071 virtual std::ostream&
72 Print (std::ostream &os) const;
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070073 ////////////////////////////////////////////////////////////////////
74
75 /**
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070076 * \brief Get NetDevice associated with the face
77 *
78 * \returns smart pointer to NetDevice associated with the face
79 */
80 Ptr<NetDevice> GetNetDevice () const;
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070081
82private:
83 CcnxNetDeviceFace (const CcnxNetDeviceFace &); ///< \brief Disabled copy constructor
84 CcnxNetDeviceFace& operator= (const CcnxNetDeviceFace &); ///< \brief Disabled copy operator
85
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -070086 /// \brief callback from lower layers
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070087 void ReceiveFromNetDevice (Ptr<NetDevice> device,
88 Ptr<const Packet> p,
89 uint16_t protocol,
90 const Address &from,
91 const Address &to,
92 NetDevice::PacketType packetType);
93
94private:
95 Ptr<NetDevice> m_netDevice; ///< \brief Smart pointer to NetDevice
96};
97
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070098} // namespace ns3
99
100#endif //CCNX_NET_DEVICE_FACE_H