interest.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018-2019 Zhiyi Zhang
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v3.0. See the file LICENSE in the top level
 * directory for more details.
 */

#ifndef NDN_ENCODING_INTEREST_H
#define NDN_ENCODING_INTEREST_H

#include "name.h"
#include "signature.h"
#include "../security/ndn-lite-crypto-key.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct interest_params {
  uint8_t value[NDN_INTEREST_PARAMS_BUFFER_SIZE];
  uint32_t size;
} interest_params_t;

typedef struct ndn_interest {
  ndn_name_t name;
  uint32_t nonce;
  uint64_t lifetime;

  uint8_t enable_CanBePrefix;
  uint8_t enable_MustBeFresh;

  interest_params_t parameters;
  uint8_t enable_Parameters;

  uint8_t hop_limit;
  uint8_t enable_HopLimit;

  uint8_t is_SignedInterest;
  ndn_signature_t signature;
} ndn_interest_t;

static inline void
ndn_interest_init(ndn_interest_t* interest)
{
  interest->enable_CanBePrefix = 0;
  interest->enable_MustBeFresh = 0;
  interest->enable_HopLimit = 0;
  interest->enable_Parameters = 0;
  interest->is_SignedInterest = 0;

  interest->nonce = 0;
  interest->lifetime = NDN_DEFAULT_INTEREST_LIFETIME;
  interest->hop_limit = 0;
}

static inline void
ndn_interest_from_name(ndn_interest_t* interest, const ndn_name_t* name)
{
  interest->name = *name;

  interest->enable_CanBePrefix = 0;
  interest->enable_MustBeFresh = 0;
  interest->enable_HopLimit = 0;
  interest->enable_Parameters = 0;
  interest->is_SignedInterest = 0;

  interest->nonce = 0;
  interest->lifetime = NDN_DEFAULT_INTEREST_LIFETIME;
  interest->hop_limit = 0;
}

int
ndn_interest_from_block(ndn_interest_t* interest, const uint8_t* block_value, uint32_t block_size);

static inline void
ndn_interest_set_CanBePrefix(ndn_interest_t* interest, uint8_t can_be_prefix)
{
  interest->enable_CanBePrefix = (can_be_prefix > 0 ? 1 : 0);
}

static inline void
ndn_interest_set_MustBeFresh(ndn_interest_t* interest, uint8_t must_be_fresh)
{
  interest->enable_MustBeFresh = (must_be_fresh > 0 ? 1 : 0);
}

static inline void
ndn_interest_set_HopLimit(ndn_interest_t* interest, uint8_t hop)
{
  interest->enable_HopLimit = 1;
  interest->hop_limit = hop;
}

static inline int
ndn_interest_set_Parameters(ndn_interest_t* interest,
                            const uint8_t* params_value, uint32_t params_size)
{
  if (params_size > NDN_INTEREST_PARAMS_BUFFER_SIZE)
    return NDN_OVERSIZE;
  interest->enable_Parameters = 1;
  memcpy(interest->parameters.value, params_value, params_size);
  interest->parameters.size = params_size;
  return 0;
}

int
ndn_interest_tlv_encode(ndn_encoder_t* encoder, ndn_interest_t* interest);

int
ndn_interest_name_compare_block(const uint8_t* lhs_block_value, uint32_t lhs_block_size,
                                const uint8_t* rhs_block_value, uint32_t rhs_block_size);

#ifdef __cplusplus
}
#endif

#endif // NDN_ENCODING_INTEREST_H