self_pipe.hpp 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. // MIT License
  2. //
  3. // Copyright (c) 2016-2017 Simon Ninon <simon.ninon@gmail.com>
  4. //
  5. // Permission is hereby granted, free of charge, to any person obtaining a copy
  6. // of this software and associated documentation files (the "Software"), to deal
  7. // in the Software without restriction, including without limitation the rights
  8. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  9. // copies of the Software, and to permit persons to whom the Software is
  10. // furnished to do so, subject to the following conditions:
  11. //
  12. // The above copyright notice and this permission notice shall be included in all
  13. // copies or substantial portions of the Software.
  14. //
  15. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21. // SOFTWARE.
  22. #pragma once
  23. #include <tacopie/utils/typedefs.hpp>
  24. namespace tacopie {
  25. //!
  26. //! used to force poll to wake up
  27. //! simply make poll watch for read events on one side of the pipe and write to the other side
  28. //!
  29. class self_pipe {
  30. public:
  31. //! ctor
  32. self_pipe(void);
  33. //! dtor
  34. ~self_pipe(void);
  35. //! copy ctor
  36. self_pipe(const self_pipe&) = delete;
  37. //! assignment operator
  38. self_pipe& operator=(const self_pipe&) = delete;
  39. public:
  40. //!
  41. //! \return the read fd of the pipe
  42. //!
  43. fd_t get_read_fd(void) const;
  44. //!
  45. //! \return the write fd of the pipe
  46. //!
  47. fd_t get_write_fd(void) const;
  48. //!
  49. //! notify the self pipe (basically write to the pipe)
  50. //!
  51. void notify(void);
  52. //!
  53. //! clear the pipe (basically read from the pipe)
  54. //!
  55. void clr_buffer(void);
  56. private:
  57. #ifdef _WIN32
  58. //!
  59. //! socket fd
  60. //!
  61. fd_t m_fd;
  62. //!
  63. //! socket information
  64. //!
  65. struct sockaddr m_addr;
  66. //!
  67. //! socket information (addr len)
  68. //!
  69. int m_addr_len;
  70. #else
  71. //!
  72. //! pipe file descriptors
  73. //!
  74. fd_t m_fds[2];
  75. #endif /* _WIN32 */
  76. };
  77. } // namespace tacopie