blob: 664130c831e7c499134e973143e44e68a211ad4e [file] [log] [blame]
Alexander Afanasyevc74a6022011-08-15 20:01:35 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
Alexander Afanasyev98256102011-08-14 01:00:02 -07002/*
3 * Copyright (c) 2005,2006,2007 INRIA
4 *
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 *
Ilya Moiseenko1cf6b0a2011-08-29 13:02:34 -070018 * Authors: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
19 Ilya Moiseenko <iliamo@cs.ucla.edu>
Alexander Afanasyev98256102011-08-14 01:00:02 -070020 */
Ilya Moiseenko1cf6b0a2011-08-29 13:02:34 -070021
Alexander Afanasyev98256102011-08-14 01:00:02 -070022#ifndef CCNX_LOCAL_FACE_H
23#define CCNX_LOCAL_FACE_H
24
25#include "ccnx-face.h"
26
Ilya Moiseenko1cf6b0a2011-08-29 13:02:34 -070027namespace ns3
28{
Alexander Afanasyev98256102011-08-14 01:00:02 -070029
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070030class CcnxInterestHeader;
31class CcnxContentObjectHeader;
32class Packet;
33
Alexander Afanasyev98256102011-08-14 01:00:02 -070034/**
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070035 * \ingroup ccnx-face
36 * \brief Implementation of application CCNx face
Alexander Afanasyev98256102011-08-14 01:00:02 -070037 *
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070038 * This class defines basic functionality of CCNx face. Face is core
39 * component responsible for actual delivery of data packet to and
40 * from CCNx stack
Alexander Afanasyev98256102011-08-14 01:00:02 -070041 *
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070042 * \see CcnxLocalFace, CcnxNetDeviceFace, CcnxIpv4Face, CcnxUdpFace
Alexander Afanasyev98256102011-08-14 01:00:02 -070043 */
44class CcnxLocalFace : public CcnxFace
45{
46public:
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070047 typedef Callback<void,const Ptr<const CcnxInterestHeader> &> InterestHandler;
48 typedef Callback<void,const Ptr<const CcnxContentObjectHeader> &,
49 const Ptr<const Packet> &> ContentObjectHandler;
Alexander Afanasyev98256102011-08-14 01:00:02 -070050
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070051 /**
52 * \brief Default constructor
53 */
Alexander Afanasyev98256102011-08-14 01:00:02 -070054 CcnxLocalFace ();
55 virtual ~CcnxLocalFace();
Alexander Afanasyev98256102011-08-14 01:00:02 -070056
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070057 ////////////////////////////////////////////////////////////////////
58 // methods overloaded from CcnxFace
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070059
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070060 /**
61 * \brief This method should be called to establish link with lower layers
62 */
63 virtual void
64 RegisterProtocolHandler (ProtocolHandler handler);
Alexander Afanasyev98256102011-08-14 01:00:02 -070065
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070066 /**
67 * \brief This method will be called by lower layers to send data to *application*
68 */
69 virtual void
70 Send (Ptr<Packet> p);
Ilya Moiseenkoacac1ea2011-10-28 13:16:53 -070071
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070072 virtual std::ostream&
73 Print (std::ostream &os) const;
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070074 ////////////////////////////////////////////////////////////////////
75
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070076 /**
77 * \brief This method will be called by higher layers to send data to *ccnx stack*
78 */
79 void ReceiveFromApplication (Ptr<Packet> p);
Alexander Afanasyev98256102011-08-14 01:00:02 -070080
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070081 /**
82 * \brief Set callback to application
83 *
84 * \param onInterest InterestHandler to be called when interest arrives on the face. Will be disabled if 0
85 */
86 void SetInterestHandler (InterestHandler onInterest);
87
88 /**
89 * \brief Set callback to application
90 *
91 * \param onContentObject ContentObjectHandler to be called when data arrives. Will be disabled if 0
92 */
93 void SetContentObjectHandler (ContentObjectHandler onContentObject);
94
Alexander Afanasyev98256102011-08-14 01:00:02 -070095private:
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070096 CcnxLocalFace (const CcnxLocalFace &); ///< \brief Disabled copy constructor
97 CcnxLocalFace& operator= (const CcnxLocalFace &); ///< \brief Disabled copy operator
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070098
99private:
100 InterestHandler m_onInterest;
101 ContentObjectHandler m_onContentObject;
Alexander Afanasyev98256102011-08-14 01:00:02 -0700102};
103
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700104std::ostream& operator<< (std::ostream& os, const CcnxLocalFace &localFace);
Alexander Afanasyev98256102011-08-14 01:00:02 -0700105
106} // namespace ns3
107
108#endif