/**
* Define as empty, GNUNET_PACKED should suffice, but this won't work on W32
*/
-#define GNUNET_NETWORK_STRUCT_BEGIN
+#define GNUNET_NETWORK_STRUCT_BEGIN
/**
* Define as empty, GNUNET_PACKED should suffice, but this won't work on W32;
};
-
-/**
- * @brief A SHA-512 hashcode
- */
-struct GNUNET_HashCode
-{
- uint32_t bits[512 / 8 / sizeof (uint32_t)]; /* = 16 */
-};
-
-
-/**
- * The identity of the host (basically the SHA-512 hashcode of
- * it's public key).
- */
-struct GNUNET_PeerIdentity
-{
- struct GNUNET_HashCode hashPubKey;
-};
GNUNET_NETWORK_STRUCT_END
/**
*
* @param cls closure
* @param filename complete filename (absolute path)
- * @return GNUNET_OK to continue to iterate,
- * GNUNET_NO to stop iteration with no error,
- * GNUNET_SYSERR to abort iteration with error!
+ * @return #GNUNET_OK to continue to iterate,
+ * #GNUNET_NO to stop iteration with no error,
+ * #GNUNET_SYSERR to abort iteration with error!
*/
typedef int (*GNUNET_FileNameCallback) (void *cls, const char *filename);
#if !defined(GNUNET_CULL_LOGGING)
int
-GNUNET_get_log_call_status (int caller_level, const char *comp,
- const char *file, const char *function, int line);
+GNUNET_get_log_call_status (int caller_level,
+ const char *comp,
+ const char *file,
+ const char *function, int line);
#endif
* @param option name of missing option
*/
void
-GNUNET_log_config_missing (enum GNUNET_ErrorType kind,
+GNUNET_log_config_missing (enum GNUNET_ErrorType kind,
const char *section,
const char *option);
* @param required what is required that is invalid about the option
*/
void
-GNUNET_log_config_invalid (enum GNUNET_ErrorType kind,
+GNUNET_log_config_invalid (enum GNUNET_ErrorType kind,
const char *section,
const char *option,
const char *required);
* @param comp default component to use
* @param loglevel what types of messages should be logged
* @param logfile change logging to logfile (use NULL to keep stderr)
- * @return GNUNET_OK on success, GNUNET_SYSERR if logfile could not be opened
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR if logfile could not be opened
*/
int
GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile);
* Add a custom logger.
*
* @param logger log function
- * @param logger_cls closure for logger
+ * @param logger_cls closure for @a logger
*/
void
GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls);
*
* @param pid the peer identity
* @return string form of the pid; will be overwritten by next
- * call to GNUNET_i2s.
+ * call to #GNUNET_i2s.
*/
const char *
GNUNET_i2s (const struct GNUNET_PeerIdentity *pid);
*
* @param pid the peer identity
* @return string form of the pid; will be overwritten by next
- * call to GNUNET_i2s.
+ * call to #GNUNET_i2s.
*/
const char *
GNUNET_i2s_full (const struct GNUNET_PeerIdentity *pid);
* @param d the value in network byte order
* @return the same value in host byte order
*/
-double
+double
GNUNET_hton_double (double d);
/**
* @param d the value in network byte order
* @return the same value in host byte order
*/
-double
+double
GNUNET_ntoh_double (double d);
/* ************************* allocation functions ****************** */
/**
* @ingroup memory
- * Allocate a struct or union of the given 'type'.
- * Wrapper around GNUNET_malloc that returns a pointer
+ * Allocate a struct or union of the given @a type.
+ * Wrapper around #GNUNET_malloc that returns a pointer
* to the newly created object of the correct type.
*
* @param type name of the struct or union, i.e. pass 'struct Foo'.
* @ingroup memory
* Wrapper around free. Frees the memory referred to by ptr.
* Note that is is generally better to free memory that was
- * allocated with GNUNET_array_grow using GNUNET_array_grow(mem, size, 0) instead of GNUNET_free.
+ * allocated with #GNUNET_array_grow using #GNUNET_array_grow(mem, size, 0) instead of #GNUNET_free.
*
* @param ptr location where to free the memory. ptr must have
- * been returned by GNUNET_strdup, GNUNET_strndup, GNUNET_malloc or GNUNET_array_grow earlier.
+ * been returned by #GNUNET_strdup, #GNUNET_strndup, #GNUNET_malloc or #GNUNET_array_grow earlier.
*/
#define GNUNET_free(ptr) GNUNET_xfree_(ptr, __FILE__, __LINE__)
/**
* @ingroup memory
* Free the memory pointed to by ptr if ptr is not NULL.
- * Equivalent to if (ptr!=null)GNUNET_free(ptr).
+ * Equivalent to `if (NULL != ptr) GNUNET_free(ptr)`.
*
* @param ptr the location in memory to free
*/
/**
* @ingroup memory
- * Wrapper around GNUNET_strdup. Makes a copy of the zero-terminated string
+ * Wrapper around #GNUNET_xstrdup_. Makes a copy of the zero-terminated string
* pointed to by a.
*
* @param a pointer to a zero-terminated string
/**
* @ingroup memory
- * Wrapper around GNUNET_strndup. Makes a partial copy of the string
+ * Wrapper around #GNUNET_xstrndup_. Makes a partial copy of the string
* pointed to by a.
*
* @param a pointer to a string
/**
* @ingroup memory
* Grow a well-typed (!) array. This is a convenience
- * method to grow a vector <tt>arr</tt> of size <tt>size</tt>
- * to the new (target) size <tt>tsize</tt>.
+ * method to grow a vector @a arr of size @a size
+ * to the new (target) size @a tsize.
* <p>
*
* Example (simple, well-typed stack):
* Like snprintf, just aborts if the buffer is of insufficient size.
*
* @param buf pointer to buffer that is written to
- * @param size number of bytes in buf
+ * @param size number of bytes in @a buf
* @param format format strings
* @param ... data for format string
* @return number of bytes written to buf or negative value on error
/**
* Allocate memory. Checks the return value, aborts if no more
* memory is available. Don't use GNUNET_xmalloc_ directly. Use the
- * GNUNET_malloc macro.
+ * #GNUNET_malloc macro.
* The memory will be zero'ed out.
*
* @param size number of bytes to allocate
/**
* Allocate and initialize memory. Checks the return value, aborts if no more
* memory is available. Don't use GNUNET_xmemdup_ directly. Use the
- * GNUNET_memdup macro.
+ * #GNUNET_memdup macro.
*
* @param buf buffer to initialize from (must contain size bytes)
* @param size number of bytes to allocate
* Allocate memory. This function does not check if the allocation
* request is within reasonable bounds, allowing allocations larger
* than 40 MB. If you don't expect the possibility of very large
- * allocations, use GNUNET_malloc instead. The memory will be zero'ed
+ * allocations, use #GNUNET_malloc instead. The memory will be zero'ed
* out.
*
* @param size number of bytes to allocate
void *
GNUNET_xmalloc_unchecked_ (size_t size, const char *filename, int linenumber);
+
/**
* Reallocate memory. Checks the return value, aborts if no more
* memory is available.
void *
GNUNET_xrealloc_ (void *ptr, size_t n, const char *filename, int linenumber);
+
/**
* Free memory. Merely a wrapper for the case that we
* want to keep track of allocations. Don't use GNUNET_xfree_
- * directly. Use the GNUNET_free macro.
+ * directly. Use the #GNUNET_free macro.
*
* @param ptr pointer to memory to free
* @param filename where is this call being made (for debugging)
/**
- * Dup a string. Don't call GNUNET_xstrdup_ directly. Use the GNUNET_strdup macro.
+ * Dup a string. Don't call GNUNET_xstrdup_ directly. Use the #GNUNET_strdup macro.
* @param str string to duplicate
* @param filename where is this call being made (for debugging)
* @param linenumber line where this call is being made (for debugging)
GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber);
/**
- * Dup partially a string. Don't call GNUNET_xstrndup_ directly. Use the GNUNET_strndup macro.
+ * Dup partially a string. Don't call GNUNET_xstrndup_ directly. Use the #GNUNET_strndup macro.
*
* @param str string to duplicate
* @param len length of the string to duplicate
* Grows old by (*oldCount-newCount)*elementSize
* bytes and sets *oldCount to newCount.
*
- * Don't call GNUNET_xgrow_ directly. Use the GNUNET_array_grow macro.
+ * Don't call GNUNET_xgrow_ directly. Use the #GNUNET_array_grow macro.
*
* @param old address of the pointer to the array
* *old may be NULL
projects / oweals / gnunet.git / blobdiff