Imported Upstream version 0.9.1

[platform/upstream/iotivity.git] / resource / csdk / connectivity / lib / libcoap-4.1.1 / async.h

diff --git a/resource/csdk/connectivity/lib/libcoap-4.1.1/async.h b/resource/csdk/connectivity/lib/libcoap-4.1.1/async.h
index 9f6c7b0..879cb38 100644 (file)
--- a/resource/csdk/connectivity/lib/libcoap-4.1.1/async.h
+++ b/resource/csdk/connectivity/lib/libcoap-4.1.1/async.h
@@ -3,10 +3,10 @@
  * Copyright (C) 2010,2011 Olaf Bergmann <bergmann@tzi.org>
  *
  * This file is part of the CoAP library libcoap. Please see
- * README for terms of use. 
+ * README for terms of use.
  */
 
-/** 
+/**
  * @file async.h
  * @brief state management for asynchronous messages
  */
@@ -32,7 +32,7 @@ typedef struct coap_async_state_t
 {
     unsigned char flags; /**< holds the flags to control behaviour */
 
-    /** 
+    /**
      * Holds the internal time when the object was registered with a
      * resource. This field will be updated whenever
      * coap_register_async() is called for a specific resource.
@@ -63,7 +63,7 @@ typedef struct coap_async_state_t
 /** release application data on destruction */
 #define COAP_ASYNC_RELEASE_DATA  0x08
 
-/** 
+/**
  * Allocates a new coap_async_state_t object and fills its fields
  * according to the given @p request. The @p flags are used to control
  * generation of empty ACK responses to stop retransmissions and to
@@ -72,7 +72,7 @@ typedef struct coap_async_state_t
  * coap_async_t object or @c NULL on error. Note that this function will
  * return @c NULL in case that an object with the same identifier is
  * already registered.
- * 
+ *
  * @param context  The context to use.
  * @param peer     The remote peer that is to be asynchronously notified.
  * @param request  The request that is handled asynchronously.
@@ -80,7 +80,7 @@ typedef struct coap_async_state_t
  * @param data     Opaque application data to register. Note that the
  *                 storage occupied by @p data is released on destruction
  *                 only if flag COAP_ASYNC_RELEASE_DATA is set.
- * 
+ *
  * @return A pointer to the registered coap_async_state_t object or
  * @c NULL in case of an error.
  */
@@ -88,52 +88,52 @@ coap_async_state_t *
 coap_register_async(coap_context_t *context, coap_address_t *peer, coap_pdu_t *request,
         unsigned char flags, void *data);
 
-/** 
+/**
  * Removes the state object identified by @p id from @p context. The
  * removed object is returned in @p s, if found. Otherwise, @p s is
  * undefined. This function returns @c 1 if the object was removed, @c
  * 0 otherwise. Note that the storage allocated for the stored object
  * is not released by this functions. You will have to call
  * coap_free_async() to do so.
- * 
+ *
  * @param context The context where the async object is registered.
  * @param id      The identifier of the asynchronous transaction.
- * @param s       Will be set to the object identified by @p id 
+ * @param s       Will be set to the object identified by @p id
  * after removal.
- * 
+ *
  * @return @c 1 if object was removed and @p s updated, or @c 0 if no
  * object was found with the given id. @p s is valid only if the
  * return value is @c 1.
  */
 int coap_remove_async(coap_context_t *context, coap_tid_t id, coap_async_state_t **s);
 
-/** 
+/**
  * Releases the memory that was allocated by coap_async_state_init()
  * for the object @p s. The registered application data will be
  * released automatically if COAP_ASYNC_RELEASE_DATA is set.
- * 
+ *
  * @param s The object to delete.
  */
 void
 coap_free_async(coap_async_state_t *state);
 
-/** 
+/**
  * Retrieves the object identified by @p id from the list of asynchronous
  * transactions that are registered with @p context. This function returns
  * a pointer to that object or @c NULL if not found.
- * 
- * @param context The context where the asynchronous objects are 
+ *
+ * @param context The context where the asynchronous objects are
  * registered with.
  * @param id      The id of the object to retrieve.
- * 
+ *
  * @return A pointer to the object identified by @p id or @c NULL if
  * not found.
  */
 coap_async_state_t *coap_find_async(coap_context_t *context, coap_tid_t id);
 
-/** 
+/**
  * Updates the time stamp of @p s.
- * 
+ *
  * @param s The state object to update.
  */
 static inline void coap_touch_async(coap_async_state_t *s)