quorum_trackstart.3.in 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. .\"/*
  2. .\" * Copyright (c) 2012 Red Hat, Inc.
  3. .\" *
  4. .\" * All rights reserved.
  5. .\" *
  6. .\" * Author: Fabio M. Di Nitto <fdinitto@redhat.com>
  7. .\" *
  8. .\" * This software licensed under BSD license, the text of which follows:
  9. .\" *
  10. .\" * Redistribution and use in source and binary forms, with or without
  11. .\" * modification, are permitted provided that the following conditions are met:
  12. .\" *
  13. .\" * - Redistributions of source code must retain the above copyright notice,
  14. .\" * this list of conditions and the following disclaimer.
  15. .\" * - Redistributions in binary form must reproduce the above copyright notice,
  16. .\" * this list of conditions and the following disclaimer in the documentation
  17. .\" * and/or other materials provided with the distribution.
  18. .\" * - Neither the name of the MontaVista Software, Inc. nor the names of its
  19. .\" * contributors may be used to endorse or promote products derived from this
  20. .\" * software without specific prior written permission.
  21. .\" *
  22. .\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23. .\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24. .\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25. .\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  26. .\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27. .\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28. .\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29. .\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30. .\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31. .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  32. .\" * THE POSSIBILITY OF SUCH DAMAGE.
  33. .\" */
  34. .TH QUORUM_TRACKSTART 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
  35. .SH NAME
  36. quorum_trackstart \- Enable callbacks notification.
  37. .SH SYNOPSIS
  38. .B #include <corosync/quorum.h>
  39. .sp
  40. .BI "int quorum_trackstart(quorum_handle_t *" handle ", unsigned int " flags ");
  41. .SH DESCRIPTION
  42. The
  43. .B quorum_trackstart
  44. function is used to enable callbacks notification from the quorum API.
  45. .PP
  46. Every time the voting configuraton changes (eg a node joins or leave the cluster)
  47. or the quorum status change, the notification is queued.
  48. .PP
  49. The notification is dispatched via
  50. .B quorum_dispatch()
  51. function that will execute the callback.
  52. .PP
  53. .SH RETURN VALUE
  54. This call returns the CS_OK value if successful, otherwise an error is returned.
  55. .PP
  56. .SH ERRORS
  57. @COMMONIPCERRORS@
  58. .SH "SEE ALSO"
  59. .BR quorum_initialize (3),
  60. .BR quorum_finalize (3),
  61. .BR quorum_fd_get (3),
  62. .BR quorum_dispatch (3),
  63. .BR quorum_trackstop (3),
  64. .PP