ngtcp2_addr.h 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. /*
  2. * ngtcp2
  3. *
  4. * Copyright (c) 2019 ngtcp2 contributors
  5. *
  6. * Permission is hereby granted, free of charge, to any person obtaining
  7. * a copy of this software and associated documentation files (the
  8. * "Software"), to deal in the Software without restriction, including
  9. * without limitation the rights to use, copy, modify, merge, publish,
  10. * distribute, sublicense, and/or sell copies of the Software, and to
  11. * permit persons to whom the Software is furnished to do so, subject to
  12. * the following conditions:
  13. *
  14. * The above copyright notice and this permission notice shall be
  15. * included in all copies or substantial portions of the Software.
  16. *
  17. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  18. * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  20. * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  21. * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  22. * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  23. * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24. */
  25. #ifndef NGTCP2_ADDR_H
  26. #define NGTCP2_ADDR_H
  27. #ifdef HAVE_CONFIG_H
  28. # include <config.h>
  29. #endif /* defined(HAVE_CONFIG_H) */
  30. #include <ngtcp2/ngtcp2.h>
  31. /*
  32. * ngtcp2_addr_copy copies |src| to |dest|. This function assumes
  33. * that dest->addr points to a buffer which have sufficient size to
  34. * store the copy.
  35. */
  36. void ngtcp2_addr_copy(ngtcp2_addr *dest, const ngtcp2_addr *src);
  37. /**
  38. * @function
  39. *
  40. * `ngtcp2_addr_eq` returns nonzero if |a| equals |b|.
  41. */
  42. int ngtcp2_addr_eq(const ngtcp2_addr *a, const ngtcp2_addr *b);
  43. /* NGTCP2_ADDR_COMPARE_FLAG_NONE indicates that no flag set. */
  44. #define NGTCP2_ADDR_COMPARE_FLAG_NONE 0x0u
  45. /* NGTCP2_ADDR_COMPARE_FLAG_ADDR indicates IP addresses do not
  46. match. */
  47. #define NGTCP2_ADDR_COMPARE_FLAG_ADDR 0x1u
  48. /* NGTCP2_ADDR_COMPARE_FLAG_PORT indicates ports do not match. */
  49. #define NGTCP2_ADDR_COMPARE_FLAG_PORT 0x2u
  50. /* NGTCP2_ADDR_COMPARE_FLAG_FAMILY indicates address families do not
  51. match. */
  52. #define NGTCP2_ADDR_COMPARE_FLAG_FAMILY 0x4u
  53. /*
  54. * ngtcp2_addr_compare compares address and port between |a| and |b|,
  55. * and returns zero or more of NGTCP2_ADDR_COMPARE_FLAG_*.
  56. */
  57. uint32_t ngtcp2_addr_compare(const ngtcp2_addr *a, const ngtcp2_addr *b);
  58. /*
  59. * ngtcp2_addr_empty returns nonzero if |addr| has zero length
  60. * address.
  61. */
  62. int ngtcp2_addr_empty(const ngtcp2_addr *addr);
  63. #endif /* !defined(NGTCP2_ADDR_H) */