candidatepair_state.go 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. // SPDX-FileCopyrightText: 2023 The Pion community <https://pion.ly>
  2. // SPDX-License-Identifier: MIT
  3. package ice
  4. // CandidatePairState represent the ICE candidate pair state
  5. type CandidatePairState int
  6. const (
  7. // CandidatePairStateWaiting means a check has not been performed for
  8. // this pair
  9. CandidatePairStateWaiting = iota + 1
  10. // CandidatePairStateInProgress means a check has been sent for this pair,
  11. // but the transaction is in progress.
  12. CandidatePairStateInProgress
  13. // CandidatePairStateFailed means a check for this pair was already done
  14. // and failed, either never producing any response or producing an unrecoverable
  15. // failure response.
  16. CandidatePairStateFailed
  17. // CandidatePairStateSucceeded means a check for this pair was already
  18. // done and produced a successful result.
  19. CandidatePairStateSucceeded
  20. )
  21. func (c CandidatePairState) String() string {
  22. switch c {
  23. case CandidatePairStateWaiting:
  24. return "waiting"
  25. case CandidatePairStateInProgress:
  26. return "in-progress"
  27. case CandidatePairStateFailed:
  28. return "failed"
  29. case CandidatePairStateSucceeded:
  30. return "succeeded"
  31. }
  32. return "Unknown candidate pair state"
  33. }