Previously, there was no description of the meaning of the fields. The
description added in this commit is based on dev mailing list discussion
of the field.
Change-Id: Iba183aeab69905c226c54935c15da7aeb5d522d5
Signed-off-by: William R. Dieter <william.r.dieter@intel.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/867
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: Vijay Kesavan <vijay.s.kesavan@intel.com>
Reviewed-by: Patrick Lankswert <patrick.lankswert@intel.com>
/**
* Quality of Service.
+ *
+ * OCQualityOfService attempts to abstract the guarantees provided by the underlying transport
+ * protocol. The precise definitions of each quality of service level depend on the
+ * implementation. In descriptions below are for the current implementation and may changed
+ * over time.
*/
typedef enum
{
+ /// Packet delivery is best effort
OC_LOW_QOS = 0,
+ /// Packet delivery is best effort
OC_MEDIUM_QOS,
+ /// Acknowledgements are used to confirm delivery
OC_HIGH_QOS,
- OC_NA_QOS // No Quality is defined, let the stack decide
+ /// No Quality is defined, let the stack decide
+ OC_NA_QOS
} OCQualityOfService;
/**