p2p/protocols: accounting api documentation added (#847)

p2p/protocols/accounting_api.go

@@ -6,7 +6,7 @@ import (
 
 const AccountingVersion = "1.0"
 
-var errNoAccountingMetrics = errors.New("no accounting metrics")
+var errNoAccountingMetrics = errors.New("accounting metrics not enabled")
 
 type AccountingApi struct {
 	metrics *AccountingMetrics
@@ -16,55 +16,63 @@ func NewAccountingApi(m *AccountingMetrics) *AccountingApi {
 	return &AccountingApi{m}
 }
 
+// BalanceCredit returns total amount of units credited by local node
 func (self *AccountingApi) BalanceCredit() (int64, error) {
 	if self.metrics == nil {
 		return 0, errNoAccountingMetrics
 	}
 	return mBalanceCredit.Count(), nil
 }
 
+// BalanceCredit returns total amount of units debited by local node
 func (self *AccountingApi) BalanceDebit() (int64, error) {
 	if self.metrics == nil {
 		return 0, errNoAccountingMetrics
 	}
 	return mBalanceDebit.Count(), nil
 }
 
+// BytesCredit returns total amount of bytes credited by local node
 func (self *AccountingApi) BytesCredit() (int64, error) {
 	if self.metrics == nil {
 		return 0, errNoAccountingMetrics
 	}
 	return mBytesCredit.Count(), nil
 }
 
+// BalanceCredit returns total amount of bytes debited by local node
 func (self *AccountingApi) BytesDebit() (int64, error) {
 	if self.metrics == nil {
 		return 0, errNoAccountingMetrics
 	}
 	return mBytesDebit.Count(), nil
 }
 
+// MsgCredit returns total amount of messages credited by local node
 func (self *AccountingApi) MsgCredit() (int64, error) {
 	if self.metrics == nil {
 		return 0, errNoAccountingMetrics
 	}
 	return mMsgCredit.Count(), nil
 }
 
+// MsgDebit returns total amount of messages debited by local node
 func (self *AccountingApi) MsgDebit() (int64, error) {
 	if self.metrics == nil {
 		return 0, errNoAccountingMetrics
 	}
 	return mMsgDebit.Count(), nil
 }
 
+// PeerDrops returns number of times when local node had to drop remote peers
 func (self *AccountingApi) PeerDrops() (int64, error) {
 	if self.metrics == nil {
 		return 0, errNoAccountingMetrics
 	}
 	return mPeerDrops.Count(), nil
 }
 
+// SelfDrops returns number of times when local node was overdrafted and dropped
 func (self *AccountingApi) SelfDrops() (int64, error) {
 	if self.metrics == nil {
 		return 0, errNoAccountingMetrics