github.com/mysteriumnetwork/node@v0.0.0-20240516044423-365054f76801/nat/event/tracker.go (about)

     1  /*
     2   * Copyright (C) 2019 The "MysteriumNetwork/node" Authors.
     3   *
     4   * This program is free software: you can redistribute it and/or modify
     5   * it under the terms of the GNU General Public License as published by
     6   * the Free Software Foundation, either version 3 of the License, or
     7   * (at your option) any later version.
     8   *
     9   * This program is distributed in the hope that it will be useful,
    10   * but WITHOUT ANY WARRANTY; without even the implied warranty of
    11   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    12   * GNU General Public License for more details.
    13   *
    14   * You should have received a copy of the GNU General Public License
    15   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    16   */
    17  
    18  package event
    19  
    20  // AppTopicTraversal the topic that traversal events are published on
    21  const AppTopicTraversal = "Traversal"
    22  
    23  // BuildSuccessfulEvent returns new event for successful NAT traversal
    24  func BuildSuccessfulEvent(id, stage string) Event {
    25  	return Event{ID: id, Stage: stage, Successful: true}
    26  }
    27  
    28  // BuildFailureEvent returns new event for failed NAT traversal
    29  func BuildFailureEvent(id, stage string, err error) Event {
    30  	return Event{ID: id, Stage: stage, Successful: false, Error: err}
    31  }
    32  
    33  // Event represents a NAT traversal related event
    34  type Event struct {
    35  	ID         string `json:"id"`
    36  	Stage      string `json:"stage"`
    37  	Successful bool   `json:"successful"`
    38  	Error      error  `json:"error,omitempty"`
    39  }