helper/ccnx-decoding-helper.h

/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil -*- */
/*
 * Copyright (c) 2011 University of California, Los Angeles
 *
 * 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: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
 */

#ifndef _CCNX_DECODING_HELPER_H_
#define _CCNX_DECODING_HELPER_H_

#include <cstring>
#include "ns3/buffer.h"

namespace ns3 {

class CcnxInterestHeader;
class CcnxContentObjectHeader;

/**
 * \brief Helper class to decode ccnb formatted CCNx message
 */
class CcnxDecodingHelper
{
public:
  /**
   * \brief Deserialize Buffer::Iterator to CcnxInterestHeader
   * @param start Buffer containing serialized CCNx message
   * @param interest Pointer to the CcnxInterestHeader to hold deserialized value
   * @return Number of bytes used for deserialization
   */
  static size_t
  Deserialize (Buffer::Iterator start, CcnxInterestHeader &interest);

  /**
   * \brief Deserialize Buffer::Iterator to CcnxContentObjectHeader
   * @param start Buffer containing serialized CCNx message
   * @param contentObject Pointer to the CcnxContentObjectHeader to hold deserialized value
   * @return Number of bytes used for deserialization
   */
  static size_t
  Deserialize (Buffer::Iterator start, CcnxContentObjectHeader &contentObject);
};
} // namespace ns3

#endif // _CCNX_DECODING_HELPER_H_