riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: pkg: ccn-lite: fix documentation

Browse Source
This commit is contained in:
Oleg Hahm 2017-01-15 12:44:14 +01:00
parent 02077356d0
commit aac54d5a13
1 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
pkg/ccn-lite/ccn-lite-riot.h
View File

@ -108,6 +108,9 @@ extern "C" {
#define free_3ptr_list(a,b,c) ccnl_free(a), ccnl_free(b), ccnl_free(c) #define free_3ptr_list(a,b,c) ccnl_free(a), ccnl_free(b), ccnl_free(c)
#define free_4ptr_list(a,b,c,d) ccnl_free(a), ccnl_free(b), ccnl_free(c), ccnl_free(d); #define free_4ptr_list(a,b,c,d) ccnl_free(a), ccnl_free(b), ccnl_free(c), ccnl_free(d);
#define free_5ptr_list(a,b,c,d,e) ccnl_free(a), ccnl_free(b), ccnl_free(c), ccnl_free(d), ccnl_free(e); #define free_5ptr_list(a,b,c,d,e) ccnl_free(a), ccnl_free(b), ccnl_free(c), ccnl_free(d), ccnl_free(e);
/**
* @}
*/
/** /**
* Frees all memory directly and indirectly allocated for prefix information * Frees all memory directly and indirectly allocated for prefix information
@ -131,10 +134,13 @@ extern "C" {
*/ */
#define CCNL_QUEUE_SIZE (8) #define CCNL_QUEUE_SIZE (8)
/**
* @brief Data structure for interest packet
*/
typedef struct { typedef struct {
struct ccnl_prefix_s *prefix; struct ccnl_prefix_s *prefix; /**< requested prefix */
unsigned char *buf; unsigned char *buf; /**< buffer to store the interest packet */
size_t buflen; size_t buflen; /**< size of the buffer */
} ccnl_interest_t; } ccnl_interest_t;
@ -216,9 +222,11 @@ struct ccnl_interest_s *ccnl_send_interest(struct ccnl_prefix_s *prefix,
/** /**
* @brief Wait for incoming content chunk * @brief Wait for incoming content chunk
* *
* @pre The thread has to register for CCNL_CONT_CHUNK in @ref netreg first * @pre The thread has to register for CCNL_CONT_CHUNK in @ref net_gnrc_netreg
* first
* *
* @post The thread should unregister from @ref netreg after this function returns * @post The thread should unregister from @ref net_gnrc_netreg after this
* function returns
* *
* @param[out] buf Buffer to stores the received content * @param[out] buf Buffer to stores the received content
* @param[in] buf_len Size of @p buf * @param[in] buf_len Size of @p buf
@ -242,6 +250,16 @@ int ccnl_wait_for_chunk(void *buf, size_t buf_len, uint64_t timeout);
int ccnl_fib_add_entry(struct ccnl_relay_s *relay, struct ccnl_prefix_s *pfx, int ccnl_fib_add_entry(struct ccnl_relay_s *relay, struct ccnl_prefix_s *pfx,
struct ccnl_face_s *face); struct ccnl_face_s *face);
/**
* @brief Remove entry from the CCN-Lite FIB
*
* @par[in] relay Local relay struct
* @par[in] pfx Prefix of the FIB entry, may be NULL
* @par[in] face Face for the FIB entry, may be NULL
*
* @return 0 on success
* @return -1 on error
*/
int ccnl_fib_rem_entry(struct ccnl_relay_s *relay, struct ccnl_prefix_s *pfx, struct ccnl_face_s *face); int ccnl_fib_rem_entry(struct ccnl_relay_s *relay, struct ccnl_prefix_s *pfx, struct ccnl_face_s *face);
/** /**