From 423ee16f5310376dcdab5bfa14d2d2f846b11ad4 Mon Sep 17 00:00:00 2001 From: Sergey Abramchuk Date: Wed, 26 Apr 2017 14:40:44 +0300 Subject: [PATCH] Add documentation comments to interface stats wrapper --- OpenVPN Adapter/OpenVPNInterfaceStats.h | 26 +++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/OpenVPN Adapter/OpenVPNInterfaceStats.h b/OpenVPN Adapter/OpenVPNInterfaceStats.h index c909a8a..81cddde 100644 --- a/OpenVPN Adapter/OpenVPNInterfaceStats.h +++ b/OpenVPN Adapter/OpenVPNInterfaceStats.h @@ -8,13 +8,39 @@ #import +/** + Class used to provide stats for an interface + */ @interface OpenVPNInterfaceStats : NSObject +/** + Amount of received bytes + */ @property (readonly, nonatomic) NSInteger bytesIn; + +/** + Amout of sent bytes + */ @property (readonly, nonatomic) NSInteger bytesOut; + +/** + Amount of received packets + */ @property (readonly, nonatomic) NSInteger packetsIn; + +/** + Amout of sent packets + */ @property (readonly, nonatomic) NSInteger packetsOut; + +/** + Amount of incoming packets handling errors + */ @property (readonly, nonatomic) NSInteger errorsIn; + +/** + Amount of outgoing packets handling errors + */ @property (readonly, nonatomic) NSInteger errorsOut; - (nonnull instancetype) __unavailable init;