blob: 3a0ba31ca5b7aacf03f4f3c09d0d4d10a699f3c0 [file] [log] [blame]
/**
* Copyright (C) 2013 Regents of the University of California.
* @author: Jeff Thompson <jefft0@remap.ucla.edu>
* See COPYING for copyright and distribution information.
*/
#ifndef NDN_NAME_H
#define NDN_NAME_H
#include <ndn-cpp/c/common.h>
#include "errors.h"
#include "util/blob.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* An ndn_NameComponent holds a pointer to the component value.
*/
struct ndn_NameComponent {
struct ndn_Blob value; /**< A Blob with a pointer to the pre-allocated buffer for the component value */
};
/**
*
* @param self pointer to the ndn_NameComponent struct
* @param value the pre-allocated buffer for the component value
* @param valueLength the number of bytes in value
*/
static inline void ndn_NameComponent_initialize(struct ndn_NameComponent *self, uint8_t *value, size_t valueLength)
{
ndn_Blob_initialize(&self->value, value, valueLength);
}
/**
* Interpret the name component as a network-ordered number and return an integer.
* @param self A pointer to the ndn_NameComponent struct.
* @return The integer number.
*/
uint64_t ndn_NameComponent_toNumber(struct ndn_NameComponent *self);
/**
* Interpret the name component as a network-ordered number with a marker and return an integer.
* @param self A pointer to the ndn_NameComponent struct.
* @param marker The required first byte of the component.
* @param result Return the integer number.
* @return 0 for success, or an error code if the first byte of the component does not equal the marker.
*/
ndn_Error ndn_NameComponent_toNumberWithMarker(struct ndn_NameComponent *self, uint8_t marker, uint64_t *result);
/**
* An ndn_Name holds an array of ndn_NameComponent.
*/
struct ndn_Name {
struct ndn_NameComponent *components; /**< pointer to the array of components. */
size_t maxComponents; /**< the number of elements in the allocated components array */
size_t nComponents; /**< the number of components in the name */
};
/**
* Initialize an ndn_Name struct with the components array.
* @param self pointer to the ndn_Name struct
* @param components the pre-allocated array of ndn_NameComponent
* @param maxComponents the number of elements in the allocated components array
*/
static inline void ndn_Name_initialize(struct ndn_Name *self, struct ndn_NameComponent *components, size_t maxComponents)
{
self->components = components;
self->maxComponents = maxComponents;
self->nComponents = 0;
}
/**
* Return true if the N components of this name are the same as the first N components of the given name.
* @param self A pointer to the ndn_Name struct.
* @param name A pointer to the other name to match.
* @return 1 if this matches the given name, 0 otherwise. This always returns 1 if this name is empty.
*/
int ndn_Name_match(struct ndn_Name *self, struct ndn_Name *name);
/**
* Append a component to this name with the bytes in the given array.
* @param self pointer to the ndn_Name struct.
* @param value The bytes of the component. This does not copy the bytes.
* @param valueLength The number of bytes in value.
* @return 0 for success, or an error code if there is no more room in the components array (nComponents is already maxComponents).
*/
ndn_Error ndn_Name_appendComponent(struct ndn_Name *self, uint8_t* value, size_t valueLength);
/**
* Append a component to this name with the bytes in the given blob.
* @param self pointer to the ndn_Name struct.
* @param value An ndn_Blob with the bytes of the component. This does not copy the bytes.
* @return 0 for success, or an error code if there is no more room in the components array (nComponents is already maxComponents).
*/
static inline ndn_Error ndn_Name_appendBlob(struct ndn_Name *self, struct ndn_Blob *value)
{
return ndn_Name_appendComponent(self, value->value, value->length);
}
/**
* Append a component to this name with the bytes in raw string value.
* @param self pointer to the ndn_Name struct.
* @param value The null-terminated string, treated as a byte array. This does not copy the bytes.
* @return 0 for success, or an error code if there is no more room in the components array (nComponents is already maxComponents).
*/
ndn_Error ndn_Name_appendString(struct ndn_Name *self, char* value);
#ifdef __cplusplus
}
#endif
#endif