Browse Source

comments for exported funcs

Abhishek Kondur 2 years ago
parent
commit
6bc3417caf
2 changed files with 3 additions and 1 deletions
  1. 1 0
      logic/peers.go
  2. 2 1
      models/mqtt.go

+ 1 - 0
logic/peers.go

@@ -193,6 +193,7 @@ func GetPeersForProxy(node *models.Node, onlyPeers bool) (proxy_models.ProxyMana
 	return proxyPayload, nil
 	return proxyPayload, nil
 }
 }
 
 
+// GetPeerUpdateForHost - gets the consolidated peer update for the host from all networks
 func GetPeerUpdateForHost(host *models.Host) (models.HostPeerUpdate, error) {
 func GetPeerUpdateForHost(host *models.Host) (models.HostPeerUpdate, error) {
 	hostPeerUpdate := models.HostPeerUpdate{
 	hostPeerUpdate := models.HostPeerUpdate{
 		Network:       make(map[string]models.NetworkInfo),
 		Network:       make(map[string]models.NetworkInfo),

+ 2 - 1
models/mqtt.go

@@ -16,7 +16,7 @@ type PeerUpdate struct {
 	ProxyUpdate   proxy_models.ProxyManagerPayload `json:"proxy_update" bson:"proxy_update" yaml:"proxy_update"`
 	ProxyUpdate   proxy_models.ProxyManagerPayload `json:"proxy_update" bson:"proxy_update" yaml:"proxy_update"`
 }
 }
 
 
-// HostPeerUpdate
+// HostPeerUpdate - struct for host peer updates
 type HostPeerUpdate struct {
 type HostPeerUpdate struct {
 	ServerVersion string                           `json:"serverversion" bson:"serverversion" yaml:"serverversion"`
 	ServerVersion string                           `json:"serverversion" bson:"serverversion" yaml:"serverversion"`
 	ServerAddrs   []ServerAddr                     `json:"serveraddrs" bson:"serveraddrs" yaml:"serveraddrs"`
 	ServerAddrs   []ServerAddr                     `json:"serveraddrs" bson:"serveraddrs" yaml:"serveraddrs"`
@@ -26,6 +26,7 @@ type HostPeerUpdate struct {
 	ProxyUpdate   proxy_models.ProxyManagerPayload `json:"proxy_update" bson:"proxy_update" yaml:"proxy_update"`
 	ProxyUpdate   proxy_models.ProxyManagerPayload `json:"proxy_update" bson:"proxy_update" yaml:"proxy_update"`
 }
 }
 
 
+// NetworkInfo - struct for network info
 type NetworkInfo struct {
 type NetworkInfo struct {
 	DNS string `json:"dns" bson:"dns" yaml:"dns"`
 	DNS string `json:"dns" bson:"dns" yaml:"dns"`
 }
 }