Reviewed-by: Steven Dake <sdake@xxxxxxxxxx> On 02/09/2012 05:28 AM, Fabio M. Di Nitto wrote: > From: "Fabio M. Di Nitto" <fdinitto@xxxxxxxxxx> > > tidy up man/Makefile.am a bit in the process > > Signed-off-by: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx> > --- > :100644 100644 2d19fc7... 0315fcd... M man/.gitignore > :100644 100644 37fad93... 0fc3fbf... M man/Makefile.am > :100644 000000 f6bead5... 0000000... D man/cmap_context_get.3 > :000000 100644 0000000... f6bead5... A man/cmap_context_get.3.in > :100644 000000 da1f60c... 0000000... D man/cmap_context_set.3 > :000000 100644 0000000... da1f60c... A man/cmap_context_set.3.in > :100644 000000 792c377... 0000000... D man/cmap_dec.3 > :000000 100644 0000000... 792c377... A man/cmap_dec.3.in > :100644 000000 e2ee07d... 0000000... D man/cmap_delete.3 > :000000 100644 0000000... e2ee07d... A man/cmap_delete.3.in > :100644 000000 b791a5e... 0000000... D man/cmap_dispatch.3 > :000000 100644 0000000... b791a5e... A man/cmap_dispatch.3.in > :100644 000000 34245c6... 0000000... D man/cmap_fd_get.3 > :000000 100644 0000000... 34245c6... A man/cmap_fd_get.3.in > :100644 000000 4a2f8c0... 0000000... D man/cmap_finalize.3 > :000000 100644 0000000... 4a2f8c0... A man/cmap_finalize.3.in > :100644 000000 7e8c797... 0000000... D man/cmap_get.3 > :000000 100644 0000000... 7e8c797... A man/cmap_get.3.in > :100644 000000 5927eb2... 0000000... D man/cmap_inc.3 > :000000 100644 0000000... 5927eb2... A man/cmap_inc.3.in > :100644 000000 8bdb017... 0000000... D man/cmap_initialize.3 > :000000 100644 0000000... 8bdb017... A man/cmap_initialize.3.in > :100644 000000 df895d2... 0000000... D man/cmap_iter_finalize.3 > :000000 100644 0000000... df895d2... A man/cmap_iter_finalize.3.in > :100644 000000 e825406... 0000000... D man/cmap_iter_init.3 > :000000 100644 0000000... e825406... A man/cmap_iter_init.3.in > :100644 000000 edc29f8... 0000000... D man/cmap_iter_next.3 > :000000 100644 0000000... edc29f8... A man/cmap_iter_next.3.in > :100644 000000 72264f6... 0000000... D man/cmap_set.3 > :000000 100644 0000000... 72264f6... A man/cmap_set.3.in > :100644 000000 07a6581... 0000000... D man/cmap_track_add.3 > :000000 100644 0000000... 07a6581... A man/cmap_track_add.3.in > :100644 000000 6c28530... 0000000... D man/cmap_track_delete.3 > :000000 100644 0000000... 6c28530... A man/cmap_track_delete.3.in > :100644 000000 b9d5fde... 0000000... D man/cpg_context_get.3 > :000000 100644 0000000... b9d5fde... A man/cpg_context_get.3.in > :100644 000000 87d18de... 0000000... D man/cpg_context_set.3 > :000000 100644 0000000... 87d18de... A man/cpg_context_set.3.in > :100644 000000 f824a3f... 0000000... D man/cpg_dispatch.3 > :000000 100644 0000000... f824a3f... A man/cpg_dispatch.3.in > :100644 000000 33d9af6... 0000000... D man/cpg_fd_get.3 > :000000 100644 0000000... 33d9af6... A man/cpg_fd_get.3.in > :100644 000000 cc1382c... 0000000... D man/cpg_finalize.3 > :000000 100644 0000000... cc1382c... A man/cpg_finalize.3.in > :100644 000000 5012986... 0000000... D man/cpg_initialize.3 > :000000 100644 0000000... 5012986... A man/cpg_initialize.3.in > :100644 000000 f79b6f5... 0000000... D man/cpg_join.3 > :000000 100644 0000000... f79b6f5... A man/cpg_join.3.in > :100644 000000 c1cdb81... 0000000... D man/cpg_leave.3 > :000000 100644 0000000... c1cdb81... A man/cpg_leave.3.in > :100644 000000 7d9cfb4... 0000000... D man/cpg_local_get.3 > :000000 100644 0000000... 7d9cfb4... A man/cpg_local_get.3.in > :100644 000000 dc02350... 0000000... D man/cpg_mcast_joined.3 > :000000 100644 0000000... dc02350... A man/cpg_mcast_joined.3.in > :100644 000000 62dfebf... 0000000... D man/cpg_membership_get.3 > :000000 100644 0000000... 62dfebf... A man/cpg_membership_get.3.in > :100644 000000 259f77d... 0000000... D man/cpg_model_initialize.3 > :000000 100644 0000000... 259f77d... A man/cpg_model_initialize.3.in > :100644 000000 607922b... 0000000... D man/cpg_zcb_alloc.3 > :000000 100644 0000000... 607922b... A man/cpg_zcb_alloc.3.in > :100644 000000 f26e2c0... 0000000... D man/cpg_zcb_free.3 > :000000 100644 0000000... f26e2c0... A man/cpg_zcb_free.3.in > :100644 000000 bebded2... 0000000... D man/cpg_zcb_mcast_joined.3 > :000000 100644 0000000... bebded2... A man/cpg_zcb_mcast_joined.3.in > :100644 000000 9ef4d3a... 0000000... D man/evs_context_get.3 > :000000 100644 0000000... 9ef4d3a... A man/evs_context_get.3.in > :100644 000000 19d279f... 0000000... D man/evs_context_set.3 > :000000 100644 0000000... 19d279f... A man/evs_context_set.3.in > :100644 000000 2624a42... 0000000... D man/evs_dispatch.3 > :000000 100644 0000000... 2624a42... A man/evs_dispatch.3.in > :100644 000000 ece9036... 0000000... D man/evs_fd_get.3 > :000000 100644 0000000... ece9036... A man/evs_fd_get.3.in > :100644 000000 cc2c697... 0000000... D man/evs_finalize.3 > :000000 100644 0000000... cc2c697... A man/evs_finalize.3.in > :100644 000000 c5bd4dd... 0000000... D man/evs_initialize.3 > :000000 100644 0000000... c5bd4dd... A man/evs_initialize.3.in > :100644 000000 e6338d4... 0000000... D man/evs_join.3 > :000000 100644 0000000... e6338d4... A man/evs_join.3.in > :100644 000000 09ffe8e... 0000000... D man/evs_leave.3 > :000000 100644 0000000... 09ffe8e... A man/evs_leave.3.in > :100644 000000 4bb5c00... 0000000... D man/evs_mcast_groups.3 > :000000 100644 0000000... 4bb5c00... A man/evs_mcast_groups.3.in > :100644 000000 4d7d78e... 0000000... D man/evs_mcast_joined.3 > :000000 100644 0000000... 4d7d78e... A man/evs_mcast_joined.3.in > :100644 000000 657b243... 0000000... D man/evs_membership_get.3 > :000000 100644 0000000... 657b243... A man/evs_membership_get.3.in > :100644 000000 6295961... 0000000... D man/quorum_context_get.3 > :000000 100644 0000000... 6295961... A man/quorum_context_get.3.in > :100644 000000 42fd216... 0000000... D man/quorum_context_set.3 > :000000 100644 0000000... 42fd216... A man/quorum_context_set.3.in > :100644 000000 8f7c3a0... 0000000... D man/quorum_dispatch.3 > :000000 100644 0000000... 8f7c3a0... A man/quorum_dispatch.3.in > :100644 000000 b41eba1... 0000000... D man/quorum_fd_get.3 > :000000 100644 0000000... b41eba1... A man/quorum_fd_get.3.in > :100644 000000 d745cbb... 0000000... D man/quorum_finalize.3 > :000000 100644 0000000... d745cbb... A man/quorum_finalize.3.in > :100644 000000 ae6e34e... 0000000... D man/quorum_getquorate.3 > :000000 100644 0000000... ae6e34e... A man/quorum_getquorate.3.in > :100644 000000 5d92415... 0000000... D man/quorum_initialize.3 > :000000 100644 0000000... 5d92415... A man/quorum_initialize.3.in > :100644 000000 33d527e... 0000000... D man/sam_data_getsize.3 > :000000 100644 0000000... 33d527e... A man/sam_data_getsize.3.in > :100644 000000 32b816a... 0000000... D man/sam_data_restore.3 > :000000 100644 0000000... 32b816a... A man/sam_data_restore.3.in > :100644 000000 6e90651... 0000000... D man/sam_data_store.3 > :000000 100644 0000000... 6e90651... A man/sam_data_store.3.in > :100644 000000 c633a70... 0000000... D man/sam_finalize.3 > :000000 100644 0000000... c633a70... A man/sam_finalize.3.in > :100644 000000 91be22d... 0000000... D man/sam_hc_callback_register.3 > :000000 100644 0000000... 91be22d... A man/sam_hc_callback_register.3.in > :100644 000000 c8e9131... 0000000... D man/sam_hc_send.3 > :000000 100644 0000000... c8e9131... A man/sam_hc_send.3.in > :100644 000000 5a3334f... 0000000... D man/sam_initialize.3 > :000000 100644 0000000... 5a3334f... A man/sam_initialize.3.in > :100644 000000 dabe2da... 0000000... D man/sam_mark_failed.3 > :000000 100644 0000000... dabe2da... A man/sam_mark_failed.3.in > :100644 000000 2af86d2... 0000000... D man/sam_register.3 > :000000 100644 0000000... 2af86d2... A man/sam_register.3.in > :100644 000000 c49f230... 0000000... D man/sam_start.3 > :000000 100644 0000000... c49f230... A man/sam_start.3.in > :100644 000000 708d079... 0000000... D man/sam_stop.3 > :000000 100644 0000000... 708d079... A man/sam_stop.3.in > :100644 000000 ffc31eb... 0000000... D man/sam_warn_signal_set.3 > :000000 100644 0000000... ffc31eb... A man/sam_warn_signal_set.3.in > :100644 000000 a8e42d0... 0000000... D man/votequorum_context_get.3 > :000000 100644 0000000... a8e42d0... A man/votequorum_context_get.3.in > :100644 000000 f8ef0af... 0000000... D man/votequorum_context_set.3 > :000000 100644 0000000... f8ef0af... A man/votequorum_context_set.3.in > :100644 000000 8d5f8d1... 0000000... D man/votequorum_dispatch.3 > :000000 100644 0000000... 8d5f8d1... A man/votequorum_dispatch.3.in > :100644 000000 2687bc3... 0000000... D man/votequorum_fd_get.3 > :000000 100644 0000000... 2687bc3... A man/votequorum_fd_get.3.in > :100644 000000 c58aa89... 0000000... D man/votequorum_finalize.3 > :000000 100644 0000000... c58aa89... A man/votequorum_finalize.3.in > :100644 000000 3a40104... 0000000... D man/votequorum_getinfo.3 > :000000 100644 0000000... 3a40104... A man/votequorum_getinfo.3.in > :100644 000000 55548eb... 0000000... D man/votequorum_initialize.3 > :000000 100644 0000000... 55548eb... A man/votequorum_initialize.3.in > :100644 000000 90b5b51... 0000000... D man/votequorum_qdevice_getinfo.3 > :000000 100644 0000000... 90b5b51... A man/votequorum_qdevice_getinfo.3.in > :100644 000000 12030a6... 0000000... D man/votequorum_qdevice_poll.3 > :000000 100644 0000000... 12030a6... A man/votequorum_qdevice_poll.3.in > :100644 000000 a8704fd... 0000000... D man/votequorum_qdevice_register.3 > :000000 100644 0000000... a8704fd... A man/votequorum_qdevice_register.3.in > :100644 000000 4c72192... 0000000... D man/votequorum_qdevice_unregister.3 > :000000 100644 0000000... 4c72192... A man/votequorum_qdevice_unregister.3.in > :100644 000000 d33a6c9... 0000000... D man/votequorum_setexpected.3 > :000000 100644 0000000... d33a6c9... A man/votequorum_setexpected.3.in > :100644 000000 4fed319... 0000000... D man/votequorum_setvotes.3 > :000000 100644 0000000... 4fed319... A man/votequorum_setvotes.3.in > man/.gitignore | 1 + > man/Makefile.am | 213 ++++++++++++++--------------- > man/cmap_context_get.3 | 58 -------- > man/cmap_context_get.3.in | 58 ++++++++ > man/cmap_context_set.3 | 60 -------- > man/cmap_context_set.3.in | 60 ++++++++ > man/cmap_dec.3 | 92 ------------- > man/cmap_dec.3.in | 92 +++++++++++++ > man/cmap_delete.3 | 70 ---------- > man/cmap_delete.3.in | 70 ++++++++++ > man/cmap_dispatch.3 | 91 ------------- > man/cmap_dispatch.3.in | 91 +++++++++++++ > man/cmap_fd_get.3 | 67 --------- > man/cmap_fd_get.3.in | 67 +++++++++ > man/cmap_finalize.3 | 61 --------- > man/cmap_finalize.3.in | 61 +++++++++ > man/cmap_get.3 | 153 --------------------- > man/cmap_get.3.in | 153 +++++++++++++++++++++ > man/cmap_inc.3 | 92 ------------- > man/cmap_inc.3.in | 92 +++++++++++++ > man/cmap_initialize.3 | 63 --------- > man/cmap_initialize.3.in | 63 +++++++++ > man/cmap_iter_finalize.3 | 72 ---------- > man/cmap_iter_finalize.3.in | 72 ++++++++++ > man/cmap_iter_init.3 | 80 ----------- > man/cmap_iter_init.3.in | 80 +++++++++++ > man/cmap_iter_next.3 | 82 ----------- > man/cmap_iter_next.3.in | 82 +++++++++++ > man/cmap_set.3 | 127 ----------------- > man/cmap_set.3.in | 127 +++++++++++++++++ > man/cmap_track_add.3 | 164 ---------------------- > man/cmap_track_add.3.in | 164 ++++++++++++++++++++++ > man/cmap_track_delete.3 | 70 ---------- > man/cmap_track_delete.3.in | 70 ++++++++++ > man/cpg_context_get.3 | 68 ---------- > man/cpg_context_get.3.in | 68 ++++++++++ > man/cpg_context_set.3 | 69 ---------- > man/cpg_context_set.3.in | 69 ++++++++++ > man/cpg_dispatch.3 | 111 --------------- > man/cpg_dispatch.3.in | 111 +++++++++++++++ > man/cpg_fd_get.3 | 75 ---------- > man/cpg_fd_get.3.in | 75 ++++++++++ > man/cpg_finalize.3 | 71 ---------- > man/cpg_finalize.3.in | 71 ++++++++++ > man/cpg_initialize.3 | 175 ------------------------ > man/cpg_initialize.3.in | 175 ++++++++++++++++++++++++ > man/cpg_join.3 | 112 --------------- > man/cpg_join.3.in | 112 +++++++++++++++ > man/cpg_leave.3 | 77 ----------- > man/cpg_leave.3.in | 77 +++++++++++ > man/cpg_local_get.3 | 72 ---------- > man/cpg_local_get.3.in | 72 ++++++++++ > man/cpg_mcast_joined.3 | 141 ------------------- > man/cpg_mcast_joined.3.in | 141 +++++++++++++++++++ > man/cpg_membership_get.3 | 81 ----------- > man/cpg_membership_get.3.in | 81 +++++++++++ > man/cpg_model_initialize.3 | 231 -------------------------------- > man/cpg_model_initialize.3.in | 231 ++++++++++++++++++++++++++++++++ > man/cpg_zcb_alloc.3 | 84 ------------ > man/cpg_zcb_alloc.3.in | 84 ++++++++++++ > man/cpg_zcb_free.3 | 76 ----------- > man/cpg_zcb_free.3.in | 76 +++++++++++ > man/cpg_zcb_mcast_joined.3 | 127 ----------------- > man/cpg_zcb_mcast_joined.3.in | 127 +++++++++++++++++ > man/evs_context_get.3 | 64 --------- > man/evs_context_get.3.in | 64 +++++++++ > man/evs_context_set.3 | 66 --------- > man/evs_context_set.3.in | 66 +++++++++ > man/evs_dispatch.3 | 107 --------------- > man/evs_dispatch.3.in | 107 +++++++++++++++ > man/evs_fd_get.3 | 70 ---------- > man/evs_fd_get.3.in | 70 ++++++++++ > man/evs_finalize.3 | 66 --------- > man/evs_finalize.3.in | 66 +++++++++ > man/evs_initialize.3 | 121 ----------------- > man/evs_initialize.3.in | 121 +++++++++++++++++ > man/evs_join.3 | 105 --------------- > man/evs_join.3.in | 105 +++++++++++++++ > man/evs_leave.3 | 100 -------------- > man/evs_leave.3.in | 100 ++++++++++++++ > man/evs_mcast_groups.3 | 164 ---------------------- > man/evs_mcast_groups.3.in | 164 ++++++++++++++++++++++ > man/evs_mcast_joined.3 | 137 ------------------- > man/evs_mcast_joined.3.in | 137 +++++++++++++++++++ > man/evs_membership_get.3 | 74 ---------- > man/evs_membership_get.3.in | 74 ++++++++++ > man/quorum_context_get.3 | 57 -------- > man/quorum_context_get.3.in | 57 ++++++++ > man/quorum_context_set.3 | 59 -------- > man/quorum_context_set.3.in | 59 ++++++++ > man/quorum_dispatch.3 | 99 -------------- > man/quorum_dispatch.3.in | 99 ++++++++++++++ > man/quorum_fd_get.3 | 62 --------- > man/quorum_fd_get.3.in | 62 +++++++++ > man/quorum_finalize.3 | 59 -------- > man/quorum_finalize.3.in | 59 ++++++++ > man/quorum_getquorate.3 | 54 -------- > man/quorum_getquorate.3.in | 54 ++++++++ > man/quorum_initialize.3 | 128 ------------------ > man/quorum_initialize.3.in | 128 ++++++++++++++++++ > man/sam_data_getsize.3 | 68 ---------- > man/sam_data_getsize.3.in | 68 ++++++++++ > man/sam_data_restore.3 | 77 ----------- > man/sam_data_restore.3.in | 77 +++++++++++ > man/sam_data_store.3 | 83 ------------ > man/sam_data_store.3.in | 83 ++++++++++++ > man/sam_finalize.3 | 63 --------- > man/sam_finalize.3.in | 63 +++++++++ > man/sam_hc_callback_register.3 | 89 ------------ > man/sam_hc_callback_register.3.in | 89 ++++++++++++ > man/sam_hc_send.3 | 68 ---------- > man/sam_hc_send.3.in | 68 ++++++++++ > man/sam_initialize.3 | 123 ----------------- > man/sam_initialize.3.in | 123 +++++++++++++++++ > man/sam_mark_failed.3 | 73 ---------- > man/sam_mark_failed.3.in | 73 ++++++++++ > man/sam_register.3 | 88 ------------ > man/sam_register.3.in | 88 ++++++++++++ > man/sam_start.3 | 83 ------------ > man/sam_start.3.in | 83 ++++++++++++ > man/sam_stop.3 | 67 --------- > man/sam_stop.3.in | 67 +++++++++ > man/sam_warn_signal_set.3 | 63 --------- > man/sam_warn_signal_set.3.in | 63 +++++++++ > man/votequorum_context_get.3 | 58 -------- > man/votequorum_context_get.3.in | 58 ++++++++ > man/votequorum_context_set.3 | 60 -------- > man/votequorum_context_set.3.in | 60 ++++++++ > man/votequorum_dispatch.3 | 100 -------------- > man/votequorum_dispatch.3.in | 100 ++++++++++++++ > man/votequorum_fd_get.3 | 64 --------- > man/votequorum_fd_get.3.in | 64 +++++++++ > man/votequorum_finalize.3 | 61 --------- > man/votequorum_finalize.3.in | 61 +++++++++ > man/votequorum_getinfo.3 | 93 ------------- > man/votequorum_getinfo.3.in | 93 +++++++++++++ > man/votequorum_initialize.3 | 106 --------------- > man/votequorum_initialize.3.in | 106 +++++++++++++++ > man/votequorum_qdevice_getinfo.3 | 80 ----------- > man/votequorum_qdevice_getinfo.3.in | 80 +++++++++++ > man/votequorum_qdevice_poll.3 | 69 ---------- > man/votequorum_qdevice_poll.3.in | 69 ++++++++++ > man/votequorum_qdevice_register.3 | 68 ---------- > man/votequorum_qdevice_register.3.in | 68 ++++++++++ > man/votequorum_qdevice_unregister.3 | 60 -------- > man/votequorum_qdevice_unregister.3.in | 60 ++++++++ > man/votequorum_setexpected.3 | 60 -------- > man/votequorum_setexpected.3.in | 60 ++++++++ > man/votequorum_setvotes.3 | 57 -------- > man/votequorum_setvotes.3.in | 57 ++++++++ > 150 files changed, 6549 insertions(+), 6555 deletions(-) > > diff --git a/man/.gitignore b/man/.gitignore > index 2d19fc7..0315fcd 100644 > --- a/man/.gitignore > +++ b/man/.gitignore > @@ -1 +1,2 @@ > *.html > +*.3 > diff --git a/man/Makefile.am b/man/Makefile.am > index 37fad93..0fc3fbf 100644 > --- a/man/Makefile.am > +++ b/man/Makefile.am > @@ -34,12 +34,87 @@ > > MAINTAINERCLEANFILES = Makefile.in > > +if INSTALL_XMLCONF > xml_man = corosync-xmlproc.8 \ > corosync.xml.5 > +endif > > INDEX_HTML = index.html > > -autogen_man = > +autogen_man = cpg_context_get.3 \ > + cpg_context_set.3 \ > + cpg_dispatch.3 \ > + cpg_fd_get.3 \ > + cpg_finalize.3 \ > + cpg_initialize.3 \ > + cpg_join.3 \ > + cpg_leave.3 \ > + cpg_local_get.3 \ > + cpg_mcast_joined.3 \ > + cpg_model_initialize.3 \ > + cpg_zcb_mcast_joined.3 \ > + cpg_zcb_alloc.3 \ > + cpg_zcb_free.3 \ > + cpg_membership_get.3 \ > + evs_dispatch.3 \ > + evs_fd_get.3 \ > + evs_finalize.3 \ > + evs_initialize.3 \ > + evs_join.3 \ > + evs_leave.3 \ > + evs_mcast_groups.3 \ > + evs_mcast_joined.3 \ > + evs_membership_get.3 \ > + evs_context_get.3 \ > + evs_context_set.3 \ > + quorum_initialize.3 \ > + quorum_finalize.3 \ > + quorum_fd_get.3 \ > + quorum_dispatch.3 \ > + quorum_context_get.3 \ > + quorum_context_set.3 \ > + quorum_getquorate.3 \ > + votequorum_dispatch.3 \ > + votequorum_fd_get.3 \ > + votequorum_context_get.3 \ > + votequorum_context_set.3 \ > + votequorum_finalize.3 \ > + votequorum_getinfo.3 \ > + votequorum_initialize.3 \ > + votequorum_qdevice_getinfo.3 \ > + votequorum_qdevice_poll.3 \ > + votequorum_qdevice_register.3 \ > + votequorum_qdevice_unregister.3 \ > + votequorum_setexpected.3 \ > + votequorum_setvotes.3 \ > + sam_data_getsize.3 \ > + sam_data_restore.3 \ > + sam_data_store.3 \ > + sam_finalize.3 \ > + sam_hc_callback_register.3 \ > + sam_hc_send.3 \ > + sam_initialize.3 \ > + sam_mark_failed.3 \ > + sam_register.3 \ > + sam_start.3 \ > + sam_stop.3 \ > + sam_warn_signal_set.3 \ > + cmap_context_get.3 \ > + cmap_dec.3 \ > + cmap_iter_init.3 \ > + cmap_get.3 \ > + cmap_inc.3 \ > + cmap_set.3 \ > + cmap_iter_next.3 \ > + cmap_delete.3 \ > + cmap_iter_finalize.3 \ > + cmap_finalize.3 \ > + cmap_dispatch.3 \ > + cmap_initialize.3 \ > + cmap_track_add.3 \ > + cmap_context_set.3 \ > + cmap_fd_get.3 \ > + cmap_track_delete.3 > > autogen_common = ipc_common.sh.errors > > @@ -48,8 +123,31 @@ EXTRA_DIST = $(INDEX_HTML) \ > $(autogen_man:%=%.in) \ > $(autogen_common) > > -man_MANS = $(autogen_man) > - > +man_MANS = $(autogen_man) > + > +dist_man_MANS = $(xml_man) \ > + corosync.conf.5 \ > + votequorum.5 \ > + corosync.8 \ > + corosync-cmapctl.8 \ > + corosync-blackbox.8 \ > + corosync-keygen.8 \ > + corosync-cfgtool.8 \ > + corosync-cpgtool.8 \ > + corosync-fplay.8 \ > + corosync-pload.8 \ > + corosync-notifyd.8 \ > + corosync-quorumtool.8 \ > + corosync_overview.8 \ > + cpg_overview.8 \ > + evs_overview.8 \ > + votequorum_overview.8 \ > + sam_overview.8 \ > + cmap_overview.8 > + > +HTML_DOCS = $(dist_man_MANS:%=%.html) $(man_MANS:%=%.html) > + > +# developer man page generation > %.3: %.3.in $(autogen_common) $(top_srcdir)/build-aux/genman > @echo Generating $@ man page && \ > rm -f $@-t $@ && \ > @@ -59,108 +157,10 @@ man_MANS = $(autogen_man) > $(srcdir)/$(autogen_common) && \ > mv $@-t $@ > > -dist_man_MANS = \ > - corosync.conf.5 \ > - votequorum.5 \ > - corosync.8 \ > - corosync-cmapctl.8 \ > - corosync-blackbox.8 \ > - corosync-keygen.8 \ > - corosync-cfgtool.8 \ > - corosync-cpgtool.8 \ > - corosync-fplay.8 \ > - corosync-pload.8 \ > - corosync-notifyd.8 \ > - corosync-quorumtool.8 \ > - corosync_overview.8 \ > - cpg_overview.8 \ > - evs_overview.8 \ > - votequorum_overview.8 \ > - cpg_context_get.3 \ > - cpg_context_set.3 \ > - cpg_dispatch.3 \ > - cpg_fd_get.3 \ > - cpg_finalize.3 \ > - cpg_initialize.3 \ > - cpg_join.3 \ > - cpg_leave.3 \ > - cpg_local_get.3 \ > - cpg_mcast_joined.3 \ > - cpg_model_initialize.3 \ > - cpg_zcb_mcast_joined.3 \ > - cpg_zcb_alloc.3 \ > - cpg_zcb_free.3 \ > - cpg_membership_get.3 \ > - evs_dispatch.3 \ > - evs_fd_get.3 \ > - evs_finalize.3 \ > - evs_initialize.3 \ > - evs_join.3 \ > - evs_leave.3 \ > - evs_mcast_groups.3 \ > - evs_mcast_joined.3 \ > - evs_membership_get.3 \ > - evs_context_get.3 \ > - evs_context_set.3 \ > - quorum_initialize.3 \ > - quorum_finalize.3 \ > - quorum_fd_get.3 \ > - quorum_dispatch.3 \ > - quorum_context_get.3 \ > - quorum_context_set.3 \ > - quorum_getquorate.3 \ > - votequorum_dispatch.3 \ > - votequorum_fd_get.3 \ > - votequorum_context_get.3 \ > - votequorum_context_set.3 \ > - votequorum_finalize.3 \ > - votequorum_getinfo.3 \ > - votequorum_initialize.3 \ > - votequorum_qdevice_getinfo.3 \ > - votequorum_qdevice_poll.3 \ > - votequorum_qdevice_register.3 \ > - votequorum_qdevice_unregister.3 \ > - votequorum_setexpected.3 \ > - votequorum_setvotes.3 \ > - sam_data_getsize.3 \ > - sam_data_restore.3 \ > - sam_data_store.3 \ > - sam_finalize.3 \ > - sam_hc_callback_register.3 \ > - sam_hc_send.3 \ > - sam_initialize.3 \ > - sam_mark_failed.3 \ > - sam_overview.8 \ > - sam_register.3 \ > - sam_start.3 \ > - sam_stop.3 \ > - sam_warn_signal_set.3 \ > - cmap_context_get.3 \ > - cmap_dec.3 \ > - cmap_iter_init.3 \ > - cmap_get.3 \ > - cmap_inc.3 \ > - cmap_set.3 \ > - cmap_overview.8 \ > - cmap_iter_next.3 \ > - cmap_delete.3 \ > - cmap_iter_finalize.3 \ > - cmap_finalize.3 \ > - cmap_dispatch.3 \ > - cmap_initialize.3 \ > - cmap_track_add.3 \ > - cmap_context_set.3 \ > - cmap_fd_get.3 \ > - cmap_track_delete.3 > - > -if INSTALL_XMLCONF > -dist_man_MANS += $(xml_man) > -endif > +clean-local: > + rm -rf $(HTML_DOCS) $(autogen_man) > > if BUILD_HTML_DOCS > - > -HTML_DOCS = $(dist_man_MANS:%=%.html) $(man_MANS:%=%.html) > - > %.html: % > $(GROFF) -mandoc -Thtml $^ > $@ > > @@ -173,11 +173,4 @@ uninstall-local: > rmdir $(DESTDIR)/${docdir}/html 2> /dev/null || : > > all-local: $(HTML_DOCS) > - > -clean-local: > - rm -rf $(HTML_DOCS) $(autogen_man) > - > -else > -clean-local: > - rm -rf $(autogen_man) > endif > diff --git a/man/cmap_context_get.3 b/man/cmap_context_get.3 > deleted file mode 100644 > index f6bead5..0000000 > --- a/man/cmap_context_get.3 > +++ /dev/null > @@ -1,58 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "CMAP_CONTEXT_GET" 3 "23/01/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -cmap_context_get \- Gets the context variable for a CMAP instance > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/cmap.h>\fR > - > -.P > -\fBcs_error_t > -cmap_context_get (cmap_handle_t \fIhandle\fB, const void **\fIcontext\fB);\fR > - > -.SH DESCRIPTION > -.P > -The \fBcmap_context_get\fR function is used to retrieve the context variable previously stored using > -.B cmap_context_set(3). > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > - > -.SH "SEE ALSO" > -.BR cmap_context_set (3), > -.BR cmap_overview (8) > diff --git a/man/cmap_context_get.3.in b/man/cmap_context_get.3.in > new file mode 100644 > index 0000000..f6bead5 > --- /dev/null > +++ b/man/cmap_context_get.3.in > @@ -0,0 +1,58 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "CMAP_CONTEXT_GET" 3 "23/01/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +cmap_context_get \- Gets the context variable for a CMAP instance > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/cmap.h>\fR > + > +.P > +\fBcs_error_t > +cmap_context_get (cmap_handle_t \fIhandle\fB, const void **\fIcontext\fB);\fR > + > +.SH DESCRIPTION > +.P > +The \fBcmap_context_get\fR function is used to retrieve the context variable previously stored using > +.B cmap_context_set(3). > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > + > +.SH "SEE ALSO" > +.BR cmap_context_set (3), > +.BR cmap_overview (8) > diff --git a/man/cmap_context_set.3 b/man/cmap_context_set.3 > deleted file mode 100644 > index da1f60c..0000000 > --- a/man/cmap_context_set.3 > +++ /dev/null > @@ -1,60 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "CMAP_CONTEXT_SET" 3 "23/01/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -cmap_context_set \- Sets the context variable for a CMAP instance > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/cmap.h>\fR > - > -.P > -\fBcs_error_t > -cmap_context_set (cmap_handle_t \fIhandle\fB, const void *\fIcontext\fB);\fR > - > -.SH DESCRIPTION > -.P > -The \fBcmap_context_set\fR function is used to store the context variable for cmap instance. > -It has no meaning insire libcmap itself and will not be touched by the library. It can > -be retrieved using > -.B cmap_context_get(3). > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > - > -.SH "SEE ALSO" > -.BR cmap_context_get (3), > -.BR cmap_overview (8) > diff --git a/man/cmap_context_set.3.in b/man/cmap_context_set.3.in > new file mode 100644 > index 0000000..da1f60c > --- /dev/null > +++ b/man/cmap_context_set.3.in > @@ -0,0 +1,60 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "CMAP_CONTEXT_SET" 3 "23/01/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +cmap_context_set \- Sets the context variable for a CMAP instance > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/cmap.h>\fR > + > +.P > +\fBcs_error_t > +cmap_context_set (cmap_handle_t \fIhandle\fB, const void *\fIcontext\fB);\fR > + > +.SH DESCRIPTION > +.P > +The \fBcmap_context_set\fR function is used to store the context variable for cmap instance. > +It has no meaning insire libcmap itself and will not be touched by the library. It can > +be retrieved using > +.B cmap_context_get(3). > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > + > +.SH "SEE ALSO" > +.BR cmap_context_get (3), > +.BR cmap_overview (8) > diff --git a/man/cmap_dec.3 b/man/cmap_dec.3 > deleted file mode 100644 > index 792c377..0000000 > --- a/man/cmap_dec.3 > +++ /dev/null > @@ -1,92 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "CMAP_DEC" 3 "03/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -cmap_inc \- Decrease already stored value in CMAP > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/cmap.h>\fR > - > -.P > -\fBcs_error_t > -cmap_dec (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB);\fR > - > -.SH DESCRIPTION > -.P > -The > -.B cmap_dec > -function is used to decrease integer value of already stored key inside cmap. The > -.I handle > -argument is connection to CMAP database obtained by calling > -.B cmap_initialize(3) > -function. > -.I key_name > -is name of key to increase value of. > - > -Function is defined only on values where increase makes sense and is well defined, > -so it can be one of: > -.PP > -\fBCMAP_VALUETYPE_INT8\fR - 8-bit signed interger > -.PP > -\fBCMAP_VALUETYPE_UINT8\fR - 8-bit unsigned integer > -.PP > -\fBCMAP_VALUETYPE_INT16\fR - 16-bit signed interger > -.PP > -\fBCMAP_VALUETYPE_UINT16\fR - 16-bit unsigned integer > -.PP > -\fBCMAP_VALUETYPE_INT32\fR - 32-bit signed interger > -.PP > -\fBCMAP_VALUETYPE_UINT32\fR - 32-bit unsigned integer > -.PP > -\fBCMAP_VALUETYPE_INT64\fR - 64-bit signed interger > -.PP > -\fBCMAP_VALUETYPE_UINT64\fR - 64-bit unsigned integer > - > -Overflow/underflow is not detected and it's ignored. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful. If value or key_name are unspecified, CS_ERR_INVALID_PARAM > -is returned. CS_ERR_NOT_EXIST error is returned if key doesn't exist (wasn't created by calling > -.B cmap_set(3) > -first). Some of keys may be tagged read-only directly in corosync and seting such key will result in > -CS_ERR_ACCESS error. > - > -.SH "SEE ALSO" > -.BR cmap_get (3), > -.BR cmap_set (3), > -.BR cmap_initialize (3), > -.BR cmap_overview (8) > diff --git a/man/cmap_dec.3.in b/man/cmap_dec.3.in > new file mode 100644 > index 0000000..792c377 > --- /dev/null > +++ b/man/cmap_dec.3.in > @@ -0,0 +1,92 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "CMAP_DEC" 3 "03/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +cmap_inc \- Decrease already stored value in CMAP > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/cmap.h>\fR > + > +.P > +\fBcs_error_t > +cmap_dec (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB);\fR > + > +.SH DESCRIPTION > +.P > +The > +.B cmap_dec > +function is used to decrease integer value of already stored key inside cmap. The > +.I handle > +argument is connection to CMAP database obtained by calling > +.B cmap_initialize(3) > +function. > +.I key_name > +is name of key to increase value of. > + > +Function is defined only on values where increase makes sense and is well defined, > +so it can be one of: > +.PP > +\fBCMAP_VALUETYPE_INT8\fR - 8-bit signed interger > +.PP > +\fBCMAP_VALUETYPE_UINT8\fR - 8-bit unsigned integer > +.PP > +\fBCMAP_VALUETYPE_INT16\fR - 16-bit signed interger > +.PP > +\fBCMAP_VALUETYPE_UINT16\fR - 16-bit unsigned integer > +.PP > +\fBCMAP_VALUETYPE_INT32\fR - 32-bit signed interger > +.PP > +\fBCMAP_VALUETYPE_UINT32\fR - 32-bit unsigned integer > +.PP > +\fBCMAP_VALUETYPE_INT64\fR - 64-bit signed interger > +.PP > +\fBCMAP_VALUETYPE_UINT64\fR - 64-bit unsigned integer > + > +Overflow/underflow is not detected and it's ignored. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful. If value or key_name are unspecified, CS_ERR_INVALID_PARAM > +is returned. CS_ERR_NOT_EXIST error is returned if key doesn't exist (wasn't created by calling > +.B cmap_set(3) > +first). Some of keys may be tagged read-only directly in corosync and seting such key will result in > +CS_ERR_ACCESS error. > + > +.SH "SEE ALSO" > +.BR cmap_get (3), > +.BR cmap_set (3), > +.BR cmap_initialize (3), > +.BR cmap_overview (8) > diff --git a/man/cmap_delete.3 b/man/cmap_delete.3 > deleted file mode 100644 > index e2ee07d..0000000 > --- a/man/cmap_delete.3 > +++ /dev/null > @@ -1,70 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "CMAP_DELETE" 3 "03/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -cmap_delete \- Delete key/value pair from the CMAP service > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/cmap.h>\fR > - > -.P > -\fBcs_error_t > -cmap_delete(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB);\fR > - > -.SH DESCRIPTION > -.P > -The > -.B cmap_delete > -function is used to delete key from cmap. Key must be previously created by > -.B cmap_set(3) > -function. The > -.I handle > -argument is connection to CMAP database obtained by calling > -.B cmap_initialize(3) > -function. > -.I key_name > -is name of key to delete. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful. If key_name is unspecified, CS_ERR_INVALID_PARAM > -is returned. For nonexisting keys, CS_ERR_NOT_EXIST error is returned. Some of keys may be tagged > -read-only directly in corosync and deleting such key will result in CS_ERR_ACCESS error. > - > -.SH "SEE ALSO" > -.BR cmap_initialize (3), > -.BR cmap_set (3), > -.BR cmap_overview (8) > diff --git a/man/cmap_delete.3.in b/man/cmap_delete.3.in > new file mode 100644 > index 0000000..e2ee07d > --- /dev/null > +++ b/man/cmap_delete.3.in > @@ -0,0 +1,70 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "CMAP_DELETE" 3 "03/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +cmap_delete \- Delete key/value pair from the CMAP service > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/cmap.h>\fR > + > +.P > +\fBcs_error_t > +cmap_delete(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB);\fR > + > +.SH DESCRIPTION > +.P > +The > +.B cmap_delete > +function is used to delete key from cmap. Key must be previously created by > +.B cmap_set(3) > +function. The > +.I handle > +argument is connection to CMAP database obtained by calling > +.B cmap_initialize(3) > +function. > +.I key_name > +is name of key to delete. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful. If key_name is unspecified, CS_ERR_INVALID_PARAM > +is returned. For nonexisting keys, CS_ERR_NOT_EXIST error is returned. Some of keys may be tagged > +read-only directly in corosync and deleting such key will result in CS_ERR_ACCESS error. > + > +.SH "SEE ALSO" > +.BR cmap_initialize (3), > +.BR cmap_set (3), > +.BR cmap_overview (8) > diff --git a/man/cmap_dispatch.3 b/man/cmap_dispatch.3 > deleted file mode 100644 > index b791a5e..0000000 > --- a/man/cmap_dispatch.3 > +++ /dev/null > @@ -1,91 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "CMAP_DISPATCH" 3 "23/01/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -cmap_dispatch \- Dispatches callbacks from the CMAP service > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/cmap.h>\fR > - > -.P > -\fBcs_error_t > -cmap_dispatch (cmap_handle_t \fIhandle\fB, cs_dispatch_flags_t \fIdispatch_types\fB);\fR > - > -.SH DESCRIPTION > -The > -.B cmap_dispatch > -function is used to dispatch configuration changes. > -.PP > -Each application may have several connections to the CMAP API. Each application > -uses the > -.I handle > -argument to uniquely identify the connection. > -.PP > -The > -.I dispatch_types > -argument is used to identify the type of dispatch to execute. The possible types are > -CS_DISPATCH_ONE, CS_DISPATCH_ALL and CS_DISPATCH_BLOCKING. > - > -The dispatch values have the following meanings: > -.TP > -.B CS_DISPATCH_ONE > -Dispatch at least one callback, blocking until the callback is dispatched. > -.TP > -.B CS_DISPATCH_ALL > -Dispatch all waiting callbacks without blocking to wait for any callbacks. > -.TP > -.B CS_DISPATCH_BLOCKING > -Dispatch all callbacks blocking indefinitely. This is used in a threaded > -program where a thread is created, and then cs_dispatch() is called immediately > -from the created thread to execute callbacks. > -.TP > -.B CS_DISPATCH_ONE_NONBLOCKING > -Dispatch at most one callback. If there is no pending callback, > -CS_ERR_TRY_AGAIN is returned. > -.PP > -It's needed to call > -.B cmap_track_add(3) > -to add tracked items and receive callbacks. > - > -.SH RETURN VALUE > -.P > -This call returns the CS_OK value if successful, otherwise an error is returned. > - > -.SH "SEE ALSO" > -.BR cmap_track_add (3), > -.BR cmap_track_delete (3), > -.BR cmap_overview (8) > diff --git a/man/cmap_dispatch.3.in b/man/cmap_dispatch.3.in > new file mode 100644 > index 0000000..b791a5e > --- /dev/null > +++ b/man/cmap_dispatch.3.in > @@ -0,0 +1,91 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "CMAP_DISPATCH" 3 "23/01/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +cmap_dispatch \- Dispatches callbacks from the CMAP service > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/cmap.h>\fR > + > +.P > +\fBcs_error_t > +cmap_dispatch (cmap_handle_t \fIhandle\fB, cs_dispatch_flags_t \fIdispatch_types\fB);\fR > + > +.SH DESCRIPTION > +The > +.B cmap_dispatch > +function is used to dispatch configuration changes. > +.PP > +Each application may have several connections to the CMAP API. Each application > +uses the > +.I handle > +argument to uniquely identify the connection. > +.PP > +The > +.I dispatch_types > +argument is used to identify the type of dispatch to execute. The possible types are > +CS_DISPATCH_ONE, CS_DISPATCH_ALL and CS_DISPATCH_BLOCKING. > + > +The dispatch values have the following meanings: > +.TP > +.B CS_DISPATCH_ONE > +Dispatch at least one callback, blocking until the callback is dispatched. > +.TP > +.B CS_DISPATCH_ALL > +Dispatch all waiting callbacks without blocking to wait for any callbacks. > +.TP > +.B CS_DISPATCH_BLOCKING > +Dispatch all callbacks blocking indefinitely. This is used in a threaded > +program where a thread is created, and then cs_dispatch() is called immediately > +from the created thread to execute callbacks. > +.TP > +.B CS_DISPATCH_ONE_NONBLOCKING > +Dispatch at most one callback. If there is no pending callback, > +CS_ERR_TRY_AGAIN is returned. > +.PP > +It's needed to call > +.B cmap_track_add(3) > +to add tracked items and receive callbacks. > + > +.SH RETURN VALUE > +.P > +This call returns the CS_OK value if successful, otherwise an error is returned. > + > +.SH "SEE ALSO" > +.BR cmap_track_add (3), > +.BR cmap_track_delete (3), > +.BR cmap_overview (8) > diff --git a/man/cmap_fd_get.3 b/man/cmap_fd_get.3 > deleted file mode 100644 > index 34245c6..0000000 > --- a/man/cmap_fd_get.3 > +++ /dev/null > @@ -1,67 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "CMAP_FD_GET" 3 "23/01/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -cmap_fd_get \- Dispatches callbacks from the CMAP service > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/cmap.h>\fR > - > -.P > -\fBcs_error_t > -cmap_fd_get (cmap_handle_t \fIhandle\fB, int *\fIfd\fB);\fR > - > -.SH DESCRIPTION > -.P > -The > -.B cmap_fd_get > -function is used to retrieve the file descriptor that may be used with the poll > -system call to determine when > -.B cmap_dispatch(3) > -won't block. The > -.I handle > -argument may not be used directly with > -.B poll > -because it is not the file descriptor, but instead an internal identifier used > -by the CMAP library. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > - > -.SH "SEE ALSO" > -.BR cmap_dispatch (3), > -.BR cmap_overview (8) > diff --git a/man/cmap_fd_get.3.in b/man/cmap_fd_get.3.in > new file mode 100644 > index 0000000..34245c6 > --- /dev/null > +++ b/man/cmap_fd_get.3.in > @@ -0,0 +1,67 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "CMAP_FD_GET" 3 "23/01/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +cmap_fd_get \- Dispatches callbacks from the CMAP service > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/cmap.h>\fR > + > +.P > +\fBcs_error_t > +cmap_fd_get (cmap_handle_t \fIhandle\fB, int *\fIfd\fB);\fR > + > +.SH DESCRIPTION > +.P > +The > +.B cmap_fd_get > +function is used to retrieve the file descriptor that may be used with the poll > +system call to determine when > +.B cmap_dispatch(3) > +won't block. The > +.I handle > +argument may not be used directly with > +.B poll > +because it is not the file descriptor, but instead an internal identifier used > +by the CMAP library. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > + > +.SH "SEE ALSO" > +.BR cmap_dispatch (3), > +.BR cmap_overview (8) > diff --git a/man/cmap_finalize.3 b/man/cmap_finalize.3 > deleted file mode 100644 > index 4a2f8c0..0000000 > --- a/man/cmap_finalize.3 > +++ /dev/null > @@ -1,61 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "CMAP_FINALIZE" 3 "20/01/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -cmap_finalize \- Finalize connection to CMAP > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/cmap.h>\fR > - > -.P > -\fBcs_error_t cmap_finalize (cmap_handle_t \fIhandle\fB);\fR > - > -.SH DESCRIPTION > -.P > -The \fBcmap_finalize\fR function is used to to close a connection to the > -CMAP API. Once the connection is finalized, the handle may not be > -used again by applications. No more callbacks will be dispatched from the > -.B cmap_dispatch > -function. > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -CS_ERR_BAD_HANDLE error is returned when handle is invalid. > - > -.SH "SEE ALSO" > -.BR cmap_initialize (3), > -.BR cmap_dispatch (3), > -.BR cmap_overview (8) > diff --git a/man/cmap_finalize.3.in b/man/cmap_finalize.3.in > new file mode 100644 > index 0000000..4a2f8c0 > --- /dev/null > +++ b/man/cmap_finalize.3.in > @@ -0,0 +1,61 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "CMAP_FINALIZE" 3 "20/01/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +cmap_finalize \- Finalize connection to CMAP > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/cmap.h>\fR > + > +.P > +\fBcs_error_t cmap_finalize (cmap_handle_t \fIhandle\fB);\fR > + > +.SH DESCRIPTION > +.P > +The \fBcmap_finalize\fR function is used to to close a connection to the > +CMAP API. Once the connection is finalized, the handle may not be > +used again by applications. No more callbacks will be dispatched from the > +.B cmap_dispatch > +function. > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +CS_ERR_BAD_HANDLE error is returned when handle is invalid. > + > +.SH "SEE ALSO" > +.BR cmap_initialize (3), > +.BR cmap_dispatch (3), > +.BR cmap_overview (8) > diff --git a/man/cmap_get.3 b/man/cmap_get.3 > deleted file mode 100644 > index 7e8c797..0000000 > --- a/man/cmap_get.3 > +++ /dev/null > @@ -1,153 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "CMAP_GET" 3 "03/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -cmap_get \- Retreive value from CMAP > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/cmap.h>\fR > - > -.P > -\fBcs_error_t > -cmap_get (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, void *\fIvalue\fB, > -size_t *\fIvalue_len\fB, cmap_value_types_t *\fItype\fB);\fR > -.P > -Also shortcuts for different types are defined > -.P > -\fBcs_error_t cmap_get_int8 (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int8_t *\fIi8\fB);\fR > -.P > -\fBcs_error_t cmap_get_uint8 (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, uint8_t *\fIu8\fB);\fR > -.P > -\fBcs_error_t cmap_get_int16 (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int16_t *\fIi16\fB);\fR > -.P > -\fBcs_error_t cmap_get_uint16 (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, uint16_t *\fIu16\fB);\fR > -.P > -\fBcs_error_t cmap_get_int32 (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int32_t *\fIi32\fB);\fR > -.P > -\fBcs_error_t cmap_get_uint32 (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, uint32_t *\fIu32\fB);\fR > -.P > -\fBcs_error_t cmap_get_int64 (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int64_t *\fIi64\fB);\fR > -.P > -\fBcs_error_t cmap_get_uint64 (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, uint64_t *\fIu64\fB);\fR > -.P > -\fBcs_error_t cmap_get_float (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, float *\fIflt\fB);\fR > -.P > -\fBcs_error_t cmap_get_double (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, double *\fIdbl\fB);\fR > -.P > -\fBcs_error_t cmap_get_string (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, char **\fIstr\fB);\fR > - > -.SH DESCRIPTION > -.P > -The > -.B cmap_get > -function is used to retreive key from cmap previously set by > -.B cmap_set(3) > -function. The > -.I handle > -argument is connection to CMAP database obtained by calling > -.B cmap_initialize(3) > -function. > -.I key_name > -is name of key to get value from. > -.I value > -is pointer to preallocated data used as storage for data, but can be also NULL, and then only > -.I value_len > -and/or > -.I type > -is returned (both of them can also be NULL, allowing function to be used only for test of existence of key). > -If > -.I value > -is not NULL, actual length of value in map is checked against > -.I *value_len. > -If > -.I *value_len > -is shorter then length of value in map, error CS_ERR_INVALID_PARAM is returned. After successful copy of > -value, > -.I *value_len > -is set to actual length of value in map. Parameter > -.I type > -is pointer to memory, where type of value is stored after successful return. Pointer can also be NULL and > -then nothing is stored. Type can be one of: > -.PP > -\fBCMAP_VALUETYPE_INT8\fR - 8-bit signed interger > -.PP > -\fBCMAP_VALUETYPE_UINT8\fR - 8-bit unsigned integer > -.PP > -\fBCMAP_VALUETYPE_INT16\fR - 16-bit signed interger > -.PP > -\fBCMAP_VALUETYPE_UINT16\fR - 16-bit unsigned integer > -.PP > -\fBCMAP_VALUETYPE_INT32\fR - 32-bit signed interger > -.PP > -\fBCMAP_VALUETYPE_UINT32\fR - 32-bit unsigned integer > -.PP > -\fBCMAP_VALUETYPE_INT64\fR - 64-bit signed interger > -.PP > -\fBCMAP_VALUETYPE_UINT64\fR - 64-bit unsigned integer > -.PP > -\fBCMAP_VALUETYPE_FLOAT\fR - Float value > -.PP > -\fBCMAP_VALUETYPE_DOUBLE\fR - Double value > -.PP > -\fBCMAP_VALUETYPE_STRING\fR - C-style string > -.PP > -\fBCMAP_VALUETYPE_BINARY\fR - Binary data, byte with zero value has no special meaning > - > -Sortcut functions tests cmap type with it's own type. If type didn't match, CS_ERR_INVALID_PARAM error > -is returned. No conversions are done, so for example > -.B cmap_get_int16 > -is not able to return value with > -.B CMAP_VALUETYPE_INT8 > -type. > - > -String shortcut function returns newly allocated memory and caller is responsible for freeing that. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful. If value or key_name are unspecified, CS_ERR_INVALID_PARAM > -is returned. Same error is also returned if > -.I value > -is specified, and > -.I *value_len > -is too short for store of data. If key doesn't exists (it was not set by calling > -.B cmap_set(3) > -function first) CS_ERR_NOT_EXIST error is returned. For helper functions, > -CS_ERR_INVALID_PARAM is returned if type stored in cmap doesn't match with type of helper function. > - > -.SH "SEE ALSO" > -.BR cmap_set (3), > -.BR cmap_initialize (3), > -.BR cmap_overview (8) > diff --git a/man/cmap_get.3.in b/man/cmap_get.3.in > new file mode 100644 > index 0000000..7e8c797 > --- /dev/null > +++ b/man/cmap_get.3.in > @@ -0,0 +1,153 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "CMAP_GET" 3 "03/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +cmap_get \- Retreive value from CMAP > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/cmap.h>\fR > + > +.P > +\fBcs_error_t > +cmap_get (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, void *\fIvalue\fB, > +size_t *\fIvalue_len\fB, cmap_value_types_t *\fItype\fB);\fR > +.P > +Also shortcuts for different types are defined > +.P > +\fBcs_error_t cmap_get_int8 (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int8_t *\fIi8\fB);\fR > +.P > +\fBcs_error_t cmap_get_uint8 (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, uint8_t *\fIu8\fB);\fR > +.P > +\fBcs_error_t cmap_get_int16 (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int16_t *\fIi16\fB);\fR > +.P > +\fBcs_error_t cmap_get_uint16 (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, uint16_t *\fIu16\fB);\fR > +.P > +\fBcs_error_t cmap_get_int32 (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int32_t *\fIi32\fB);\fR > +.P > +\fBcs_error_t cmap_get_uint32 (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, uint32_t *\fIu32\fB);\fR > +.P > +\fBcs_error_t cmap_get_int64 (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int64_t *\fIi64\fB);\fR > +.P > +\fBcs_error_t cmap_get_uint64 (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, uint64_t *\fIu64\fB);\fR > +.P > +\fBcs_error_t cmap_get_float (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, float *\fIflt\fB);\fR > +.P > +\fBcs_error_t cmap_get_double (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, double *\fIdbl\fB);\fR > +.P > +\fBcs_error_t cmap_get_string (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, char **\fIstr\fB);\fR > + > +.SH DESCRIPTION > +.P > +The > +.B cmap_get > +function is used to retreive key from cmap previously set by > +.B cmap_set(3) > +function. The > +.I handle > +argument is connection to CMAP database obtained by calling > +.B cmap_initialize(3) > +function. > +.I key_name > +is name of key to get value from. > +.I value > +is pointer to preallocated data used as storage for data, but can be also NULL, and then only > +.I value_len > +and/or > +.I type > +is returned (both of them can also be NULL, allowing function to be used only for test of existence of key). > +If > +.I value > +is not NULL, actual length of value in map is checked against > +.I *value_len. > +If > +.I *value_len > +is shorter then length of value in map, error CS_ERR_INVALID_PARAM is returned. After successful copy of > +value, > +.I *value_len > +is set to actual length of value in map. Parameter > +.I type > +is pointer to memory, where type of value is stored after successful return. Pointer can also be NULL and > +then nothing is stored. Type can be one of: > +.PP > +\fBCMAP_VALUETYPE_INT8\fR - 8-bit signed interger > +.PP > +\fBCMAP_VALUETYPE_UINT8\fR - 8-bit unsigned integer > +.PP > +\fBCMAP_VALUETYPE_INT16\fR - 16-bit signed interger > +.PP > +\fBCMAP_VALUETYPE_UINT16\fR - 16-bit unsigned integer > +.PP > +\fBCMAP_VALUETYPE_INT32\fR - 32-bit signed interger > +.PP > +\fBCMAP_VALUETYPE_UINT32\fR - 32-bit unsigned integer > +.PP > +\fBCMAP_VALUETYPE_INT64\fR - 64-bit signed interger > +.PP > +\fBCMAP_VALUETYPE_UINT64\fR - 64-bit unsigned integer > +.PP > +\fBCMAP_VALUETYPE_FLOAT\fR - Float value > +.PP > +\fBCMAP_VALUETYPE_DOUBLE\fR - Double value > +.PP > +\fBCMAP_VALUETYPE_STRING\fR - C-style string > +.PP > +\fBCMAP_VALUETYPE_BINARY\fR - Binary data, byte with zero value has no special meaning > + > +Sortcut functions tests cmap type with it's own type. If type didn't match, CS_ERR_INVALID_PARAM error > +is returned. No conversions are done, so for example > +.B cmap_get_int16 > +is not able to return value with > +.B CMAP_VALUETYPE_INT8 > +type. > + > +String shortcut function returns newly allocated memory and caller is responsible for freeing that. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful. If value or key_name are unspecified, CS_ERR_INVALID_PARAM > +is returned. Same error is also returned if > +.I value > +is specified, and > +.I *value_len > +is too short for store of data. If key doesn't exists (it was not set by calling > +.B cmap_set(3) > +function first) CS_ERR_NOT_EXIST error is returned. For helper functions, > +CS_ERR_INVALID_PARAM is returned if type stored in cmap doesn't match with type of helper function. > + > +.SH "SEE ALSO" > +.BR cmap_set (3), > +.BR cmap_initialize (3), > +.BR cmap_overview (8) > diff --git a/man/cmap_inc.3 b/man/cmap_inc.3 > deleted file mode 100644 > index 5927eb2..0000000 > --- a/man/cmap_inc.3 > +++ /dev/null > @@ -1,92 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "CMAP_INC" 3 "03/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -cmap_inc \- Increase already stored value in CMAP > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/cmap.h>\fR > - > -.P > -\fBcs_error_t > -cmap_inc (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB);\fR > - > -.SH DESCRIPTION > -.P > -The > -.B cmap_inc > -function is used to increase integer value of already stored key inside cmap. The > -.I handle > -argument is connection to CMAP database obtained by calling > -.B cmap_initialize(3) > -function. > -.I key_name > -is name of key to increase value of. > - > -Function is defined only on values where increase makes sense and is well defined, > -so it can be one of: > -.PP > -\fBCMAP_VALUETYPE_INT8\fR - 8-bit signed interger > -.PP > -\fBCMAP_VALUETYPE_UINT8\fR - 8-bit unsigned integer > -.PP > -\fBCMAP_VALUETYPE_INT16\fR - 16-bit signed interger > -.PP > -\fBCMAP_VALUETYPE_UINT16\fR - 16-bit unsigned integer > -.PP > -\fBCMAP_VALUETYPE_INT32\fR - 32-bit signed interger > -.PP > -\fBCMAP_VALUETYPE_UINT32\fR - 32-bit unsigned integer > -.PP > -\fBCMAP_VALUETYPE_INT64\fR - 64-bit signed interger > -.PP > -\fBCMAP_VALUETYPE_UINT64\fR - 64-bit unsigned integer > - > -Overflow/underflow is not detected and it's ignored. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful. If value or key_name are unspecified, CS_ERR_INVALID_PARAM > -is returned. CS_ERR_NOT_EXIST error is returned if key doesn't exist (wasn't created by calling > -.B cmap_set(3) > -first). Some of keys may be tagged read-only directly in corosync and seting such key will result in > -CS_ERR_ACCESS error. > - > -.SH "SEE ALSO" > -.BR cmap_get (3), > -.BR cmap_set (3), > -.BR cmap_initialize (3), > -.BR cmap_overview (8) > diff --git a/man/cmap_inc.3.in b/man/cmap_inc.3.in > new file mode 100644 > index 0000000..5927eb2 > --- /dev/null > +++ b/man/cmap_inc.3.in > @@ -0,0 +1,92 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "CMAP_INC" 3 "03/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +cmap_inc \- Increase already stored value in CMAP > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/cmap.h>\fR > + > +.P > +\fBcs_error_t > +cmap_inc (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB);\fR > + > +.SH DESCRIPTION > +.P > +The > +.B cmap_inc > +function is used to increase integer value of already stored key inside cmap. The > +.I handle > +argument is connection to CMAP database obtained by calling > +.B cmap_initialize(3) > +function. > +.I key_name > +is name of key to increase value of. > + > +Function is defined only on values where increase makes sense and is well defined, > +so it can be one of: > +.PP > +\fBCMAP_VALUETYPE_INT8\fR - 8-bit signed interger > +.PP > +\fBCMAP_VALUETYPE_UINT8\fR - 8-bit unsigned integer > +.PP > +\fBCMAP_VALUETYPE_INT16\fR - 16-bit signed interger > +.PP > +\fBCMAP_VALUETYPE_UINT16\fR - 16-bit unsigned integer > +.PP > +\fBCMAP_VALUETYPE_INT32\fR - 32-bit signed interger > +.PP > +\fBCMAP_VALUETYPE_UINT32\fR - 32-bit unsigned integer > +.PP > +\fBCMAP_VALUETYPE_INT64\fR - 64-bit signed interger > +.PP > +\fBCMAP_VALUETYPE_UINT64\fR - 64-bit unsigned integer > + > +Overflow/underflow is not detected and it's ignored. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful. If value or key_name are unspecified, CS_ERR_INVALID_PARAM > +is returned. CS_ERR_NOT_EXIST error is returned if key doesn't exist (wasn't created by calling > +.B cmap_set(3) > +first). Some of keys may be tagged read-only directly in corosync and seting such key will result in > +CS_ERR_ACCESS error. > + > +.SH "SEE ALSO" > +.BR cmap_get (3), > +.BR cmap_set (3), > +.BR cmap_initialize (3), > +.BR cmap_overview (8) > diff --git a/man/cmap_initialize.3 b/man/cmap_initialize.3 > deleted file mode 100644 > index 8bdb017..0000000 > --- a/man/cmap_initialize.3 > +++ /dev/null > @@ -1,63 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "CMAP_INITIALIZE" 3 "20/01/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -cmap_initialize \- Initialize CMAP API > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/cmap.h>\fR > - > -.P > -\fBcs_error_t cmap_initialize (cmap_handle_t \fI*handle\fB);\fR > - > -.SH DESCRIPTION > -.P > -The \fBcmap_initialize\fR function is used to initialize a connection to > -the Configuration Map API. Each application may have several connections to the CMAP API. > -Each application uses the > -.I handle > -argument to uniquely identify the connection. The > -.I handle > -argument is then used in other function calls to identify the connection to be used > -for communication with the CMAP service. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > - > -.SH "SEE ALSO" > -.BR cmap_finalize (3), > -.BR cmap_overview (8) > diff --git a/man/cmap_initialize.3.in b/man/cmap_initialize.3.in > new file mode 100644 > index 0000000..8bdb017 > --- /dev/null > +++ b/man/cmap_initialize.3.in > @@ -0,0 +1,63 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "CMAP_INITIALIZE" 3 "20/01/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +cmap_initialize \- Initialize CMAP API > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/cmap.h>\fR > + > +.P > +\fBcs_error_t cmap_initialize (cmap_handle_t \fI*handle\fB);\fR > + > +.SH DESCRIPTION > +.P > +The \fBcmap_initialize\fR function is used to initialize a connection to > +the Configuration Map API. Each application may have several connections to the CMAP API. > +Each application uses the > +.I handle > +argument to uniquely identify the connection. The > +.I handle > +argument is then used in other function calls to identify the connection to be used > +for communication with the CMAP service. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > + > +.SH "SEE ALSO" > +.BR cmap_finalize (3), > +.BR cmap_overview (8) > diff --git a/man/cmap_iter_finalize.3 b/man/cmap_iter_finalize.3 > deleted file mode 100644 > index df895d2..0000000 > --- a/man/cmap_iter_finalize.3 > +++ /dev/null > @@ -1,72 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "CMAP_ITER_FINALIZE" 3 "06/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -cmap_iter_init \- Finalize iterator for keys stored in CMAP > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/cmap.h>\fR > - > -.P > -\fBcs_error_t > -cmap_iter_finalize (cmap_handle_t \fIhandle\fB, cmap_iter_handle_t \fIiter_handle\fB);\fR > - > -.SH DESCRIPTION > -.P > -The > -.B cmap_iter_finalize > -function is used to free up memory asociated with iteration obtained by calling of > -.B cmap_iter_init(3) > -function. > -The > -.I handle > -argument is connection to CMAP database obtained by calling > -.B cmap_initialize(3) > -function. > -.I iter_handle > -argument is iterator handle obtained by > -.B cmap_iter_init(3) > -function. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful. CS_ERR_BAD_HANDLE error is returned when iter_handle > -is invalid. > - > -.SH "SEE ALSO" > -.BR cmap_iter_init (3), > -.BR cmap_initialize (3), > -.BR cmap_overview (8) > diff --git a/man/cmap_iter_finalize.3.in b/man/cmap_iter_finalize.3.in > new file mode 100644 > index 0000000..df895d2 > --- /dev/null > +++ b/man/cmap_iter_finalize.3.in > @@ -0,0 +1,72 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "CMAP_ITER_FINALIZE" 3 "06/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +cmap_iter_init \- Finalize iterator for keys stored in CMAP > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/cmap.h>\fR > + > +.P > +\fBcs_error_t > +cmap_iter_finalize (cmap_handle_t \fIhandle\fB, cmap_iter_handle_t \fIiter_handle\fB);\fR > + > +.SH DESCRIPTION > +.P > +The > +.B cmap_iter_finalize > +function is used to free up memory asociated with iteration obtained by calling of > +.B cmap_iter_init(3) > +function. > +The > +.I handle > +argument is connection to CMAP database obtained by calling > +.B cmap_initialize(3) > +function. > +.I iter_handle > +argument is iterator handle obtained by > +.B cmap_iter_init(3) > +function. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful. CS_ERR_BAD_HANDLE error is returned when iter_handle > +is invalid. > + > +.SH "SEE ALSO" > +.BR cmap_iter_init (3), > +.BR cmap_initialize (3), > +.BR cmap_overview (8) > diff --git a/man/cmap_iter_init.3 b/man/cmap_iter_init.3 > deleted file mode 100644 > index e825406..0000000 > --- a/man/cmap_iter_init.3 > +++ /dev/null > @@ -1,80 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "CMAP_ITER_INIT" 3 "03/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -cmap_iter_init \- Initialize iterator for keys stored in CMAP > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/cmap.h>\fR > - > -.P > -\fBcs_error_t > -cmap_iter_init (cmap_handle_t \fIhandle\fB, const char *\fIprefix\fB, cmap_iter_handle_t *\fIcmap_iter_handle\fB);\fR > - > -.SH DESCRIPTION > -.P > -The > -.B cmap_iter_init > -function is used to initialize iteration of all keys with given > -.I prefix. > -The > -.I handle > -argument is connection to CMAP database obtained by calling > -.B cmap_initialize(3) > -function. > -.I prefix > -is string, and every returned key must have name with given prefix. This variable can also > -be NULL (or empty string) and then all keys are iterated. > - > -.B cmap_iter_init > -is used only for initialize context for future > -.B cmap_iter_next(3) > -calls and handle needed for that function is returned in > -.I cmap_iter_handle > -variable. When you have finished iteration over objects, call > -.B cmap_iter_finalize(3) > -function to free up memory associated with iteration. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful. If there are no items with given prefixes, > -CS_ERR_NO_SECTIONS is returned. > - > -.SH "SEE ALSO" > -.BR cmap_iter_next (3), > -.BR cmap_iter_finalize (3), > -.BR cmap_initialize (3), > -.BR cmap_overview (8) > diff --git a/man/cmap_iter_init.3.in b/man/cmap_iter_init.3.in > new file mode 100644 > index 0000000..e825406 > --- /dev/null > +++ b/man/cmap_iter_init.3.in > @@ -0,0 +1,80 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "CMAP_ITER_INIT" 3 "03/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +cmap_iter_init \- Initialize iterator for keys stored in CMAP > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/cmap.h>\fR > + > +.P > +\fBcs_error_t > +cmap_iter_init (cmap_handle_t \fIhandle\fB, const char *\fIprefix\fB, cmap_iter_handle_t *\fIcmap_iter_handle\fB);\fR > + > +.SH DESCRIPTION > +.P > +The > +.B cmap_iter_init > +function is used to initialize iteration of all keys with given > +.I prefix. > +The > +.I handle > +argument is connection to CMAP database obtained by calling > +.B cmap_initialize(3) > +function. > +.I prefix > +is string, and every returned key must have name with given prefix. This variable can also > +be NULL (or empty string) and then all keys are iterated. > + > +.B cmap_iter_init > +is used only for initialize context for future > +.B cmap_iter_next(3) > +calls and handle needed for that function is returned in > +.I cmap_iter_handle > +variable. When you have finished iteration over objects, call > +.B cmap_iter_finalize(3) > +function to free up memory associated with iteration. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful. If there are no items with given prefixes, > +CS_ERR_NO_SECTIONS is returned. > + > +.SH "SEE ALSO" > +.BR cmap_iter_next (3), > +.BR cmap_iter_finalize (3), > +.BR cmap_initialize (3), > +.BR cmap_overview (8) > diff --git a/man/cmap_iter_next.3 b/man/cmap_iter_next.3 > deleted file mode 100644 > index edc29f8..0000000 > --- a/man/cmap_iter_next.3 > +++ /dev/null > @@ -1,82 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "CMAP_ITER_NEXT" 3 "06/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -cmap_iter_next \- Return next item in iteration in CMAP > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/cmap.h>\fR > - > -.P > -\fBcs_error_t > -cmap_iter_next(cmap_handle_t \fIhandle\fB, cmap_iter_handle_t \fIiter_handle\fB, char \fIkey_name[]\fB, > -size_t *\fIvalue_len\fB, cmap_value_types_t *\fItype\fB);\fR > - > -.SH DESCRIPTION > -.P > -The > -.B cmap_iter_next > -function is used to get next value in iteration. The > -.I handle > -argument is connection to CMAP database obtained by calling > -.B cmap_initialize(3) > -function. > -.I iter_handle > -argument is iterator handle obtained by > -.B cmap_iter_init(3) > -function. Following key name is stored inside > -.I key_name > -argument, which must be preallocated by caller and its quaranted maximum size is CMAP_KEYNAME_MAXLEN > -(urrently 255). > -.I value_len > -is pointer where length of value is stored, but can be NULL. > -.I type > -is also optional argument (can be NULL) and here type of value is stored (type is one of types described > -in > -.B cmap_get(3) > -function). > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful. If there are no more items to iterate, CS_NO_SECTION > -error code is returned. > - > -.SH "SEE ALSO" > -.BR cmap_iter_init (3), > -.BR cmap_iter_finalize (3), > -.BR cmap_initialize (3), > -.BR cmap_get (3), > -.BR cmap_overview (8) > diff --git a/man/cmap_iter_next.3.in b/man/cmap_iter_next.3.in > new file mode 100644 > index 0000000..edc29f8 > --- /dev/null > +++ b/man/cmap_iter_next.3.in > @@ -0,0 +1,82 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "CMAP_ITER_NEXT" 3 "06/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +cmap_iter_next \- Return next item in iteration in CMAP > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/cmap.h>\fR > + > +.P > +\fBcs_error_t > +cmap_iter_next(cmap_handle_t \fIhandle\fB, cmap_iter_handle_t \fIiter_handle\fB, char \fIkey_name[]\fB, > +size_t *\fIvalue_len\fB, cmap_value_types_t *\fItype\fB);\fR > + > +.SH DESCRIPTION > +.P > +The > +.B cmap_iter_next > +function is used to get next value in iteration. The > +.I handle > +argument is connection to CMAP database obtained by calling > +.B cmap_initialize(3) > +function. > +.I iter_handle > +argument is iterator handle obtained by > +.B cmap_iter_init(3) > +function. Following key name is stored inside > +.I key_name > +argument, which must be preallocated by caller and its quaranted maximum size is CMAP_KEYNAME_MAXLEN > +(urrently 255). > +.I value_len > +is pointer where length of value is stored, but can be NULL. > +.I type > +is also optional argument (can be NULL) and here type of value is stored (type is one of types described > +in > +.B cmap_get(3) > +function). > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful. If there are no more items to iterate, CS_NO_SECTION > +error code is returned. > + > +.SH "SEE ALSO" > +.BR cmap_iter_init (3), > +.BR cmap_iter_finalize (3), > +.BR cmap_initialize (3), > +.BR cmap_get (3), > +.BR cmap_overview (8) > diff --git a/man/cmap_set.3 b/man/cmap_set.3 > deleted file mode 100644 > index 72264f6..0000000 > --- a/man/cmap_set.3 > +++ /dev/null > @@ -1,127 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "CMAP_SET" 3 "23/01/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -cmap_set \- Store value in CMAP > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/cmap.h>\fR > - > -.P > -\fBcs_error_t > -cmap_set (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, const void *\fIvalue\fB, > -size_t \fIvalue_len\fB, cmap_value_types_t \fItype\fB);\fR > -.P > -Also shortcuts for different types are defined > -.P > -\fBcs_error_t cmap_set_int8(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int8_t \fIvalue\fB);\fR > -.P > -\fBcs_error_t cmap_set_uint8(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, uint8_t \fIvalue\fB);\fR > -.P > -\fBcs_error_t cmap_set_int16(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int16_t \fIvalue\fB);\fR > -.P > -\fBcs_error_t cmap_set_uint16(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, uint16_t \fIvalue\fB);\fR > -.P > -\fBcs_error_t cmap_set_int32(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int32_t \fIvalue\fB);\fR > -.P > -\fBcs_error_t cmap_set_uint32(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, uint32_t \fIvalue\fB);\fR > -.P > -\fBcs_error_t cmap_set_int64(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int64_t \fIvalue\fB);\fR > -.P > -\fBcs_error_t cmap_set_uint64(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, uint64_t \fIvalue\fB);\fR > -.P > -\fBcs_error_t cmap_set_float(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, float \fIvalue\fB);\fR > -.P > -\fBcs_error_t cmap_set_double(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, double \fIvalue\fB);\fR > -.P > -\fBcs_error_t cmap_set_string(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, const char *\fIvalue\fB);\fR > - > -.SH DESCRIPTION > -.P > -The > -.B cmap_set > -function is used to store key inside cmap. The > -.I handle > -argument is connection to CMAP database obtained by calling > -.B cmap_initialize(3) > -function. > -.I key_name > -is name of key to set value. Key name is limited by minimal (CMAP_KEYNAME_MINLEN, currently 3) and > -maximal (CMAP_KEYNAME_MAXLEN, currently 255) length. Also key can contain only limited set of characters expressed > -by regexp [a-zA-Z0-9._-/:]*. > -.I value > -is pointer to allocated data which will be stored inside CMAP. Length of value (number of bytes) is supplied > -as > -.I value_len > -parameter. Last parameter is > -.I type > -which gives type of value. It may be one of: > -.PP > -\fBCMAP_VALUETYPE_INT8\fR - 8-bit signed interger > -.PP > -\fBCMAP_VALUETYPE_UINT8\fR - 8-bit unsigned integer > -.PP > -\fBCMAP_VALUETYPE_INT16\fR - 16-bit signed interger > -.PP > -\fBCMAP_VALUETYPE_UINT16\fR - 16-bit unsigned integer > -.PP > -\fBCMAP_VALUETYPE_INT32\fR - 32-bit signed interger > -.PP > -\fBCMAP_VALUETYPE_UINT32\fR - 32-bit unsigned integer > -.PP > -\fBCMAP_VALUETYPE_INT64\fR - 64-bit signed interger > -.PP > -\fBCMAP_VALUETYPE_UINT64\fR - 64-bit unsigned integer > -.PP > -\fBCMAP_VALUETYPE_FLOAT\fR - Float value > -.PP > -\fBCMAP_VALUETYPE_DOUBLE\fR - Double value > -.PP > -\fBCMAP_VALUETYPE_STRING\fR - C-style string > -.PP > -\fBCMAP_VALUETYPE_BINARY\fR - Binary data, byte with zero value has no special meaning > - > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful. If value or key_name are unspecified, CS_ERR_INVALID_PARAM > -is returned. Too short or too long key_name returns CS_ERR_NAME_TOO_LONG error code. Some of keys may > -be tagged read-only directly in corosync and seting such key will result in CS_ERR_ACCESS error. > - > -.SH "SEE ALSO" > -.BR cmap_get (3), > -.BR cmap_initialize (3), > -.BR cmap_overview (8) > diff --git a/man/cmap_set.3.in b/man/cmap_set.3.in > new file mode 100644 > index 0000000..72264f6 > --- /dev/null > +++ b/man/cmap_set.3.in > @@ -0,0 +1,127 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "CMAP_SET" 3 "23/01/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +cmap_set \- Store value in CMAP > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/cmap.h>\fR > + > +.P > +\fBcs_error_t > +cmap_set (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, const void *\fIvalue\fB, > +size_t \fIvalue_len\fB, cmap_value_types_t \fItype\fB);\fR > +.P > +Also shortcuts for different types are defined > +.P > +\fBcs_error_t cmap_set_int8(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int8_t \fIvalue\fB);\fR > +.P > +\fBcs_error_t cmap_set_uint8(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, uint8_t \fIvalue\fB);\fR > +.P > +\fBcs_error_t cmap_set_int16(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int16_t \fIvalue\fB);\fR > +.P > +\fBcs_error_t cmap_set_uint16(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, uint16_t \fIvalue\fB);\fR > +.P > +\fBcs_error_t cmap_set_int32(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int32_t \fIvalue\fB);\fR > +.P > +\fBcs_error_t cmap_set_uint32(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, uint32_t \fIvalue\fB);\fR > +.P > +\fBcs_error_t cmap_set_int64(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int64_t \fIvalue\fB);\fR > +.P > +\fBcs_error_t cmap_set_uint64(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, uint64_t \fIvalue\fB);\fR > +.P > +\fBcs_error_t cmap_set_float(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, float \fIvalue\fB);\fR > +.P > +\fBcs_error_t cmap_set_double(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, double \fIvalue\fB);\fR > +.P > +\fBcs_error_t cmap_set_string(cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, const char *\fIvalue\fB);\fR > + > +.SH DESCRIPTION > +.P > +The > +.B cmap_set > +function is used to store key inside cmap. The > +.I handle > +argument is connection to CMAP database obtained by calling > +.B cmap_initialize(3) > +function. > +.I key_name > +is name of key to set value. Key name is limited by minimal (CMAP_KEYNAME_MINLEN, currently 3) and > +maximal (CMAP_KEYNAME_MAXLEN, currently 255) length. Also key can contain only limited set of characters expressed > +by regexp [a-zA-Z0-9._-/:]*. > +.I value > +is pointer to allocated data which will be stored inside CMAP. Length of value (number of bytes) is supplied > +as > +.I value_len > +parameter. Last parameter is > +.I type > +which gives type of value. It may be one of: > +.PP > +\fBCMAP_VALUETYPE_INT8\fR - 8-bit signed interger > +.PP > +\fBCMAP_VALUETYPE_UINT8\fR - 8-bit unsigned integer > +.PP > +\fBCMAP_VALUETYPE_INT16\fR - 16-bit signed interger > +.PP > +\fBCMAP_VALUETYPE_UINT16\fR - 16-bit unsigned integer > +.PP > +\fBCMAP_VALUETYPE_INT32\fR - 32-bit signed interger > +.PP > +\fBCMAP_VALUETYPE_UINT32\fR - 32-bit unsigned integer > +.PP > +\fBCMAP_VALUETYPE_INT64\fR - 64-bit signed interger > +.PP > +\fBCMAP_VALUETYPE_UINT64\fR - 64-bit unsigned integer > +.PP > +\fBCMAP_VALUETYPE_FLOAT\fR - Float value > +.PP > +\fBCMAP_VALUETYPE_DOUBLE\fR - Double value > +.PP > +\fBCMAP_VALUETYPE_STRING\fR - C-style string > +.PP > +\fBCMAP_VALUETYPE_BINARY\fR - Binary data, byte with zero value has no special meaning > + > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful. If value or key_name are unspecified, CS_ERR_INVALID_PARAM > +is returned. Too short or too long key_name returns CS_ERR_NAME_TOO_LONG error code. Some of keys may > +be tagged read-only directly in corosync and seting such key will result in CS_ERR_ACCESS error. > + > +.SH "SEE ALSO" > +.BR cmap_get (3), > +.BR cmap_initialize (3), > +.BR cmap_overview (8) > diff --git a/man/cmap_track_add.3 b/man/cmap_track_add.3 > deleted file mode 100644 > index 07a6581..0000000 > --- a/man/cmap_track_add.3 > +++ /dev/null > @@ -1,164 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "CMAP_TRACK_ADD" 3 "06/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -cmap_track_add \- Set tracking function for values in CMAP > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/cmap.h>\fR > - > -.P > -\fBcs_error_t > -cmap_track_add (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int32_t \fItrack_type\fB, > -cmap_notify_fn_t \fInotify_fn\fB, void *\fIuser_data\fB, cmap_track_handle_t *\fIcmap_track_handle\fB);\fR > - > -.SH DESCRIPTION > -.P > -The > -.B cmap_track_add > -function is used to set function which tracks changes in CMAP. One CMAP connection can > -track multiple keys and also it's possible to track one key multiple times. The > -.I handle > -argument is connection to CMAP database obtained by calling > -.B cmap_initialize(3) > -function. > -.I key_name > -argument is ether exact key name or prefix of key name to track changes on. > -.I track_type > -is bitfield which may consist of following values: > -.PP > -\fBCMAP_TRACK_ADD\fR - track addition of new key (or key added in callback) > -.PP > -\fBCMAP_TRACK_DELETE\fR - track deletion of key (or key deleted in callback) > -.PP > -\fBCMAP_TRACK_MODIFY\fR - track modification of key (or key modified in callback) > -.PP > -\fBCMAP_TRACK_PREFIX\fR - whole prefix is tracked, instead of key only, so "totem." tracking means > -that "totem.nodeid", "totem.version", ... applies (this value is never returned > -in callback) > -.PP > -.I notify_fn > -is pointer to function which is called when value is changed. It's definition and meaning of parameters > -is discussed bellow. > -.I user_data > -argument is passed directly to > -.I notify_fn > -without any changes. > -.I cmap_track_handle > -is used for removing of tracking when no longer needed by calling > -.B cmap_track_delete(3) > -function. > - > -Callback function is defined as: > -.IP > -.RS > -.ne 18 > -.nf > -.PP > -typedef void (*cmap_notify_fn_t) ( > - cmap_handle_t cmap_handle, > - cmap_track_handle_t cmap_track_handle, > - int32_t event, > - const char *key_name, > - struct cmap_notify_value new_value, > - struct cmap_notify_value old_value, > - void *user_data); > -.ta > -.fi > -.RE > -.IP > -.PP > -where > -.I cmap_handle > -is handle used in registration of track function. > -.I cmap_track_handle > -is handle returned by > -.B cmap_track_add > -function. > -.I event > -is one of \fBCMAP_TRACK_ADD\fR, \fBCMAP_TRACK_DELETE\fR or \fBCMAP_TRACK_MODIFY\fR. > -.I key_name > -is name of changed key. > -.I new_value > -is new value of key, or unset if > -.I event > -is \fBCMAP_TRACK_DELETE\fR. > -.I old_value > -is previous value of key or unset if > -.I event > -is \fBCMAP_TRACK_ADD\fR or for some special keys set directly by Corosync due to speed optimalizations. > -Both > -.I new_value > -and > -.I old_value > -are structures defined as: > -.IP > -.RS > -.ne 18 > -.nf > -.PP > -struct cmap_notify_value { > - cmap_value_types_t type; > - size_t len; > - const void *data; > -}; > -.ta > -.fi > -.RE > -.IP > -.PP > -If value is unset, all fields are set to 0. Otherwise > -.I type > -is one of cmap types (as described in > -.B cmap_get(3) > -function), > -.I len > -is length of value in cmap and > -.I data > -is pointer to value of item. Data storage is dynamically alocated by caller and notify function must not try to > -free it. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful. It can return CS_ERR_INVALID_PARAM if > -notify_fn is NULL or track_type is invalid value. > - > -.SH "SEE ALSO" > -.BR cmap_track_delete (3), > -.BR cmap_initialize (3), > -.BR cmap_get (3), > -.BR cmap_dispatch (3), > -.BR cmap_overview (8) > diff --git a/man/cmap_track_add.3.in b/man/cmap_track_add.3.in > new file mode 100644 > index 0000000..07a6581 > --- /dev/null > +++ b/man/cmap_track_add.3.in > @@ -0,0 +1,164 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "CMAP_TRACK_ADD" 3 "06/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +cmap_track_add \- Set tracking function for values in CMAP > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/cmap.h>\fR > + > +.P > +\fBcs_error_t > +cmap_track_add (cmap_handle_t \fIhandle\fB, const char *\fIkey_name\fB, int32_t \fItrack_type\fB, > +cmap_notify_fn_t \fInotify_fn\fB, void *\fIuser_data\fB, cmap_track_handle_t *\fIcmap_track_handle\fB);\fR > + > +.SH DESCRIPTION > +.P > +The > +.B cmap_track_add > +function is used to set function which tracks changes in CMAP. One CMAP connection can > +track multiple keys and also it's possible to track one key multiple times. The > +.I handle > +argument is connection to CMAP database obtained by calling > +.B cmap_initialize(3) > +function. > +.I key_name > +argument is ether exact key name or prefix of key name to track changes on. > +.I track_type > +is bitfield which may consist of following values: > +.PP > +\fBCMAP_TRACK_ADD\fR - track addition of new key (or key added in callback) > +.PP > +\fBCMAP_TRACK_DELETE\fR - track deletion of key (or key deleted in callback) > +.PP > +\fBCMAP_TRACK_MODIFY\fR - track modification of key (or key modified in callback) > +.PP > +\fBCMAP_TRACK_PREFIX\fR - whole prefix is tracked, instead of key only, so "totem." tracking means > +that "totem.nodeid", "totem.version", ... applies (this value is never returned > +in callback) > +.PP > +.I notify_fn > +is pointer to function which is called when value is changed. It's definition and meaning of parameters > +is discussed bellow. > +.I user_data > +argument is passed directly to > +.I notify_fn > +without any changes. > +.I cmap_track_handle > +is used for removing of tracking when no longer needed by calling > +.B cmap_track_delete(3) > +function. > + > +Callback function is defined as: > +.IP > +.RS > +.ne 18 > +.nf > +.PP > +typedef void (*cmap_notify_fn_t) ( > + cmap_handle_t cmap_handle, > + cmap_track_handle_t cmap_track_handle, > + int32_t event, > + const char *key_name, > + struct cmap_notify_value new_value, > + struct cmap_notify_value old_value, > + void *user_data); > +.ta > +.fi > +.RE > +.IP > +.PP > +where > +.I cmap_handle > +is handle used in registration of track function. > +.I cmap_track_handle > +is handle returned by > +.B cmap_track_add > +function. > +.I event > +is one of \fBCMAP_TRACK_ADD\fR, \fBCMAP_TRACK_DELETE\fR or \fBCMAP_TRACK_MODIFY\fR. > +.I key_name > +is name of changed key. > +.I new_value > +is new value of key, or unset if > +.I event > +is \fBCMAP_TRACK_DELETE\fR. > +.I old_value > +is previous value of key or unset if > +.I event > +is \fBCMAP_TRACK_ADD\fR or for some special keys set directly by Corosync due to speed optimalizations. > +Both > +.I new_value > +and > +.I old_value > +are structures defined as: > +.IP > +.RS > +.ne 18 > +.nf > +.PP > +struct cmap_notify_value { > + cmap_value_types_t type; > + size_t len; > + const void *data; > +}; > +.ta > +.fi > +.RE > +.IP > +.PP > +If value is unset, all fields are set to 0. Otherwise > +.I type > +is one of cmap types (as described in > +.B cmap_get(3) > +function), > +.I len > +is length of value in cmap and > +.I data > +is pointer to value of item. Data storage is dynamically alocated by caller and notify function must not try to > +free it. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful. It can return CS_ERR_INVALID_PARAM if > +notify_fn is NULL or track_type is invalid value. > + > +.SH "SEE ALSO" > +.BR cmap_track_delete (3), > +.BR cmap_initialize (3), > +.BR cmap_get (3), > +.BR cmap_dispatch (3), > +.BR cmap_overview (8) > diff --git a/man/cmap_track_delete.3 b/man/cmap_track_delete.3 > deleted file mode 100644 > index 6c28530..0000000 > --- a/man/cmap_track_delete.3 > +++ /dev/null > @@ -1,70 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "CMAP_TRACK_DELETE" 3 "06/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -cmap_track_delete \- Remove tracking of values in CMAP > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/cmap.h>\fR > - > -.P > -\fBcs_error_t > -cmap_track_delete (cmap_handle_t \fIhandle\fB, cmap_track_handle_t \fItrack_handle\fB);\fR > - > -.SH DESCRIPTION > -.P > -The > -.B cmap_track_delte > -function is used to remove tracking of values changed in CMAP. > -The > -.I handle > -argument is connection to CMAP database obtained by calling > -.B cmap_initialize(3) > -function. > -.I track_handle > -argument is iterator handle obtained by > -.B cmap_track_add(3) > -function. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful. CS_ERR_BAD_HANDLE error is returned when track_handle > -is invalid. > - > -.SH "SEE ALSO" > -.BR cmap_track_add (3), > -.BR cmap_initialize (3), > -.BR cmap_overview (8) > diff --git a/man/cmap_track_delete.3.in b/man/cmap_track_delete.3.in > new file mode 100644 > index 0000000..6c28530 > --- /dev/null > +++ b/man/cmap_track_delete.3.in > @@ -0,0 +1,70 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "CMAP_TRACK_DELETE" 3 "06/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +cmap_track_delete \- Remove tracking of values in CMAP > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/cmap.h>\fR > + > +.P > +\fBcs_error_t > +cmap_track_delete (cmap_handle_t \fIhandle\fB, cmap_track_handle_t \fItrack_handle\fB);\fR > + > +.SH DESCRIPTION > +.P > +The > +.B cmap_track_delte > +function is used to remove tracking of values changed in CMAP. > +The > +.I handle > +argument is connection to CMAP database obtained by calling > +.B cmap_initialize(3) > +function. > +.I track_handle > +argument is iterator handle obtained by > +.B cmap_track_add(3) > +function. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful. CS_ERR_BAD_HANDLE error is returned when track_handle > +is invalid. > + > +.SH "SEE ALSO" > +.BR cmap_track_add (3), > +.BR cmap_initialize (3), > +.BR cmap_overview (8) > diff --git a/man/cpg_context_get.3 b/man/cpg_context_get.3 > deleted file mode 100644 > index b9d5fde..0000000 > --- a/man/cpg_context_get.3 > +++ /dev/null > @@ -1,68 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2007 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH CPG_CONTEXT_GET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -cpg_context_get \- Gets the context variable for a CPG instance > -.SH SYNOPSIS > -.B #include <corosync/cpg.h> > -.sp > -.BI "int cpg_context_get(cpg_handle_t " handle ", void **" context "); > -.SH DESCRIPTION > -The > -.B cpg_context_get > -function is used to retrieve the context variable previously stored using > -.B cpg_context_set(3) > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR cpg_overview (8), > -.BR cpg_initialize (3), > -.BR cpg_finalize (3), > -.BR cpg_fd_get (3), > -.BR cpg_dispatch (3), > -.BR cpg_join (3), > -.BR cpg_leave (3), > -.BR cpg_mcast_joined (3), > -.BR cpg_membership_get (3) > -.BR cpg_zcb_alloc (3) > -.BR cpg_zcb_free (3) > -.BR cpg_zcb_mcast_joined (3) > -.BR cpg_context_get (3) > -.BR cpg_context_set (3) > -.BR cpg_local_get (3) > - > -.PP > diff --git a/man/cpg_context_get.3.in b/man/cpg_context_get.3.in > new file mode 100644 > index 0000000..b9d5fde > --- /dev/null > +++ b/man/cpg_context_get.3.in > @@ -0,0 +1,68 @@ > +.\"/* > +.\" * Copyright (c) 2007 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH CPG_CONTEXT_GET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +cpg_context_get \- Gets the context variable for a CPG instance > +.SH SYNOPSIS > +.B #include <corosync/cpg.h> > +.sp > +.BI "int cpg_context_get(cpg_handle_t " handle ", void **" context "); > +.SH DESCRIPTION > +The > +.B cpg_context_get > +function is used to retrieve the context variable previously stored using > +.B cpg_context_set(3) > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR cpg_overview (8), > +.BR cpg_initialize (3), > +.BR cpg_finalize (3), > +.BR cpg_fd_get (3), > +.BR cpg_dispatch (3), > +.BR cpg_join (3), > +.BR cpg_leave (3), > +.BR cpg_mcast_joined (3), > +.BR cpg_membership_get (3) > +.BR cpg_zcb_alloc (3) > +.BR cpg_zcb_free (3) > +.BR cpg_zcb_mcast_joined (3) > +.BR cpg_context_get (3) > +.BR cpg_context_set (3) > +.BR cpg_local_get (3) > + > +.PP > diff --git a/man/cpg_context_set.3 b/man/cpg_context_set.3 > deleted file mode 100644 > index 87d18de..0000000 > --- a/man/cpg_context_set.3 > +++ /dev/null > @@ -1,69 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2007 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH CPG_CONTEXT_SET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -cpg_context_set \- Sets the context variable for a CPG instance > -.SH SYNOPSIS > -.B #include <corosync/cpg.h> > -.sp > -.BI "int cpg_context_set(cpg_handle_t " handle ", void *" context "); > -.SH DESCRIPTION > -The > -.B cpg_context_set > -function is used to set the context variable for a cpg instance. It has no > -meaning inside libcpg itself and will not be touched by the library. It can > -be retrieved using > -.B cpg_context_get(3) > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR cpg_overview (8), > -.BR cpg_initialize (3), > -.BR cpg_finalize (3), > -.BR cpg_fd_get (3), > -.BR cpg_dispatch (3), > -.BR cpg_join (3), > -.BR cpg_leave (3), > -.BR cpg_mcast_joined (3), > -.BR cpg_membership_get (3) > -.BR cpg_zcb_alloc (3) > -.BR cpg_zcb_free (3) > -.BR cpg_zcb_mcast_joined (3) > -.BR cpg_context_get (3) > -.BR cpg_context_set (3) > -.BR cpg_local_get (3) > -.PP > diff --git a/man/cpg_context_set.3.in b/man/cpg_context_set.3.in > new file mode 100644 > index 0000000..87d18de > --- /dev/null > +++ b/man/cpg_context_set.3.in > @@ -0,0 +1,69 @@ > +.\"/* > +.\" * Copyright (c) 2007 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH CPG_CONTEXT_SET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +cpg_context_set \- Sets the context variable for a CPG instance > +.SH SYNOPSIS > +.B #include <corosync/cpg.h> > +.sp > +.BI "int cpg_context_set(cpg_handle_t " handle ", void *" context "); > +.SH DESCRIPTION > +The > +.B cpg_context_set > +function is used to set the context variable for a cpg instance. It has no > +meaning inside libcpg itself and will not be touched by the library. It can > +be retrieved using > +.B cpg_context_get(3) > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR cpg_overview (8), > +.BR cpg_initialize (3), > +.BR cpg_finalize (3), > +.BR cpg_fd_get (3), > +.BR cpg_dispatch (3), > +.BR cpg_join (3), > +.BR cpg_leave (3), > +.BR cpg_mcast_joined (3), > +.BR cpg_membership_get (3) > +.BR cpg_zcb_alloc (3) > +.BR cpg_zcb_free (3) > +.BR cpg_zcb_mcast_joined (3) > +.BR cpg_context_get (3) > +.BR cpg_context_set (3) > +.BR cpg_local_get (3) > +.PP > diff --git a/man/cpg_dispatch.3 b/man/cpg_dispatch.3 > deleted file mode 100644 > index f824a3f..0000000 > --- a/man/cpg_dispatch.3 > +++ /dev/null > @@ -1,111 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2006 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH CPG_DISPATCH 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -cpg_dispatch \- Dispatches callbacks from the CPG service > -.SH SYNOPSIS > -.B #include <corosync/cpg.h> > -.sp > -.BI "int cpg_dispatch(cpg_handle_t " handle ", cpg_dispatch_t *" dispatch_types "); > -.SH DESCRIPTION > -The > -.B cpg_dispatch > -function is used to dispatch configuration changes or messages from the > -closed process groups API. > -.PP > -Each application may have several connections to the CPG API. Each application > -uses the > -.I handle > -argument to uniquely identify the connection. > -.PP > -The > -.I dispatch_types > -argument is used to identify the type of dispatch to execute. The possible types are > -defined by the structure: > - > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 30n 33n > -typedef enum { > - CS_DISPATCH_ONE, > - CS_DISPATCH_ALL, > - CS_DISPATCH_BLOCKING > -} cpg_dispatch_t; > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The dispatch values have the following meanings: > -.TP > -.B CS_DISPATCH_ONE > -Dispatch atleast one callback, blocking until the callback is dispatched. > -.TP > -.B CS_DISPATCH_ALL > -Dispatch all waiting callbacks without blocking to wait for any callbacks. > -.TP > -.B CS_DISPATCH_BLOCKING > -Dispatch all callbacks, blocking indefinitely. This is used in a threaded > -program where a thread is created, and then cpg_dispatch() is called immediately > -from the created thread to execute callbacks. > -.TP > -.B CS_DISPATCH_ONE_NONBLOCKING > -Dispatch at most one callback. If there is no pending callback, > -CS_ERR_TRY_AGAIN is returned. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR cpg_overview (8), > -.BR cpg_initialize (3), > -.BR cpg_finalize (3), > -.BR cpg_fd_get (3), > -.BR cpg_dispatch (3), > -.BR cpg_join (3), > -.BR cpg_leave (3), > -.BR cpg_mcast_joined (3), > -.BR cpg_membership_get (3) > -.BR cpg_zcb_alloc (3) > -.BR cpg_zcb_free (3) > -.BR cpg_zcb_mcast_joined (3) > -.BR cpg_context_get (3) > -.BR cpg_context_set (3) > -.BR cpg_local_get (3) > -.PP > diff --git a/man/cpg_dispatch.3.in b/man/cpg_dispatch.3.in > new file mode 100644 > index 0000000..f824a3f > --- /dev/null > +++ b/man/cpg_dispatch.3.in > @@ -0,0 +1,111 @@ > +.\"/* > +.\" * Copyright (c) 2006 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH CPG_DISPATCH 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +cpg_dispatch \- Dispatches callbacks from the CPG service > +.SH SYNOPSIS > +.B #include <corosync/cpg.h> > +.sp > +.BI "int cpg_dispatch(cpg_handle_t " handle ", cpg_dispatch_t *" dispatch_types "); > +.SH DESCRIPTION > +The > +.B cpg_dispatch > +function is used to dispatch configuration changes or messages from the > +closed process groups API. > +.PP > +Each application may have several connections to the CPG API. Each application > +uses the > +.I handle > +argument to uniquely identify the connection. > +.PP > +The > +.I dispatch_types > +argument is used to identify the type of dispatch to execute. The possible types are > +defined by the structure: > + > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 30n 33n > +typedef enum { > + CS_DISPATCH_ONE, > + CS_DISPATCH_ALL, > + CS_DISPATCH_BLOCKING > +} cpg_dispatch_t; > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The dispatch values have the following meanings: > +.TP > +.B CS_DISPATCH_ONE > +Dispatch atleast one callback, blocking until the callback is dispatched. > +.TP > +.B CS_DISPATCH_ALL > +Dispatch all waiting callbacks without blocking to wait for any callbacks. > +.TP > +.B CS_DISPATCH_BLOCKING > +Dispatch all callbacks, blocking indefinitely. This is used in a threaded > +program where a thread is created, and then cpg_dispatch() is called immediately > +from the created thread to execute callbacks. > +.TP > +.B CS_DISPATCH_ONE_NONBLOCKING > +Dispatch at most one callback. If there is no pending callback, > +CS_ERR_TRY_AGAIN is returned. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR cpg_overview (8), > +.BR cpg_initialize (3), > +.BR cpg_finalize (3), > +.BR cpg_fd_get (3), > +.BR cpg_dispatch (3), > +.BR cpg_join (3), > +.BR cpg_leave (3), > +.BR cpg_mcast_joined (3), > +.BR cpg_membership_get (3) > +.BR cpg_zcb_alloc (3) > +.BR cpg_zcb_free (3) > +.BR cpg_zcb_mcast_joined (3) > +.BR cpg_context_get (3) > +.BR cpg_context_set (3) > +.BR cpg_local_get (3) > +.PP > diff --git a/man/cpg_fd_get.3 b/man/cpg_fd_get.3 > deleted file mode 100644 > index 33d9af6..0000000 > --- a/man/cpg_fd_get.3 > +++ /dev/null > @@ -1,75 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2006 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH CPG_FD_GET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -cpg_fd_get \- Dispatches callbacks from the CPG service > -.SH SYNOPSIS > -.B #include <corosync/cpg.h> > -.sp > -.BI "int cpg_fd_get(cpg_handle_t " handle ", int *" fd "); > -.SH DESCRIPTION > -The > -.B cpg_fd_get > -function is used to retrieve the file descriptor that may be used with the poll > -system call to determine when > -.B cpg_dispatch(3) > -won't block. The > -.I handle > -argument may not be used directly with > -.B poll > -because it is not the file descriptor, but instead an internal identifier used > -by the CPG library. > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR cpg_overview (8), > -.BR cpg_initialize (3), > -.BR cpg_finalize (3), > -.BR cpg_fd_get (3), > -.BR cpg_dispatch (3), > -.BR cpg_join (3), > -.BR cpg_leave (3), > -.BR cpg_mcast_joined (3), > -.BR cpg_membership_get (3) > -.BR cpg_zcb_alloc (3) > -.BR cpg_zcb_free (3) > -.BR cpg_zcb_mcast_joined (3) > -.BR cpg_context_get (3) > -.BR cpg_context_set (3) > -.BR cpg_local_get (3) > - > -.PP > diff --git a/man/cpg_fd_get.3.in b/man/cpg_fd_get.3.in > new file mode 100644 > index 0000000..33d9af6 > --- /dev/null > +++ b/man/cpg_fd_get.3.in > @@ -0,0 +1,75 @@ > +.\"/* > +.\" * Copyright (c) 2006 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH CPG_FD_GET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +cpg_fd_get \- Dispatches callbacks from the CPG service > +.SH SYNOPSIS > +.B #include <corosync/cpg.h> > +.sp > +.BI "int cpg_fd_get(cpg_handle_t " handle ", int *" fd "); > +.SH DESCRIPTION > +The > +.B cpg_fd_get > +function is used to retrieve the file descriptor that may be used with the poll > +system call to determine when > +.B cpg_dispatch(3) > +won't block. The > +.I handle > +argument may not be used directly with > +.B poll > +because it is not the file descriptor, but instead an internal identifier used > +by the CPG library. > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR cpg_overview (8), > +.BR cpg_initialize (3), > +.BR cpg_finalize (3), > +.BR cpg_fd_get (3), > +.BR cpg_dispatch (3), > +.BR cpg_join (3), > +.BR cpg_leave (3), > +.BR cpg_mcast_joined (3), > +.BR cpg_membership_get (3) > +.BR cpg_zcb_alloc (3) > +.BR cpg_zcb_free (3) > +.BR cpg_zcb_mcast_joined (3) > +.BR cpg_context_get (3) > +.BR cpg_context_set (3) > +.BR cpg_local_get (3) > + > +.PP > diff --git a/man/cpg_finalize.3 b/man/cpg_finalize.3 > deleted file mode 100644 > index cc1382c..0000000 > --- a/man/cpg_finalize.3 > +++ /dev/null > @@ -1,71 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2006 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH CPG_FINALIZE 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -cpg_finalize \- Terminate a connection to the CPG service > -.SH SYNOPSIS > -.B #include <corosync/cpg.h> > -.sp > -.BI "int cpg_finalize(cpg_handle_t " handle "); > -.SH DESCRIPTION > -The > -.B cpg_finalize > -function is used to close a connection to the closed process group API. > -Once the connection is finalized, the handle may not be used again by applications. > -No more callbacks will be dispatched from the > -.B cpg_dispatch function. > -.PP > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR cpg_overview (8), > -.BR cpg_initialize (3), > -.BR cpg_finalize (3), > -.BR cpg_fd_get (3), > -.BR cpg_dispatch (3), > -.BR cpg_join (3), > -.BR cpg_leave (3), > -.BR cpg_mcast_joined (3), > -.BR cpg_membership_get (3) > -.BR cpg_zcb_alloc (3) > -.BR cpg_zcb_free (3) > -.BR cpg_zcb_mcast_joined (3) > -.BR cpg_context_get (3) > -.BR cpg_context_set (3) > -.BR cpg_local_get (3) > - > -.PP > diff --git a/man/cpg_finalize.3.in b/man/cpg_finalize.3.in > new file mode 100644 > index 0000000..cc1382c > --- /dev/null > +++ b/man/cpg_finalize.3.in > @@ -0,0 +1,71 @@ > +.\"/* > +.\" * Copyright (c) 2006 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH CPG_FINALIZE 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +cpg_finalize \- Terminate a connection to the CPG service > +.SH SYNOPSIS > +.B #include <corosync/cpg.h> > +.sp > +.BI "int cpg_finalize(cpg_handle_t " handle "); > +.SH DESCRIPTION > +The > +.B cpg_finalize > +function is used to close a connection to the closed process group API. > +Once the connection is finalized, the handle may not be used again by applications. > +No more callbacks will be dispatched from the > +.B cpg_dispatch function. > +.PP > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR cpg_overview (8), > +.BR cpg_initialize (3), > +.BR cpg_finalize (3), > +.BR cpg_fd_get (3), > +.BR cpg_dispatch (3), > +.BR cpg_join (3), > +.BR cpg_leave (3), > +.BR cpg_mcast_joined (3), > +.BR cpg_membership_get (3) > +.BR cpg_zcb_alloc (3) > +.BR cpg_zcb_free (3) > +.BR cpg_zcb_mcast_joined (3) > +.BR cpg_context_get (3) > +.BR cpg_context_set (3) > +.BR cpg_local_get (3) > + > +.PP > diff --git a/man/cpg_initialize.3 b/man/cpg_initialize.3 > deleted file mode 100644 > index 5012986..0000000 > --- a/man/cpg_initialize.3 > +++ /dev/null > @@ -1,175 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2006-2009 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH CPG_INITIALIZE 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -cpg_initialize \- Create a new connection to the CPG service > -.SH SYNOPSIS > -.B #include <corosync/cpg.h> > -.sp > -.BI "int cpg_initialize(cpg_handle_t *" handle ", cpg_callbacks_t *" callbacks "); > -.SH DESCRIPTION > -The > -.B cpg_initialize > -function is used to initialize a connection to the closed process groups API. This function is deprecated > -and > -.B cpg_model_initialize > -should be used in newly written code. > -.PP > -Each application may have several connections to the CPG API. Each application > -uses the > -.I handle > -argument to uniquely identify the connection. The > -.I handle > -argument is then used in other function calls to identify the connection to be used > -for communication with the CPG service. > -.PP > -Every time an CPG event occurs within the joined group, one of the callbacks specified by the argument > -.I callbacks > -is called. The callback functions are described by the following type definitions: > -.PP > -.PP > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 20n 32n > - > -typedef void (*cpg_deliver_fn_t) ( > - cpg_handle_t handle, > - const struct cpg_name *group_name, > - uint32_t nodeid, > - uint32_t pid, > - const void *msg, > - size_t msg_len); > - > - > -typedef void (*cpg_confchg_fn_t) ( > - cpg_handle_t handle, > - const struct cpg_name *group_name, > - const struct cpg_address *member_list, size_t member_list_entries, > - const struct cpg_address *left_list, size_t left_list_entries, > - const struct cpg_address *joined_list, size_t joined_list_entries); > - > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The > -.I callbacks > -argument is of the type: > -.IP > -.RS > -.ne 18 > -.nf > -.PP > -typedef struct { > - cpg_deliver_fn_t cpg_deliver_fn; > - cpg_confchg_fn_t cpg_confchg_fn; > -} cpg_callbacks_t; > -.ta > -.fi > -.RE > -.IP > -.PP > -When a configuration change occurs or a message is to be delivered one of the callbacks > -is called from the > -.B cpg_dispatch() > -function. If a configuration change occurs, > -.I cpg_confchg_fn > -is called. If a delivery of a message occurs, > -.I cpg_deliver_fn > -is called. > - > -The > -.I cpg_address > -structure is defined > -.IP > -.RS > -.ne 18 > -.nf > -.PP > -struct cpg_address { > - unsigned int nodeid; > - unsigned int pid; > - unsigned int reason; > -}; > -.ta > -.fi > -.RE > -.IP > -.PP > -where nodeid is a 32 bit unique node identifier, pid is the process ID of the process that has joined/left the group > -or sent the message, and reason is an integer code indicating why the node joined/left the group. > -.PP > -.IP > -.RS > -.ne 18 > -.nf > -.PP > -CPG_REASON_JOIN - the process joined a group using cpg_join(). > -CPG_REASON_LEAVE - the process left a group using cpg_leave() > -CPG_REASON_NODEDOWN - the process left a group because the node left the cluster. > -CPG_REASON_NODEUP - the process joined a group because it was already a member of a group on a node that has just joined the cluster > -CPG_REASON_PROCDOWN - the process left a group without calling cpg_leave() > -.ta > -.fi > -.RE > -.IP > -.PP > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR cpg_overview (8), > -.BR cpg_initialize (3), > -.BR cpg_finalize (3), > -.BR cpg_fd_get (3), > -.BR cpg_dispatch (3), > -.BR cpg_join (3), > -.BR cpg_leave (3), > -.BR cpg_mcast_joined (3), > -.BR cpg_membership_get (3) > -.BR cpg_zcb_alloc (3) > -.BR cpg_zcb_free (3) > -.BR cpg_zcb_mcast_joined (3) > -.BR cpg_context_get (3) > -.BR cpg_context_set (3) > -.BR cpg_local_get (3) > -.BR cpg_model_initialize (3) > - > -.PP > diff --git a/man/cpg_initialize.3.in b/man/cpg_initialize.3.in > new file mode 100644 > index 0000000..5012986 > --- /dev/null > +++ b/man/cpg_initialize.3.in > @@ -0,0 +1,175 @@ > +.\"/* > +.\" * Copyright (c) 2006-2009 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH CPG_INITIALIZE 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +cpg_initialize \- Create a new connection to the CPG service > +.SH SYNOPSIS > +.B #include <corosync/cpg.h> > +.sp > +.BI "int cpg_initialize(cpg_handle_t *" handle ", cpg_callbacks_t *" callbacks "); > +.SH DESCRIPTION > +The > +.B cpg_initialize > +function is used to initialize a connection to the closed process groups API. This function is deprecated > +and > +.B cpg_model_initialize > +should be used in newly written code. > +.PP > +Each application may have several connections to the CPG API. Each application > +uses the > +.I handle > +argument to uniquely identify the connection. The > +.I handle > +argument is then used in other function calls to identify the connection to be used > +for communication with the CPG service. > +.PP > +Every time an CPG event occurs within the joined group, one of the callbacks specified by the argument > +.I callbacks > +is called. The callback functions are described by the following type definitions: > +.PP > +.PP > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 20n 32n > + > +typedef void (*cpg_deliver_fn_t) ( > + cpg_handle_t handle, > + const struct cpg_name *group_name, > + uint32_t nodeid, > + uint32_t pid, > + const void *msg, > + size_t msg_len); > + > + > +typedef void (*cpg_confchg_fn_t) ( > + cpg_handle_t handle, > + const struct cpg_name *group_name, > + const struct cpg_address *member_list, size_t member_list_entries, > + const struct cpg_address *left_list, size_t left_list_entries, > + const struct cpg_address *joined_list, size_t joined_list_entries); > + > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The > +.I callbacks > +argument is of the type: > +.IP > +.RS > +.ne 18 > +.nf > +.PP > +typedef struct { > + cpg_deliver_fn_t cpg_deliver_fn; > + cpg_confchg_fn_t cpg_confchg_fn; > +} cpg_callbacks_t; > +.ta > +.fi > +.RE > +.IP > +.PP > +When a configuration change occurs or a message is to be delivered one of the callbacks > +is called from the > +.B cpg_dispatch() > +function. If a configuration change occurs, > +.I cpg_confchg_fn > +is called. If a delivery of a message occurs, > +.I cpg_deliver_fn > +is called. > + > +The > +.I cpg_address > +structure is defined > +.IP > +.RS > +.ne 18 > +.nf > +.PP > +struct cpg_address { > + unsigned int nodeid; > + unsigned int pid; > + unsigned int reason; > +}; > +.ta > +.fi > +.RE > +.IP > +.PP > +where nodeid is a 32 bit unique node identifier, pid is the process ID of the process that has joined/left the group > +or sent the message, and reason is an integer code indicating why the node joined/left the group. > +.PP > +.IP > +.RS > +.ne 18 > +.nf > +.PP > +CPG_REASON_JOIN - the process joined a group using cpg_join(). > +CPG_REASON_LEAVE - the process left a group using cpg_leave() > +CPG_REASON_NODEDOWN - the process left a group because the node left the cluster. > +CPG_REASON_NODEUP - the process joined a group because it was already a member of a group on a node that has just joined the cluster > +CPG_REASON_PROCDOWN - the process left a group without calling cpg_leave() > +.ta > +.fi > +.RE > +.IP > +.PP > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR cpg_overview (8), > +.BR cpg_initialize (3), > +.BR cpg_finalize (3), > +.BR cpg_fd_get (3), > +.BR cpg_dispatch (3), > +.BR cpg_join (3), > +.BR cpg_leave (3), > +.BR cpg_mcast_joined (3), > +.BR cpg_membership_get (3) > +.BR cpg_zcb_alloc (3) > +.BR cpg_zcb_free (3) > +.BR cpg_zcb_mcast_joined (3) > +.BR cpg_context_get (3) > +.BR cpg_context_set (3) > +.BR cpg_local_get (3) > +.BR cpg_model_initialize (3) > + > +.PP > diff --git a/man/cpg_join.3 b/man/cpg_join.3 > deleted file mode 100644 > index f79b6f5..0000000 > --- a/man/cpg_join.3 > +++ /dev/null > @@ -1,112 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2006 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH CPG_JOIN 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -cpg_join \- Joins one or more groups in the CPG library > -.SH SYNOPSIS > -.B #include <corosync/cpg.h> > -.sp > -.BI "int cpg_join(cpg_handle_t " handle ", struct cpg_name *" group "); > -.SH DESCRIPTION > -The > -.B cpg_join > -function is used to join one group. When a group is joined, the > -.B cpg_mcast_joined(3) > -is called internally to multicast to the groups joined in the argument > -.I handle. > -The process will also get notifications of other processes joining > -and leaving the group. > -Messages that are sent to any of the groups joined to the parameter > -.I handle > -will be delivered by > -.B cpg_dispatch(3). > -.PP > -This function may be only be called once for each handle. When a group has been joined > -the process will start to receive callbacks relating to messages sent from members > -of the group or notifications of processes joining or leaving the group. > -.PP > -Note that more than one process on each node can join a CPG group and > -each will receive its own copy of any messages sent using > -.I cpg_mcast_joined() > -and its own confchg callback. > -.PP > - > -The argument > -.I group > -is used to specify the group to join. > - > - > -The > -.I groups > -argument is of the type struct cpg_name which is defined by the structure: > - > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 30n 33n > -struct cpg_name { > - int length; > - char value[128]; > -}; > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, CS_ERR_INVALID_PARAM if the > -handle is already joined to a group. > -.PP > -.SH ERRORS > -Not all errors are documented. > -.SH "SEE ALSO" > -.BR cpg_overview (8), > -.BR cpg_initialize (3), > -.BR cpg_finalize (3), > -.BR cpg_fd_get (3), > -.BR cpg_dispatch (3), > -.BR cpg_join (3), > -.BR cpg_leave (3), > -.BR cpg_mcast_joined (3), > -.BR cpg_membership_get (3) > -.BR cpg_zcb_alloc (3) > -.BR cpg_zcb_free (3) > -.BR cpg_zcb_mcast_joined (3) > -.BR cpg_context_get (3) > -.BR cpg_context_set (3) > -.BR cpg_local_get (3) > - > -.PP > diff --git a/man/cpg_join.3.in b/man/cpg_join.3.in > new file mode 100644 > index 0000000..f79b6f5 > --- /dev/null > +++ b/man/cpg_join.3.in > @@ -0,0 +1,112 @@ > +.\"/* > +.\" * Copyright (c) 2006 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH CPG_JOIN 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +cpg_join \- Joins one or more groups in the CPG library > +.SH SYNOPSIS > +.B #include <corosync/cpg.h> > +.sp > +.BI "int cpg_join(cpg_handle_t " handle ", struct cpg_name *" group "); > +.SH DESCRIPTION > +The > +.B cpg_join > +function is used to join one group. When a group is joined, the > +.B cpg_mcast_joined(3) > +is called internally to multicast to the groups joined in the argument > +.I handle. > +The process will also get notifications of other processes joining > +and leaving the group. > +Messages that are sent to any of the groups joined to the parameter > +.I handle > +will be delivered by > +.B cpg_dispatch(3). > +.PP > +This function may be only be called once for each handle. When a group has been joined > +the process will start to receive callbacks relating to messages sent from members > +of the group or notifications of processes joining or leaving the group. > +.PP > +Note that more than one process on each node can join a CPG group and > +each will receive its own copy of any messages sent using > +.I cpg_mcast_joined() > +and its own confchg callback. > +.PP > + > +The argument > +.I group > +is used to specify the group to join. > + > + > +The > +.I groups > +argument is of the type struct cpg_name which is defined by the structure: > + > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 30n 33n > +struct cpg_name { > + int length; > + char value[128]; > +}; > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, CS_ERR_INVALID_PARAM if the > +handle is already joined to a group. > +.PP > +.SH ERRORS > +Not all errors are documented. > +.SH "SEE ALSO" > +.BR cpg_overview (8), > +.BR cpg_initialize (3), > +.BR cpg_finalize (3), > +.BR cpg_fd_get (3), > +.BR cpg_dispatch (3), > +.BR cpg_join (3), > +.BR cpg_leave (3), > +.BR cpg_mcast_joined (3), > +.BR cpg_membership_get (3) > +.BR cpg_zcb_alloc (3) > +.BR cpg_zcb_free (3) > +.BR cpg_zcb_mcast_joined (3) > +.BR cpg_context_get (3) > +.BR cpg_context_set (3) > +.BR cpg_local_get (3) > + > +.PP > diff --git a/man/cpg_leave.3 b/man/cpg_leave.3 > deleted file mode 100644 > index c1cdb81..0000000 > --- a/man/cpg_leave.3 > +++ /dev/null > @@ -1,77 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2006 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH CPG_LEAVE 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -cpg_leave \- Leave a group in the CPG library > -.SH SYNOPSIS > -.B #include <corosync/cpg.h> > -.sp > -.BI "int cpg_leave(cpg_handle_t " handle ", struct cpg_name *" group "); > -.SH DESCRIPTION > -The > -.B cpg_leave > -function is used to leave a group. Once a group has been left the process will > -no longer receive messages or notifications about events in that group. > -Note that a process is only deemed to have left the group once it has been > -notified (by its confchg callback) that is has left. > -So expect to receive at least one confchg callback after calling this function. > - > -The argument > -.I group > -is used to specify the group to leave. It is currently ignored as only one group > -can be joined per handle. It is included here for to allow for future development. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR cpg_overview (8), > -.BR cpg_initialize (3), > -.BR cpg_finalize (3), > -.BR cpg_fd_get (3), > -.BR cpg_dispatch (3), > -.BR cpg_join (3), > -.BR cpg_leave (3), > -.BR cpg_mcast_joined (3), > -.BR cpg_membership_get (3) > -.BR cpg_zcb_alloc (3) > -.BR cpg_zcb_free (3) > -.BR cpg_zcb_mcast_joined (3) > -.BR cpg_context_get (3) > -.BR cpg_context_set (3) > -.BR cpg_local_get (3) > - > -.PP > diff --git a/man/cpg_leave.3.in b/man/cpg_leave.3.in > new file mode 100644 > index 0000000..c1cdb81 > --- /dev/null > +++ b/man/cpg_leave.3.in > @@ -0,0 +1,77 @@ > +.\"/* > +.\" * Copyright (c) 2006 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH CPG_LEAVE 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +cpg_leave \- Leave a group in the CPG library > +.SH SYNOPSIS > +.B #include <corosync/cpg.h> > +.sp > +.BI "int cpg_leave(cpg_handle_t " handle ", struct cpg_name *" group "); > +.SH DESCRIPTION > +The > +.B cpg_leave > +function is used to leave a group. Once a group has been left the process will > +no longer receive messages or notifications about events in that group. > +Note that a process is only deemed to have left the group once it has been > +notified (by its confchg callback) that is has left. > +So expect to receive at least one confchg callback after calling this function. > + > +The argument > +.I group > +is used to specify the group to leave. It is currently ignored as only one group > +can be joined per handle. It is included here for to allow for future development. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR cpg_overview (8), > +.BR cpg_initialize (3), > +.BR cpg_finalize (3), > +.BR cpg_fd_get (3), > +.BR cpg_dispatch (3), > +.BR cpg_join (3), > +.BR cpg_leave (3), > +.BR cpg_mcast_joined (3), > +.BR cpg_membership_get (3) > +.BR cpg_zcb_alloc (3) > +.BR cpg_zcb_free (3) > +.BR cpg_zcb_mcast_joined (3) > +.BR cpg_context_get (3) > +.BR cpg_context_set (3) > +.BR cpg_local_get (3) > + > +.PP > diff --git a/man/cpg_local_get.3 b/man/cpg_local_get.3 > deleted file mode 100644 > index 7d9cfb4..0000000 > --- a/man/cpg_local_get.3 > +++ /dev/null > @@ -1,72 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2007 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Steven Dake <sdake@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH CPG_LOCAL_GET 3 2007-06-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -cpg_local_get \- Returns the local node id > -.SH SYNOPSIS > -.B #include <corosync/cpg.h> > -.sp > -.BI "int cpg_local_get(cpg_handle_t " handle ", unsigned int *" local_nodeid "); > -.SH DESCRIPTION > -The > -.B cpg_local_get > -function is used to determine the local node's identifier. > -.BR > -The argument > -.I handle > -is used to reference the cpg instantiation. > -The argument > -.I local_nodeid > -will return the 32 bit node id. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR cpg_overview (8), > -.BR cpg_initialize (3), > -.BR cpg_finalize (3), > -.BR cpg_fd_get (3), > -.BR cpg_dispatch (3), > -.BR cpg_join (3), > -.BR cpg_leave (3), > -.BR cpg_mcast_joined (3), > -.BR cpg_membership_get (3) > -.BR cpg_zcb_alloc (3) > -.BR cpg_zcb_free (3) > -.BR cpg_zcb_mcast_joined (3) > -.BR cpg_context_get (3) > -.BR cpg_context_set (3) > -.BR cpg_local_get (3) > - > -.PP > diff --git a/man/cpg_local_get.3.in b/man/cpg_local_get.3.in > new file mode 100644 > index 0000000..7d9cfb4 > --- /dev/null > +++ b/man/cpg_local_get.3.in > @@ -0,0 +1,72 @@ > +.\"/* > +.\" * Copyright (c) 2007 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Steven Dake <sdake@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH CPG_LOCAL_GET 3 2007-06-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +cpg_local_get \- Returns the local node id > +.SH SYNOPSIS > +.B #include <corosync/cpg.h> > +.sp > +.BI "int cpg_local_get(cpg_handle_t " handle ", unsigned int *" local_nodeid "); > +.SH DESCRIPTION > +The > +.B cpg_local_get > +function is used to determine the local node's identifier. > +.BR > +The argument > +.I handle > +is used to reference the cpg instantiation. > +The argument > +.I local_nodeid > +will return the 32 bit node id. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR cpg_overview (8), > +.BR cpg_initialize (3), > +.BR cpg_finalize (3), > +.BR cpg_fd_get (3), > +.BR cpg_dispatch (3), > +.BR cpg_join (3), > +.BR cpg_leave (3), > +.BR cpg_mcast_joined (3), > +.BR cpg_membership_get (3) > +.BR cpg_zcb_alloc (3) > +.BR cpg_zcb_free (3) > +.BR cpg_zcb_mcast_joined (3) > +.BR cpg_context_get (3) > +.BR cpg_context_set (3) > +.BR cpg_local_get (3) > + > +.PP > diff --git a/man/cpg_mcast_joined.3 b/man/cpg_mcast_joined.3 > deleted file mode 100644 > index dc02350..0000000 > --- a/man/cpg_mcast_joined.3 > +++ /dev/null > @@ -1,141 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2006 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH CPG_MCAST_JOINED 3 3004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -cpg_mcast_joined \- Multicasts to all groups joined to a handle > -.SH SYNOPSIS > -.B #include <sys/uio.h> > -.B #include <corosync/cpg.h> > -.sp > -.BI "int cpg_mcast_joined(cpg_handle_t " handle ", cpg_guarantee_t " guarantee ", struct iovec *" iovec ", int " iov_len "); > -.SH DESCRIPTION > -The > -.B cpg_mcast_joined > -function will multicast a message to all the processes that have been joined with the > -.B cpg_join(3) > -function for the same group name. > -Messages that are sent to any of the groups joined to the parameter > -.I handle > -will be delivered to all subscribed processes in the system. > -.PP > -The argument > -.I guarantee > -requests a delivery guarantee for the message to be sent. The cpg_guarantee_t type is > -defined by: > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 30n 33n > -typedef enum { > - CPG_TYPE_UNORDERED, /* not implemented */ > - CPG_TYPE_FIFO, /* same as agreed */ > - CPG_TYPE_AGREED, /* implemented */ > - CPG_TYPE_SAFE /* not implemented */ > -} cpg_guarantee_t; > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The meanings of the cpg_guarantee_t typedef are: > -.TP > -.B CPG_TYPE_UNORDERED > -Messages are guaranteed to be delivered, but with no particular order. This > -mode is unimplemented in the CPG library. > -.TP > -.B CPG_TYPE_FIFO > -Messages are guaranteed to be delivered in first sent first delivery order. > -In fact, this guarantee is equivalent to the CPG_TYPE_AGREED guarantee. > -.TP > -.B CPG_TYPE_AGREED > -All processors must agree on the order of delivery. If a message is sent > -from two or more processes at about the same time, the delivery will occur > -in the same order to all processes. > -.TP > -.B CPG_TYPE_SAFE > -All processes must agree on the order of delivery. Further all processes > -must have a copy of the message before any delivery takes place. This mode is > -unimplemented in the CPG library. > -.PP > -The > -.I iovec > -argument describes the scatter/gather list which is used to transmit a message. This > -is a iovec described by: > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 30n 33n > -struct iovec > -{ > - void *iov_base; /* Pointer to data. */ > - unsigned int iov_len; /* Length of data. */ > -}; > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The > -.I iov_len > -argument describes the number of entires in the > -.I iovec > -argument. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR cpg_overview (8), > -.BR cpg_initialize (3), > -.BR cpg_finalize (3), > -.BR cpg_fd_get (3), > -.BR cpg_dispatch (3), > -.BR cpg_join (3), > -.BR cpg_leave (3), > -.BR cpg_mcast_joined (3), > -.BR cpg_membership_get (3) > -.BR cpg_zcb_alloc (3) > -.BR cpg_zcb_free (3) > -.BR cpg_zcb_mcast_joined (3) > -.BR cpg_context_get (3) > -.BR cpg_context_set (3) > -.BR cpg_local_get (3) > - > -.PP > diff --git a/man/cpg_mcast_joined.3.in b/man/cpg_mcast_joined.3.in > new file mode 100644 > index 0000000..dc02350 > --- /dev/null > +++ b/man/cpg_mcast_joined.3.in > @@ -0,0 +1,141 @@ > +.\"/* > +.\" * Copyright (c) 2006 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH CPG_MCAST_JOINED 3 3004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +cpg_mcast_joined \- Multicasts to all groups joined to a handle > +.SH SYNOPSIS > +.B #include <sys/uio.h> > +.B #include <corosync/cpg.h> > +.sp > +.BI "int cpg_mcast_joined(cpg_handle_t " handle ", cpg_guarantee_t " guarantee ", struct iovec *" iovec ", int " iov_len "); > +.SH DESCRIPTION > +The > +.B cpg_mcast_joined > +function will multicast a message to all the processes that have been joined with the > +.B cpg_join(3) > +function for the same group name. > +Messages that are sent to any of the groups joined to the parameter > +.I handle > +will be delivered to all subscribed processes in the system. > +.PP > +The argument > +.I guarantee > +requests a delivery guarantee for the message to be sent. The cpg_guarantee_t type is > +defined by: > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 30n 33n > +typedef enum { > + CPG_TYPE_UNORDERED, /* not implemented */ > + CPG_TYPE_FIFO, /* same as agreed */ > + CPG_TYPE_AGREED, /* implemented */ > + CPG_TYPE_SAFE /* not implemented */ > +} cpg_guarantee_t; > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The meanings of the cpg_guarantee_t typedef are: > +.TP > +.B CPG_TYPE_UNORDERED > +Messages are guaranteed to be delivered, but with no particular order. This > +mode is unimplemented in the CPG library. > +.TP > +.B CPG_TYPE_FIFO > +Messages are guaranteed to be delivered in first sent first delivery order. > +In fact, this guarantee is equivalent to the CPG_TYPE_AGREED guarantee. > +.TP > +.B CPG_TYPE_AGREED > +All processors must agree on the order of delivery. If a message is sent > +from two or more processes at about the same time, the delivery will occur > +in the same order to all processes. > +.TP > +.B CPG_TYPE_SAFE > +All processes must agree on the order of delivery. Further all processes > +must have a copy of the message before any delivery takes place. This mode is > +unimplemented in the CPG library. > +.PP > +The > +.I iovec > +argument describes the scatter/gather list which is used to transmit a message. This > +is a iovec described by: > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 30n 33n > +struct iovec > +{ > + void *iov_base; /* Pointer to data. */ > + unsigned int iov_len; /* Length of data. */ > +}; > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The > +.I iov_len > +argument describes the number of entires in the > +.I iovec > +argument. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR cpg_overview (8), > +.BR cpg_initialize (3), > +.BR cpg_finalize (3), > +.BR cpg_fd_get (3), > +.BR cpg_dispatch (3), > +.BR cpg_join (3), > +.BR cpg_leave (3), > +.BR cpg_mcast_joined (3), > +.BR cpg_membership_get (3) > +.BR cpg_zcb_alloc (3) > +.BR cpg_zcb_free (3) > +.BR cpg_zcb_mcast_joined (3) > +.BR cpg_context_get (3) > +.BR cpg_context_set (3) > +.BR cpg_local_get (3) > + > +.PP > diff --git a/man/cpg_membership_get.3 b/man/cpg_membership_get.3 > deleted file mode 100644 > index 62dfebf..0000000 > --- a/man/cpg_membership_get.3 > +++ /dev/null > @@ -1,81 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2006 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH CPG_MEMBERSHIP_GET 3 2006-02-06 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -cpg_membership_get \- Returns a list of members of a CPG group > -.SH SYNOPSIS > -.B #include <corosync/cpg.h> > -.sp > -.BI "int cpg_membership_get(cpg_handle_t " handle ", struct cpg_name *" groupName ", struct cpg_address *" member_list ", int *" member_list_entries "); > -.SH DESCRIPTION > -The > -.B cpg_membership_get > -function is used to determine the current processes in the configuration. You probably will not > -need to call this function much as one of the first confchg callbacks you will get will be from > -the cpg_join() function containing your process. > -.BR > -The argument > -.I handle > -is used to reference the cpg instantiation. > -The argument > -.I groupName > -will return the name of the group > -The argument > -.I member_list > -will return the list of processors in the current membership. > -The argument > -.I member_list_entries > -should be set with the size of member_list and will return the size of the > -member_list after return from the function. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR cpg_overview (8), > -.BR cpg_initialize (3), > -.BR cpg_finalize (3), > -.BR cpg_fd_get (3), > -.BR cpg_dispatch (3), > -.BR cpg_join (3), > -.BR cpg_leave (3), > -.BR cpg_mcast_joined (3), > -.BR cpg_membership_get (3) > -.BR cpg_zcb_alloc (3) > -.BR cpg_zcb_free (3) > -.BR cpg_zcb_mcast_joined (3) > -.BR cpg_context_get (3) > -.BR cpg_context_set (3) > -.BR cpg_local_get (3) > - > -.PP > diff --git a/man/cpg_membership_get.3.in b/man/cpg_membership_get.3.in > new file mode 100644 > index 0000000..62dfebf > --- /dev/null > +++ b/man/cpg_membership_get.3.in > @@ -0,0 +1,81 @@ > +.\"/* > +.\" * Copyright (c) 2006 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH CPG_MEMBERSHIP_GET 3 2006-02-06 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +cpg_membership_get \- Returns a list of members of a CPG group > +.SH SYNOPSIS > +.B #include <corosync/cpg.h> > +.sp > +.BI "int cpg_membership_get(cpg_handle_t " handle ", struct cpg_name *" groupName ", struct cpg_address *" member_list ", int *" member_list_entries "); > +.SH DESCRIPTION > +The > +.B cpg_membership_get > +function is used to determine the current processes in the configuration. You probably will not > +need to call this function much as one of the first confchg callbacks you will get will be from > +the cpg_join() function containing your process. > +.BR > +The argument > +.I handle > +is used to reference the cpg instantiation. > +The argument > +.I groupName > +will return the name of the group > +The argument > +.I member_list > +will return the list of processors in the current membership. > +The argument > +.I member_list_entries > +should be set with the size of member_list and will return the size of the > +member_list after return from the function. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR cpg_overview (8), > +.BR cpg_initialize (3), > +.BR cpg_finalize (3), > +.BR cpg_fd_get (3), > +.BR cpg_dispatch (3), > +.BR cpg_join (3), > +.BR cpg_leave (3), > +.BR cpg_mcast_joined (3), > +.BR cpg_membership_get (3) > +.BR cpg_zcb_alloc (3) > +.BR cpg_zcb_free (3) > +.BR cpg_zcb_mcast_joined (3) > +.BR cpg_context_get (3) > +.BR cpg_context_set (3) > +.BR cpg_local_get (3) > + > +.PP > diff --git a/man/cpg_model_initialize.3 b/man/cpg_model_initialize.3 > deleted file mode 100644 > index 259f77d..0000000 > --- a/man/cpg_model_initialize.3 > +++ /dev/null > @@ -1,231 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2010 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse <jfriesse@xxxxxxxxxx> > -.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH CPG_MODEL_INITIALIZE 3 2010-04-07 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -cpg_model_initialize \- Create a new connection to the CPG service > -.SH SYNOPSIS > -.B #include <corosync/cpg.h> > -.sp > -.BI "cs_error_t cpg_model_initialize(cpg_handle_t *" handle ", cpg_model_t " model ", cpg_model_data_t *" model_data ", void *" context "); > - > -.SH DESCRIPTION > -The > -.B cpg_model_initialize > -function is used to initialize a connection to the closed process groups API. > -.PP > -Each application may have several connections to the CPG API. Each application > -uses the > -.I handle > -argument to uniquely identify the connection. The > -.I handle > -argument is then used in other function calls to identify the connection to be used > -for communication with the CPG service. > -.PP > -Argument > -.I model > -is used to explicitly choose set of callbacks and internal parameters. Currently only model > -.I CPG_MODEL_V1 > -is defined. > -.PP > -Callbacks and internal parameters are passed by > -.I model_data > -argument. This is casted pointer (idea is similar as in sockaddr function) to one of structures > -corresponding to chosen model. Currently only > -.I cpg_model_v1_data_t > -is needed. > -.SH MODEL_V1 > -The > -.I MODEL_V1 > -is backwards compatible with original callbacks initialized by > -.I cpg_initialize > -but new callback > -.I cpg_totem_confchg_fn > -is defined. > -.PP > -Every time an CPG event occurs within the joined group, one of the callbacks specified by the argument > -.I callbacks > -is called. The callback functions are described by the following type definitions: > -.PP > -.PP > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 20n 32n > - > -typedef void (*cpg_deliver_fn_t) ( > - cpg_handle_t handle, > - const struct cpg_name *group_name, > - uint32_t nodeid, > - uint32_t pid, > - const void *msg, > - size_t msg_len); > - > - > -typedef void (*cpg_confchg_fn_t) ( > - cpg_handle_t handle, > - const struct cpg_name *group_name, > - const struct cpg_address *member_list, size_t member_list_entries, > - const struct cpg_address *left_list, size_t left_list_entries, > - const struct cpg_address *joined_list, size_t joined_list_entries); > - > - > -typedef void (*cpg_totem_confchg_fn_t) ( > - cpg_handle_t handle, > - struct cpg_ring_id ring_id, > - uint32_t member_list_entries, > - const uint32_t *member_list); > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The > -.I cpg_model_v1_data_t > -structure is defined as: > -.IP > -.RS > -.ne 18 > -.nf > -.PP > -typedef struct { > - cpg_model_t model; > - cpg_deliver_fn_t cpg_deliver_fn; > - cpg_confchg_fn_t cpg_confchg_fn; > - cpg_totem_confchg_fn_t cpg_totem_confchg_fn; > - unsigned int flags; > -} cpg_model_v1_data_t; > -.ta > -.fi > -.RE > -.IP > -.PP > -When a configuration change occurs or a message is to be delivered one of the callbacks > -is called from the > -.B cpg_dispatch() > -function. If a configuration change occurs, > -.I cpg_confchg_fn > -is called. If a delivery of a message occurs, > -.I cpg_deliver_fn > -is called. > -When totem membership change occurs, > -.I cpg_totem_confchg_fn > -is called. You can OR > -.I CPG_MODEL_V1_DELIVER_INITIAL_TOTEM_CONF > -constant to flags to get callback after first confchg event. > - > -The > -.I cpg_address > -structure is defined > -.IP > -.RS > -.ne 18 > -.nf > -.PP > -struct cpg_address { > - unsigned int nodeid; > - unsigned int pid; > - unsigned int reason; > -}; > -.ta > -.fi > -.RE > -.IP > -.PP > -where nodeid is a 32 bit unique node identifier, pid is the process ID of the process that has joined/left the group > -or sent the message, and reason is an integer code indicating why the node joined/left the group. > -.PP > -.IP > -.RS > -.ne 18 > -.nf > -.PP > -CPG_REASON_JOIN - the process joined a group using cpg_join(). > -CPG_REASON_LEAVE - the process left a group using cpg_leave() > -CPG_REASON_NODEDOWN - the process left a group because the node left the cluster. > -CPG_REASON_NODEUP - the process joined a group because it was already a member of a group on a node that has just joined the cluster > -CPG_REASON_PROCDOWN - the process left a group without calling cpg_leave() > -.ta > -.fi > -.RE > -.IP > -.PP > -The > -.I cpg_ring_id > -structure is defined > -.IP > -.RS > -.ne 18 > -.nf > -.PP > -struct cpg_ring_id { > - uint32_t nodeid; > - uint64_t seq; > -}; > -.ta > -.fi > -.RE > -.IP > -.PP > -where > -.I nodeid > -is if of node of current Totem leader and seq is increasing number. > - > -.PP > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR cpg_overview (8), > -.BR cpg_initialize (3), > -.BR cpg_finalize (3), > -.BR cpg_fd_get (3), > -.BR cpg_dispatch (3), > -.BR cpg_join (3), > -.BR cpg_leave (3), > -.BR cpg_mcast_joined (3), > -.BR cpg_membership_get (3) > -.BR cpg_zcb_alloc (3) > -.BR cpg_zcb_free (3) > -.BR cpg_zcb_mcast_joined (3) > -.BR cpg_context_get (3) > -.BR cpg_context_set (3) > -.BR cpg_local_get (3) > -.BR cpg_model_initialize (3) > - > -.PP > diff --git a/man/cpg_model_initialize.3.in b/man/cpg_model_initialize.3.in > new file mode 100644 > index 0000000..259f77d > --- /dev/null > +++ b/man/cpg_model_initialize.3.in > @@ -0,0 +1,231 @@ > +.\"/* > +.\" * Copyright (c) 2010 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse <jfriesse@xxxxxxxxxx> > +.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH CPG_MODEL_INITIALIZE 3 2010-04-07 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +cpg_model_initialize \- Create a new connection to the CPG service > +.SH SYNOPSIS > +.B #include <corosync/cpg.h> > +.sp > +.BI "cs_error_t cpg_model_initialize(cpg_handle_t *" handle ", cpg_model_t " model ", cpg_model_data_t *" model_data ", void *" context "); > + > +.SH DESCRIPTION > +The > +.B cpg_model_initialize > +function is used to initialize a connection to the closed process groups API. > +.PP > +Each application may have several connections to the CPG API. Each application > +uses the > +.I handle > +argument to uniquely identify the connection. The > +.I handle > +argument is then used in other function calls to identify the connection to be used > +for communication with the CPG service. > +.PP > +Argument > +.I model > +is used to explicitly choose set of callbacks and internal parameters. Currently only model > +.I CPG_MODEL_V1 > +is defined. > +.PP > +Callbacks and internal parameters are passed by > +.I model_data > +argument. This is casted pointer (idea is similar as in sockaddr function) to one of structures > +corresponding to chosen model. Currently only > +.I cpg_model_v1_data_t > +is needed. > +.SH MODEL_V1 > +The > +.I MODEL_V1 > +is backwards compatible with original callbacks initialized by > +.I cpg_initialize > +but new callback > +.I cpg_totem_confchg_fn > +is defined. > +.PP > +Every time an CPG event occurs within the joined group, one of the callbacks specified by the argument > +.I callbacks > +is called. The callback functions are described by the following type definitions: > +.PP > +.PP > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 20n 32n > + > +typedef void (*cpg_deliver_fn_t) ( > + cpg_handle_t handle, > + const struct cpg_name *group_name, > + uint32_t nodeid, > + uint32_t pid, > + const void *msg, > + size_t msg_len); > + > + > +typedef void (*cpg_confchg_fn_t) ( > + cpg_handle_t handle, > + const struct cpg_name *group_name, > + const struct cpg_address *member_list, size_t member_list_entries, > + const struct cpg_address *left_list, size_t left_list_entries, > + const struct cpg_address *joined_list, size_t joined_list_entries); > + > + > +typedef void (*cpg_totem_confchg_fn_t) ( > + cpg_handle_t handle, > + struct cpg_ring_id ring_id, > + uint32_t member_list_entries, > + const uint32_t *member_list); > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The > +.I cpg_model_v1_data_t > +structure is defined as: > +.IP > +.RS > +.ne 18 > +.nf > +.PP > +typedef struct { > + cpg_model_t model; > + cpg_deliver_fn_t cpg_deliver_fn; > + cpg_confchg_fn_t cpg_confchg_fn; > + cpg_totem_confchg_fn_t cpg_totem_confchg_fn; > + unsigned int flags; > +} cpg_model_v1_data_t; > +.ta > +.fi > +.RE > +.IP > +.PP > +When a configuration change occurs or a message is to be delivered one of the callbacks > +is called from the > +.B cpg_dispatch() > +function. If a configuration change occurs, > +.I cpg_confchg_fn > +is called. If a delivery of a message occurs, > +.I cpg_deliver_fn > +is called. > +When totem membership change occurs, > +.I cpg_totem_confchg_fn > +is called. You can OR > +.I CPG_MODEL_V1_DELIVER_INITIAL_TOTEM_CONF > +constant to flags to get callback after first confchg event. > + > +The > +.I cpg_address > +structure is defined > +.IP > +.RS > +.ne 18 > +.nf > +.PP > +struct cpg_address { > + unsigned int nodeid; > + unsigned int pid; > + unsigned int reason; > +}; > +.ta > +.fi > +.RE > +.IP > +.PP > +where nodeid is a 32 bit unique node identifier, pid is the process ID of the process that has joined/left the group > +or sent the message, and reason is an integer code indicating why the node joined/left the group. > +.PP > +.IP > +.RS > +.ne 18 > +.nf > +.PP > +CPG_REASON_JOIN - the process joined a group using cpg_join(). > +CPG_REASON_LEAVE - the process left a group using cpg_leave() > +CPG_REASON_NODEDOWN - the process left a group because the node left the cluster. > +CPG_REASON_NODEUP - the process joined a group because it was already a member of a group on a node that has just joined the cluster > +CPG_REASON_PROCDOWN - the process left a group without calling cpg_leave() > +.ta > +.fi > +.RE > +.IP > +.PP > +The > +.I cpg_ring_id > +structure is defined > +.IP > +.RS > +.ne 18 > +.nf > +.PP > +struct cpg_ring_id { > + uint32_t nodeid; > + uint64_t seq; > +}; > +.ta > +.fi > +.RE > +.IP > +.PP > +where > +.I nodeid > +is if of node of current Totem leader and seq is increasing number. > + > +.PP > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR cpg_overview (8), > +.BR cpg_initialize (3), > +.BR cpg_finalize (3), > +.BR cpg_fd_get (3), > +.BR cpg_dispatch (3), > +.BR cpg_join (3), > +.BR cpg_leave (3), > +.BR cpg_mcast_joined (3), > +.BR cpg_membership_get (3) > +.BR cpg_zcb_alloc (3) > +.BR cpg_zcb_free (3) > +.BR cpg_zcb_mcast_joined (3) > +.BR cpg_context_get (3) > +.BR cpg_context_set (3) > +.BR cpg_local_get (3) > +.BR cpg_model_initialize (3) > + > +.PP > diff --git a/man/cpg_zcb_alloc.3 b/man/cpg_zcb_alloc.3 > deleted file mode 100644 > index 607922b..0000000 > --- a/man/cpg_zcb_alloc.3 > +++ /dev/null > @@ -1,84 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Steven Dake <sdake@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH CPG_ZCB_ALLOC 2009-04-15 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -cpg_zcb_alloc \- Allocates a zero copy buffer > -.B #include <corosync/cpg.h> > -.sp > -.BI "int cpg_zcb_alloc(cpg_handle_t " handle ", size_t " size ", void **" buffer "); > -.SH DESCRIPTION > -The > -.B cpg_zcb_alloc > -function will allocate a zero copy buffer for use with the > -.B cpg_zcb_mcast_joined(3) > -funtion. This buffer should not be used in another thread while a > -cpg_zcb_mcast_joined operation is taking place on the buffer. The buffer is > -allocated via operating system mechanisms to avoid copying in the IPC layer. > - > -.PP > -The argument > -.I handle > -describes the handle on which the buffer will be allocated. > -.PP > -The argument > -.I size > -requests a buffer of size be allocated. > -.PP > -The > -.I buffer > -argument is set to the buffer address that is allocated by this operatoin. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR cpg_overview (8), > -.BR cpg_initialize (3), > -.BR cpg_finalize (3), > -.BR cpg_fd_get (3), > -.BR cpg_dispatch (3), > -.BR cpg_join (3), > -.BR cpg_leave (3), > -.BR cpg_mcast_joined (3), > -.BR cpg_membership_get (3) > -.BR cpg_zcb_alloc (3) > -.BR cpg_zcb_free (3) > -.BR cpg_zcb_mcast_joined (3) > -.BR cpg_context_get (3) > -.BR cpg_context_set (3) > -.BR cpg_local_get (3) > - > -.PP > diff --git a/man/cpg_zcb_alloc.3.in b/man/cpg_zcb_alloc.3.in > new file mode 100644 > index 0000000..607922b > --- /dev/null > +++ b/man/cpg_zcb_alloc.3.in > @@ -0,0 +1,84 @@ > +.\"/* > +.\" * Copyright (c) 2009 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Steven Dake <sdake@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH CPG_ZCB_ALLOC 2009-04-15 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +cpg_zcb_alloc \- Allocates a zero copy buffer > +.B #include <corosync/cpg.h> > +.sp > +.BI "int cpg_zcb_alloc(cpg_handle_t " handle ", size_t " size ", void **" buffer "); > +.SH DESCRIPTION > +The > +.B cpg_zcb_alloc > +function will allocate a zero copy buffer for use with the > +.B cpg_zcb_mcast_joined(3) > +funtion. This buffer should not be used in another thread while a > +cpg_zcb_mcast_joined operation is taking place on the buffer. The buffer is > +allocated via operating system mechanisms to avoid copying in the IPC layer. > + > +.PP > +The argument > +.I handle > +describes the handle on which the buffer will be allocated. > +.PP > +The argument > +.I size > +requests a buffer of size be allocated. > +.PP > +The > +.I buffer > +argument is set to the buffer address that is allocated by this operatoin. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR cpg_overview (8), > +.BR cpg_initialize (3), > +.BR cpg_finalize (3), > +.BR cpg_fd_get (3), > +.BR cpg_dispatch (3), > +.BR cpg_join (3), > +.BR cpg_leave (3), > +.BR cpg_mcast_joined (3), > +.BR cpg_membership_get (3) > +.BR cpg_zcb_alloc (3) > +.BR cpg_zcb_free (3) > +.BR cpg_zcb_mcast_joined (3) > +.BR cpg_context_get (3) > +.BR cpg_context_set (3) > +.BR cpg_local_get (3) > + > +.PP > diff --git a/man/cpg_zcb_free.3 b/man/cpg_zcb_free.3 > deleted file mode 100644 > index f26e2c0..0000000 > --- a/man/cpg_zcb_free.3 > +++ /dev/null > @@ -1,76 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Steven Dake <sdake@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH CPG_ZCB_FREE 2009-04-15 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -cpg_zcb_free \- Frees a zero copy buffer > -.B #include <corosync/cpg.h> > -.sp > -.BI "int cpg_zcb_fre(cpg_handle_t " handle ", void *" buffer "); > -.SH DESCRIPTION > -The > -.B cpg_zcb_free > -function will free a zero copy buffer. > - > -.PP > -The argument > -.I handle > -describes the handle on which the buffer will be allocated. > -.PP > -The argument > -.I buffer > -is the zero copy buffer to free. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR cpg_overview (8), > -.BR cpg_initialize (3), > -.BR cpg_finalize (3), > -.BR cpg_fd_get (3), > -.BR cpg_dispatch (3), > -.BR cpg_join (3), > -.BR cpg_leave (3), > -.BR cpg_mcast_joined (3), > -.BR cpg_membership_get (3) > -.BR cpg_zcb_alloc (3) > -.BR cpg_zcb_free (3) > -.BR cpg_zcb_mcast_joined (3) > -.BR cpg_context_get (3) > -.BR cpg_context_set (3) > -.BR cpg_local_get (3) > - > -.PP > diff --git a/man/cpg_zcb_free.3.in b/man/cpg_zcb_free.3.in > new file mode 100644 > index 0000000..f26e2c0 > --- /dev/null > +++ b/man/cpg_zcb_free.3.in > @@ -0,0 +1,76 @@ > +.\"/* > +.\" * Copyright (c) 2009 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Steven Dake <sdake@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH CPG_ZCB_FREE 2009-04-15 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +cpg_zcb_free \- Frees a zero copy buffer > +.B #include <corosync/cpg.h> > +.sp > +.BI "int cpg_zcb_fre(cpg_handle_t " handle ", void *" buffer "); > +.SH DESCRIPTION > +The > +.B cpg_zcb_free > +function will free a zero copy buffer. > + > +.PP > +The argument > +.I handle > +describes the handle on which the buffer will be allocated. > +.PP > +The argument > +.I buffer > +is the zero copy buffer to free. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR cpg_overview (8), > +.BR cpg_initialize (3), > +.BR cpg_finalize (3), > +.BR cpg_fd_get (3), > +.BR cpg_dispatch (3), > +.BR cpg_join (3), > +.BR cpg_leave (3), > +.BR cpg_mcast_joined (3), > +.BR cpg_membership_get (3) > +.BR cpg_zcb_alloc (3) > +.BR cpg_zcb_free (3) > +.BR cpg_zcb_mcast_joined (3) > +.BR cpg_context_get (3) > +.BR cpg_context_set (3) > +.BR cpg_local_get (3) > + > +.PP > diff --git a/man/cpg_zcb_mcast_joined.3 b/man/cpg_zcb_mcast_joined.3 > deleted file mode 100644 > index bebded2..0000000 > --- a/man/cpg_zcb_mcast_joined.3 > +++ /dev/null > @@ -1,127 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Steven Dake <sdake@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH CPG_ZCB_MCAST_JOINED 3 3004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -cpg_mcast_joined \- Multicasts a zero copy buffer to all groups joined to a handle > -.SH SYNOPSIS > -.B #include <sys/uio.h> > -.B #include <corosync/cpg.h> > -.sp > -.BI "int cpg_zcb_mcast_joined(cpg_handle_t " handle ", cpg_guarantee_t " guarantee ", const void *" buffer "", int " msg_len "); > -.SH DESCRIPTION > -The > -.B cpg_zcb_mcast_joined > -function will multicast a zero copy buffer message to all the processes that > -have been joined with the > -.B cpg_join(3) > -funtion for the same group name. > -Messages that are sent to any of the groups joined to the parameter > -.I handle > -will be delivered to all subscribed processes in the system. > -.PP > -The argument > -.I guarantee > -requests a delivery guarantee for the message to be sent. The cpg_guarantee_t type is > -defined by: > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 30n 33n > -typedef enum { > - CPG_TYPE_UNORDERED, /* not implemented */ > - CPG_TYPE_FIFO, /* same as agreed */ > - CPG_TYPE_AGREED, /* implemented */ > - CPG_TYPE_SAFE /* not implemented */ > -} cpg_guarantee_t; > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The meanings of the cpg_guarantee_t typedef are: > -.TP > -.B CPG_TYPE_UNORDERED > -Messages are guaranteed to be delivered, but with no particular order. This > -mode is unimplemented in the CPG library. > -.TP > -.B CPG_TYPE_FIFO > -Messages are guaranteed to be delivered in first sent first delivery order. > -In fact, this guarantee is equivalent to the CPG_TYPE_AGREED guarantee. > -.TP > -.B CPG_TYPE_AGREED > -All processors must agree on the order of delivery. If a message is sent > -from two or more processes at about the same time, the delivery will occur > -in the same order to all processes. > -.TP > -.B CPG_TYPE_SAFE > -All processes must agree on the order of delivery. Further all processes > -must have a copy of the message before any delivery takes place. This mode is > -unimplemented in the CPG library. > -.PP > -The > -.I msg > -argument describes the zero copy buffer which is used to transmit a message. > -this buffer must be allocated by > -.B cpg_zcb_alloc(3). > - > -.PP > -The > -.I msg_len > -argument describes the number of bytes to be transmitted in the zero copy buffer. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR cpg_overview (8), > -.BR cpg_initialize (3), > -.BR cpg_finalize (3), > -.BR cpg_fd_get (3), > -.BR cpg_dispatch (3), > -.BR cpg_join (3), > -.BR cpg_leave (3), > -.BR cpg_mcast_joined (3), > -.BR cpg_membership_get (3) > -.BR cpg_zcb_alloc (3) > -.BR cpg_zcb_free (3) > -.BR cpg_zcb_mcast_joined (3) > -.BR cpg_context_get (3) > -.BR cpg_context_set (3) > -.BR cpg_local_get (3) > - > -.PP > diff --git a/man/cpg_zcb_mcast_joined.3.in b/man/cpg_zcb_mcast_joined.3.in > new file mode 100644 > index 0000000..bebded2 > --- /dev/null > +++ b/man/cpg_zcb_mcast_joined.3.in > @@ -0,0 +1,127 @@ > +.\"/* > +.\" * Copyright (c) 2009 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Steven Dake <sdake@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH CPG_ZCB_MCAST_JOINED 3 3004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +cpg_mcast_joined \- Multicasts a zero copy buffer to all groups joined to a handle > +.SH SYNOPSIS > +.B #include <sys/uio.h> > +.B #include <corosync/cpg.h> > +.sp > +.BI "int cpg_zcb_mcast_joined(cpg_handle_t " handle ", cpg_guarantee_t " guarantee ", const void *" buffer "", int " msg_len "); > +.SH DESCRIPTION > +The > +.B cpg_zcb_mcast_joined > +function will multicast a zero copy buffer message to all the processes that > +have been joined with the > +.B cpg_join(3) > +funtion for the same group name. > +Messages that are sent to any of the groups joined to the parameter > +.I handle > +will be delivered to all subscribed processes in the system. > +.PP > +The argument > +.I guarantee > +requests a delivery guarantee for the message to be sent. The cpg_guarantee_t type is > +defined by: > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 30n 33n > +typedef enum { > + CPG_TYPE_UNORDERED, /* not implemented */ > + CPG_TYPE_FIFO, /* same as agreed */ > + CPG_TYPE_AGREED, /* implemented */ > + CPG_TYPE_SAFE /* not implemented */ > +} cpg_guarantee_t; > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The meanings of the cpg_guarantee_t typedef are: > +.TP > +.B CPG_TYPE_UNORDERED > +Messages are guaranteed to be delivered, but with no particular order. This > +mode is unimplemented in the CPG library. > +.TP > +.B CPG_TYPE_FIFO > +Messages are guaranteed to be delivered in first sent first delivery order. > +In fact, this guarantee is equivalent to the CPG_TYPE_AGREED guarantee. > +.TP > +.B CPG_TYPE_AGREED > +All processors must agree on the order of delivery. If a message is sent > +from two or more processes at about the same time, the delivery will occur > +in the same order to all processes. > +.TP > +.B CPG_TYPE_SAFE > +All processes must agree on the order of delivery. Further all processes > +must have a copy of the message before any delivery takes place. This mode is > +unimplemented in the CPG library. > +.PP > +The > +.I msg > +argument describes the zero copy buffer which is used to transmit a message. > +this buffer must be allocated by > +.B cpg_zcb_alloc(3). > + > +.PP > +The > +.I msg_len > +argument describes the number of bytes to be transmitted in the zero copy buffer. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR cpg_overview (8), > +.BR cpg_initialize (3), > +.BR cpg_finalize (3), > +.BR cpg_fd_get (3), > +.BR cpg_dispatch (3), > +.BR cpg_join (3), > +.BR cpg_leave (3), > +.BR cpg_mcast_joined (3), > +.BR cpg_membership_get (3) > +.BR cpg_zcb_alloc (3) > +.BR cpg_zcb_free (3) > +.BR cpg_zcb_mcast_joined (3) > +.BR cpg_context_get (3) > +.BR cpg_context_set (3) > +.BR cpg_local_get (3) > + > +.PP > diff --git a/man/evs_context_get.3 b/man/evs_context_get.3 > deleted file mode 100644 > index 9ef4d3a..0000000 > --- a/man/evs_context_get.3 > +++ /dev/null > @@ -1,64 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2007 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH EVS_CONTEXT_GET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -evs_context_get \- Gets the context variable for a EVS instance > -.SH SYNOPSIS > -.B #include <corosync/evs.h> > -.sp > -.BI "int evs_context_get(evs_handle_t " handle ", void **" context "); > -.SH DESCRIPTION > -The > -.B evs_context_get > -function is used to retrieve the context variable previously stored using > -.B evs_context_set(3) > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR evs_overview (8), > -.BR evs_initialize (3), > -.BR evs_finalize (3), > -.BR evs_fd_get (3), > -.BR evs_dispatch (3), > -.BR evs_join (3), > -.BR evs_leave (3), > -.BR evs_mcast_joined (3), > -.BR evs_mcast_groups (3), > -.BR evs_mmembership_get (3) > -.BR evs_context_get (3) > -.BR evs_context_set (3) > -.PP > diff --git a/man/evs_context_get.3.in b/man/evs_context_get.3.in > new file mode 100644 > index 0000000..9ef4d3a > --- /dev/null > +++ b/man/evs_context_get.3.in > @@ -0,0 +1,64 @@ > +.\"/* > +.\" * Copyright (c) 2007 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH EVS_CONTEXT_GET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +evs_context_get \- Gets the context variable for a EVS instance > +.SH SYNOPSIS > +.B #include <corosync/evs.h> > +.sp > +.BI "int evs_context_get(evs_handle_t " handle ", void **" context "); > +.SH DESCRIPTION > +The > +.B evs_context_get > +function is used to retrieve the context variable previously stored using > +.B evs_context_set(3) > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR evs_overview (8), > +.BR evs_initialize (3), > +.BR evs_finalize (3), > +.BR evs_fd_get (3), > +.BR evs_dispatch (3), > +.BR evs_join (3), > +.BR evs_leave (3), > +.BR evs_mcast_joined (3), > +.BR evs_mcast_groups (3), > +.BR evs_mmembership_get (3) > +.BR evs_context_get (3) > +.BR evs_context_set (3) > +.PP > diff --git a/man/evs_context_set.3 b/man/evs_context_set.3 > deleted file mode 100644 > index 19d279f..0000000 > --- a/man/evs_context_set.3 > +++ /dev/null > @@ -1,66 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2007 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH EVS_CONTEXT_SET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -evs_context_set \- Sets the context variable for a EVS instance > -.SH SYNOPSIS > -.B #include <corosync/evs.h> > -.sp > -.BI "int evs_context_set(evs_handle_t " handle ", void *" context "); > -.SH DESCRIPTION > -The > -.B evs_context_set > -function is used to set the context variable for a evs instance. It has no > -meaning insire libevs itself and will not be touched by the library. It can > -be retrieved using > -.B evs_context_get(3) > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR evs_overview (8), > -.BR evs_initialize (3), > -.BR evs_finalize (3), > -.BR evs_fd_get (3), > -.BR evs_dispatch (3), > -.BR evs_join (3), > -.BR evs_leave (3), > -.BR evs_mcast_joined (3), > -.BR evs_mcast_groups (3), > -.BR evs_mmembership_get (3) > -.BR evs_context_get (3) > -.BR evs_context_set (3) > -.PP > diff --git a/man/evs_context_set.3.in b/man/evs_context_set.3.in > new file mode 100644 > index 0000000..19d279f > --- /dev/null > +++ b/man/evs_context_set.3.in > @@ -0,0 +1,66 @@ > +.\"/* > +.\" * Copyright (c) 2007 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH EVS_CONTEXT_SET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +evs_context_set \- Sets the context variable for a EVS instance > +.SH SYNOPSIS > +.B #include <corosync/evs.h> > +.sp > +.BI "int evs_context_set(evs_handle_t " handle ", void *" context "); > +.SH DESCRIPTION > +The > +.B evs_context_set > +function is used to set the context variable for a evs instance. It has no > +meaning insire libevs itself and will not be touched by the library. It can > +be retrieved using > +.B evs_context_get(3) > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR evs_overview (8), > +.BR evs_initialize (3), > +.BR evs_finalize (3), > +.BR evs_fd_get (3), > +.BR evs_dispatch (3), > +.BR evs_join (3), > +.BR evs_leave (3), > +.BR evs_mcast_joined (3), > +.BR evs_mcast_groups (3), > +.BR evs_mmembership_get (3) > +.BR evs_context_get (3) > +.BR evs_context_set (3) > +.PP > diff --git a/man/evs_dispatch.3 b/man/evs_dispatch.3 > deleted file mode 100644 > index 2624a42..0000000 > --- a/man/evs_dispatch.3 > +++ /dev/null > @@ -1,107 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2004 MontaVista Software, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH EVS_DISPATCH 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -evs_dispatch \- Dispatches callbacks from the EVS service > -.SH SYNOPSIS > -.B #include <corosync/evs.h> > -.sp > -.BI "int evs_dispatch(evs_handle_t " handle ", evs_dispatch_t *" dispatch_types "); > -.SH DESCRIPTION > -The > -.B evs_dispatch > -function is used to dispatch configuration changes or messages from the > -extended virtual synchrony API. > -.PP > -Each application may have several connections to the EVS API. Each application > -uses the > -.I handle > -argument to uniquely identify the connection. > -.PP > -The > -.I dispatch_types > -argument is used to identify the type of dispatch to execute. The possible types are > -defined by the structure: > - > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 30n 33n > -typedef enum { > - CS_DISPATCH_ONE, > - CS_DISPATCH_ALL, > - CS_DISPATCH_BLOCKING > -} cs_dispatch_flags_t; > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The dispatch values have the following meanings: > -.TP > -.B CS_DISPATCH_ONE > -Dispatch atleast one callback, blocking until the callback is dispatched. > -.TP > -.B CS_DISPATCH_ALL > -Dispatch all waiting callbacks without blocking to wait for any callbacks. > -.TP > -.B CS_DISPATCH_BLOCKING > -Dispatch all callbacks blocking indefinately. This is used in a threaded > -program where a thread is created, and then evs_dispatch() is called immediately > -from the created thread to execute callbacks. > -.TP > -.B CS_DISPATCH_ONE_NONBLOCKING > -Dispatch at most one callback. If there is no pending callback, > -CS_ERR_TRY_AGAIN is returned. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR evs_overview (8), > -.BR evs_initialize (3), > -.BR evs_finalize (3), > -.BR evs_fd_get (3), > -.BR evs_join (3), > -.BR evs_leave (3), > -.BR evs_mcast_joined (3), > -.BR evs_mcast_groups (3), > -.BR evs_mmembership_get (3) > -.BR evs_context_get (3) > -.BR evs_context_set (3) > -.PP > diff --git a/man/evs_dispatch.3.in b/man/evs_dispatch.3.in > new file mode 100644 > index 0000000..2624a42 > --- /dev/null > +++ b/man/evs_dispatch.3.in > @@ -0,0 +1,107 @@ > +.\"/* > +.\" * Copyright (c) 2004 MontaVista Software, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH EVS_DISPATCH 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +evs_dispatch \- Dispatches callbacks from the EVS service > +.SH SYNOPSIS > +.B #include <corosync/evs.h> > +.sp > +.BI "int evs_dispatch(evs_handle_t " handle ", evs_dispatch_t *" dispatch_types "); > +.SH DESCRIPTION > +The > +.B evs_dispatch > +function is used to dispatch configuration changes or messages from the > +extended virtual synchrony API. > +.PP > +Each application may have several connections to the EVS API. Each application > +uses the > +.I handle > +argument to uniquely identify the connection. > +.PP > +The > +.I dispatch_types > +argument is used to identify the type of dispatch to execute. The possible types are > +defined by the structure: > + > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 30n 33n > +typedef enum { > + CS_DISPATCH_ONE, > + CS_DISPATCH_ALL, > + CS_DISPATCH_BLOCKING > +} cs_dispatch_flags_t; > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The dispatch values have the following meanings: > +.TP > +.B CS_DISPATCH_ONE > +Dispatch atleast one callback, blocking until the callback is dispatched. > +.TP > +.B CS_DISPATCH_ALL > +Dispatch all waiting callbacks without blocking to wait for any callbacks. > +.TP > +.B CS_DISPATCH_BLOCKING > +Dispatch all callbacks blocking indefinately. This is used in a threaded > +program where a thread is created, and then evs_dispatch() is called immediately > +from the created thread to execute callbacks. > +.TP > +.B CS_DISPATCH_ONE_NONBLOCKING > +Dispatch at most one callback. If there is no pending callback, > +CS_ERR_TRY_AGAIN is returned. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR evs_overview (8), > +.BR evs_initialize (3), > +.BR evs_finalize (3), > +.BR evs_fd_get (3), > +.BR evs_join (3), > +.BR evs_leave (3), > +.BR evs_mcast_joined (3), > +.BR evs_mcast_groups (3), > +.BR evs_mmembership_get (3) > +.BR evs_context_get (3) > +.BR evs_context_set (3) > +.PP > diff --git a/man/evs_fd_get.3 b/man/evs_fd_get.3 > deleted file mode 100644 > index ece9036..0000000 > --- a/man/evs_fd_get.3 > +++ /dev/null > @@ -1,70 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2004 MontaVista Software, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH EVS_FD_GET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -evs_fd_get \- Dispatches callbacks from the EVS service > -.SH SYNOPSIS > -.B #include <corosync/evs.h> > -.sp > -.BI "int evs_fd_get(evs_handle_t " handle ", int *" fd "); > -.SH DESCRIPTION > -The > -.B evs_fd_get > -function is used to retrieve the file descriptor that may be used with the poll > -system call to determine when > -.B evs_dispatch(3) > -won't block. The > -.I handle > -argument may not be used directly with > -.B poll > -because it is not the file descriptor, but instead an internal identifier used > -by the EVS library. > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR evs_overview (8), > -.BR evs_initialize (3), > -.BR evs_finalize (3), > -.BR evs_dispatch (3), > -.BR evs_join (3), > -.BR evs_leave (3), > -.BR evs_mcast_joined (3), > -.BR evs_mcast_groups (3), > -.BR evs_mmembership_get (3) > -.BR evs_context_get (3) > -.BR evs_context_set (3) > -.PP > diff --git a/man/evs_fd_get.3.in b/man/evs_fd_get.3.in > new file mode 100644 > index 0000000..ece9036 > --- /dev/null > +++ b/man/evs_fd_get.3.in > @@ -0,0 +1,70 @@ > +.\"/* > +.\" * Copyright (c) 2004 MontaVista Software, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH EVS_FD_GET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +evs_fd_get \- Dispatches callbacks from the EVS service > +.SH SYNOPSIS > +.B #include <corosync/evs.h> > +.sp > +.BI "int evs_fd_get(evs_handle_t " handle ", int *" fd "); > +.SH DESCRIPTION > +The > +.B evs_fd_get > +function is used to retrieve the file descriptor that may be used with the poll > +system call to determine when > +.B evs_dispatch(3) > +won't block. The > +.I handle > +argument may not be used directly with > +.B poll > +because it is not the file descriptor, but instead an internal identifier used > +by the EVS library. > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR evs_overview (8), > +.BR evs_initialize (3), > +.BR evs_finalize (3), > +.BR evs_dispatch (3), > +.BR evs_join (3), > +.BR evs_leave (3), > +.BR evs_mcast_joined (3), > +.BR evs_mcast_groups (3), > +.BR evs_mmembership_get (3) > +.BR evs_context_get (3) > +.BR evs_context_set (3) > +.PP > diff --git a/man/evs_finalize.3 b/man/evs_finalize.3 > deleted file mode 100644 > index cc2c697..0000000 > --- a/man/evs_finalize.3 > +++ /dev/null > @@ -1,66 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2004 MontaVista Software, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH EVS_FINALIZE 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -evs_finalize \- Terminate a connection to the EVS service > -.SH SYNOPSIS > -.B #include <corosync/evs.h> > -.sp > -.BI "int evs_finalize(evs_handle_t " handle "); > -.SH DESCRIPTION > -The > -.B evs_finalize > -function is used to close a connection to the extended virtual synchrony API. > -Once the connection is finalized, the handle may not be used again by applications. > -No more callbacks will be dispatched from the > -.B evs_dispatch function. > -.PP > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR evs_overview (8), > -.BR evs_initialize (3), > -.BR evs_fd_get (3), > -.BR evs_dispatch (3), > -.BR evs_join (3), > -.BR evs_leave (3), > -.BR evs_mcast_joined (3), > -.BR evs_mcast_groups (3), > -.BR evs_mmembership_get (3) > -.BR evs_context_get (3) > -.BR evs_context_set (3) > -.PP > diff --git a/man/evs_finalize.3.in b/man/evs_finalize.3.in > new file mode 100644 > index 0000000..cc2c697 > --- /dev/null > +++ b/man/evs_finalize.3.in > @@ -0,0 +1,66 @@ > +.\"/* > +.\" * Copyright (c) 2004 MontaVista Software, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH EVS_FINALIZE 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +evs_finalize \- Terminate a connection to the EVS service > +.SH SYNOPSIS > +.B #include <corosync/evs.h> > +.sp > +.BI "int evs_finalize(evs_handle_t " handle "); > +.SH DESCRIPTION > +The > +.B evs_finalize > +function is used to close a connection to the extended virtual synchrony API. > +Once the connection is finalized, the handle may not be used again by applications. > +No more callbacks will be dispatched from the > +.B evs_dispatch function. > +.PP > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR evs_overview (8), > +.BR evs_initialize (3), > +.BR evs_fd_get (3), > +.BR evs_dispatch (3), > +.BR evs_join (3), > +.BR evs_leave (3), > +.BR evs_mcast_joined (3), > +.BR evs_mcast_groups (3), > +.BR evs_mmembership_get (3) > +.BR evs_context_get (3) > +.BR evs_context_set (3) > +.PP > diff --git a/man/evs_initialize.3 b/man/evs_initialize.3 > deleted file mode 100644 > index c5bd4dd..0000000 > --- a/man/evs_initialize.3 > +++ /dev/null > @@ -1,121 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2004 MontaVista Software, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH EVS_INITIALIZE 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -evs_initialize \- Create a new connection to the EVS service > -.SH SYNOPSIS > -.B #include <corosync/evs.h> > -.sp > -.BI "int evs_initialize(evs_handle_t *" handle ", evs_callbacks_t *" callbacks "); > -.SH DESCRIPTION > -The > -.B evs_initialize > -function is used to initialize a connection to the extended virtual synchrony API. > -.PP > -Each application may have several connections to the EVS API. Each application > -uses the > -.I handle > -argument to uniquely identify the connection. The > -.I handle > -argument is then used in other function calls to identify the connection to be used > -for communication with the EVS service. > -.PP > -Every time an EVS event occurs, one of the callbacks specified by the argument > -.I callbacks > -is called. The callback functions are described by the following type definitions: > -.PP > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 20n 32n > -typedef void (*evs_deliver_fn_t) ( > - unsigned int nodeid, > - const void *msg, > - size_t msg_len); > - > -typedef void (*evs_confchg_fn_t) ( > - unsigned int *member_list, size_t member_list_entries, > - unsigned int *left_list, size_t left_list_entries, > - unsigned int *joined_list, size_t joined_list_entries); > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The > -.I callbacks > -argument is of the type: > -.IP > -.RS > -.ne 18 > -.nf > -.PP > -typedef struct { > - evs_deliver_fn_t evs_deliver_fn; > - evs_confchg_fn_t evs_confchg_fn; > -} evs_callbacks_t; > -.ta > -.fi > -.RE > -.IP > -.PP > -When a configuration change occurs or a message is to be delivered one of the callbacks > -is called from the > -.B evs_dispatch() > -function. If a configuration change occurs, > -.I evs_confchg_fn > -is called. If a delivery of a message occurs, > -.I evs_deliver_fn > -is called. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR evs_overview (8), > -.BR evs_finalize (3), > -.BR evs_fd_get (3), > -.BR evs_dispatch (3), > -.BR evs_join (3), > -.BR evs_leave (3), > -.BR evs_mcast_joined (3), > -.BR evs_mcast_groups (3), > -.BR evs_mmembership_get (3) > -.BR evs_context_get (3) > -.BR evs_context_set (3) > -.PP > diff --git a/man/evs_initialize.3.in b/man/evs_initialize.3.in > new file mode 100644 > index 0000000..c5bd4dd > --- /dev/null > +++ b/man/evs_initialize.3.in > @@ -0,0 +1,121 @@ > +.\"/* > +.\" * Copyright (c) 2004 MontaVista Software, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH EVS_INITIALIZE 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +evs_initialize \- Create a new connection to the EVS service > +.SH SYNOPSIS > +.B #include <corosync/evs.h> > +.sp > +.BI "int evs_initialize(evs_handle_t *" handle ", evs_callbacks_t *" callbacks "); > +.SH DESCRIPTION > +The > +.B evs_initialize > +function is used to initialize a connection to the extended virtual synchrony API. > +.PP > +Each application may have several connections to the EVS API. Each application > +uses the > +.I handle > +argument to uniquely identify the connection. The > +.I handle > +argument is then used in other function calls to identify the connection to be used > +for communication with the EVS service. > +.PP > +Every time an EVS event occurs, one of the callbacks specified by the argument > +.I callbacks > +is called. The callback functions are described by the following type definitions: > +.PP > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 20n 32n > +typedef void (*evs_deliver_fn_t) ( > + unsigned int nodeid, > + const void *msg, > + size_t msg_len); > + > +typedef void (*evs_confchg_fn_t) ( > + unsigned int *member_list, size_t member_list_entries, > + unsigned int *left_list, size_t left_list_entries, > + unsigned int *joined_list, size_t joined_list_entries); > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The > +.I callbacks > +argument is of the type: > +.IP > +.RS > +.ne 18 > +.nf > +.PP > +typedef struct { > + evs_deliver_fn_t evs_deliver_fn; > + evs_confchg_fn_t evs_confchg_fn; > +} evs_callbacks_t; > +.ta > +.fi > +.RE > +.IP > +.PP > +When a configuration change occurs or a message is to be delivered one of the callbacks > +is called from the > +.B evs_dispatch() > +function. If a configuration change occurs, > +.I evs_confchg_fn > +is called. If a delivery of a message occurs, > +.I evs_deliver_fn > +is called. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR evs_overview (8), > +.BR evs_finalize (3), > +.BR evs_fd_get (3), > +.BR evs_dispatch (3), > +.BR evs_join (3), > +.BR evs_leave (3), > +.BR evs_mcast_joined (3), > +.BR evs_mcast_groups (3), > +.BR evs_mmembership_get (3) > +.BR evs_context_get (3) > +.BR evs_context_set (3) > +.PP > diff --git a/man/evs_join.3 b/man/evs_join.3 > deleted file mode 100644 > index e6338d4..0000000 > --- a/man/evs_join.3 > +++ /dev/null > @@ -1,105 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2004 MontaVista Software, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH EVS_JOIN 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -evs_join \- Joins one or more groups in the EVS library > -.SH SYNOPSIS > -.B #include <corosync/evs.h> > -.sp > -.BI "int evs_join(evs_handle_t " handle ", evs_group_t *" groups ", int " group_entries "); > -.SH DESCRIPTION > -The > -.B evs_join > -function is used to join one or more groups. When a group is joined, using the > -.B evs_mcast_joined(3) > -function will multicast to the groups joined in the argument > -.I handle. > -Messages that are sent to any of the groups joined to the parameter > -.I handle > -will be delivered by > -.B evs_dispatch(3). > -.PP > -This call may be used more then once on a handle, in which case the joined groups will > -be all of the groups passed to the > -.B evs_join(3) > -function during the lifecycle of the parameter > -.I handle. > -.PP > - > -The argument > -.I groups > -is used to specify the groups to join. A group is a 32 byte key. The key is > -not a string, hence, the entire key is used when joining the channel. For that reason > -the entire group should be initialized. > -.PP > -The argument > -.I group_entries > -specifies how many entries are located in the groups argument. > - > -The > -.I groups > -argument is of the type evs_group_t which is defined by the structure: > - > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 30n 33n > -typedef struct { > - char key[32]; > -} evs_groups_t; > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR evs_overview (8), > -.BR evs_initialize (3), > -.BR evs_finalize (3), > -.BR evs_fd_get (3), > -.BR evs_dispatch (3), > -.BR evs_leave (3), > -.BR evs_mcast_joined (3), > -.BR evs_mcast_groups (3), > -.BR evs_mmembership_get (3) > -.BR evs_context_get (3) > -.BR evs_context_set (3) > -.PP > diff --git a/man/evs_join.3.in b/man/evs_join.3.in > new file mode 100644 > index 0000000..e6338d4 > --- /dev/null > +++ b/man/evs_join.3.in > @@ -0,0 +1,105 @@ > +.\"/* > +.\" * Copyright (c) 2004 MontaVista Software, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH EVS_JOIN 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +evs_join \- Joins one or more groups in the EVS library > +.SH SYNOPSIS > +.B #include <corosync/evs.h> > +.sp > +.BI "int evs_join(evs_handle_t " handle ", evs_group_t *" groups ", int " group_entries "); > +.SH DESCRIPTION > +The > +.B evs_join > +function is used to join one or more groups. When a group is joined, using the > +.B evs_mcast_joined(3) > +function will multicast to the groups joined in the argument > +.I handle. > +Messages that are sent to any of the groups joined to the parameter > +.I handle > +will be delivered by > +.B evs_dispatch(3). > +.PP > +This call may be used more then once on a handle, in which case the joined groups will > +be all of the groups passed to the > +.B evs_join(3) > +function during the lifecycle of the parameter > +.I handle. > +.PP > + > +The argument > +.I groups > +is used to specify the groups to join. A group is a 32 byte key. The key is > +not a string, hence, the entire key is used when joining the channel. For that reason > +the entire group should be initialized. > +.PP > +The argument > +.I group_entries > +specifies how many entries are located in the groups argument. > + > +The > +.I groups > +argument is of the type evs_group_t which is defined by the structure: > + > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 30n 33n > +typedef struct { > + char key[32]; > +} evs_groups_t; > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR evs_overview (8), > +.BR evs_initialize (3), > +.BR evs_finalize (3), > +.BR evs_fd_get (3), > +.BR evs_dispatch (3), > +.BR evs_leave (3), > +.BR evs_mcast_joined (3), > +.BR evs_mcast_groups (3), > +.BR evs_mmembership_get (3) > +.BR evs_context_get (3) > +.BR evs_context_set (3) > +.PP > diff --git a/man/evs_leave.3 b/man/evs_leave.3 > deleted file mode 100644 > index 09ffe8e..0000000 > --- a/man/evs_leave.3 > +++ /dev/null > @@ -1,100 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2004 MontaVista Software, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH EVS_LEAVE 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -evs_leave \- Leave one or more groups in the EVS library > -.SH SYNOPSIS > -.B #include <corosync/evs.h> > -.sp > -.BI "int evs_leave(evs_handle_t " handle ", evs_group_t *" groups ", int group_entries); > -.SH DESCRIPTION > -The > -.B evs_leave > -function is used to leave one or more groups. The joined groups are used with > -.B evs_mcast_joined(3) > -function to multicast to the groups joined in the argument > -.I handle. > -Messages that are sent to any of the joined groups to the parameter > -.I handle > -will be delivered by > -.B evs_dispatch(3). > -.PP > -This call may be used more then once on a handle. > -.PP > - > -The argument > -.I groups > -is used to specify the groups to leave. A group is a 32 byte key. The key is > -not a string, hence, the entire key is used when leaveing the channel. For that reason > -the entire group should be initialized. > -.PP > -The argument > -.I group_entries > -specifies how many entries are located in the groups argument. > - > -The > -.I groups > -argument is of the type evs_group_t which is defined by the structure: > - > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 30n 33n > -typedef struct { > - char key[32]; > -} evs_groups_t; > -.ta > -.fi > -.RE > -.IP > -.PP > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR evs_overview (8), > -.BR evs_initialize (3), > -.BR evs_finalize (3), > -.BR evs_fd_get (3), > -.BR evs_dispatch (3), > -.BR evs_join (3), > -.BR evs_mcast_joined (3), > -.BR evs_mcast_groups (3), > -.BR evs_mmembership_get (3) > -.BR evs_context_get (3) > -.BR evs_context_set (3) > -.PP > diff --git a/man/evs_leave.3.in b/man/evs_leave.3.in > new file mode 100644 > index 0000000..09ffe8e > --- /dev/null > +++ b/man/evs_leave.3.in > @@ -0,0 +1,100 @@ > +.\"/* > +.\" * Copyright (c) 2004 MontaVista Software, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH EVS_LEAVE 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +evs_leave \- Leave one or more groups in the EVS library > +.SH SYNOPSIS > +.B #include <corosync/evs.h> > +.sp > +.BI "int evs_leave(evs_handle_t " handle ", evs_group_t *" groups ", int group_entries); > +.SH DESCRIPTION > +The > +.B evs_leave > +function is used to leave one or more groups. The joined groups are used with > +.B evs_mcast_joined(3) > +function to multicast to the groups joined in the argument > +.I handle. > +Messages that are sent to any of the joined groups to the parameter > +.I handle > +will be delivered by > +.B evs_dispatch(3). > +.PP > +This call may be used more then once on a handle. > +.PP > + > +The argument > +.I groups > +is used to specify the groups to leave. A group is a 32 byte key. The key is > +not a string, hence, the entire key is used when leaveing the channel. For that reason > +the entire group should be initialized. > +.PP > +The argument > +.I group_entries > +specifies how many entries are located in the groups argument. > + > +The > +.I groups > +argument is of the type evs_group_t which is defined by the structure: > + > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 30n 33n > +typedef struct { > + char key[32]; > +} evs_groups_t; > +.ta > +.fi > +.RE > +.IP > +.PP > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR evs_overview (8), > +.BR evs_initialize (3), > +.BR evs_finalize (3), > +.BR evs_fd_get (3), > +.BR evs_dispatch (3), > +.BR evs_join (3), > +.BR evs_mcast_joined (3), > +.BR evs_mcast_groups (3), > +.BR evs_mmembership_get (3) > +.BR evs_context_get (3) > +.BR evs_context_set (3) > +.PP > diff --git a/man/evs_mcast_groups.3 b/man/evs_mcast_groups.3 > deleted file mode 100644 > index 4bb5c00..0000000 > --- a/man/evs_mcast_groups.3 > +++ /dev/null > @@ -1,164 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2004 MontaVista Software, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH EVS_MCAST_GROUPS 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -evs_join \- Multicast a message to selected groups > -.SH SYNOPSIS > -.B #include <sys/uio.h> > -.B #include <corosync/evs.h> > -.sp > -.BI "int evs_mcast_groups(evs_handle_t " handle ", evs_guraantee_t " guarantee ", evs_group_t *" groups ", int group_entries, struct iovec *" iovec ", int " iov_len "); > -.SH DESCRIPTION > -The > -.B evs_mcast_groups(3) > -function multicasts a message to all the groups specified in the arguemnt > -.I groups. > -Messages are delivered to all processors in the system that are described by the current > -configuration. > -.PP > -The argument > -.I handle > -describes a handle created with > -.B evs_initialize(3). > -.PP > -The argument > -.I guarantee > -requests a delivery guarantee for the message to be sent. The evs_guarantee_t type is > -defined by: > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 30n 33n > -typedef enum { > - EVS_TYPE_UNORDERED, /* not implemented */ > - EVS_TYPE_FIFO, /* same as agreed */ > - EVS_TYPE_AGREED, /* implemented */ > - EVS_TYPE_SAFE /* not implemented */ > -} evs_guarantee_t; > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The meanings of the evs_guarantee_t typedef are: > -.TP > -.B EVS_GUARANTEE_UNORDERED > -Messages are guaranteed to be delivered, but with no particular order. This > -mode is unimplemented in the EVS library. > -.TP > -.B EVS_GUARANTEE_FIFO > -Messages are guaranteed to be delivered in first sent first delivery order > -from one one. In fact, this guarantee is actually the AGREED guarantee. > -.TP > -.B EVS_GUARANTEE_AGREED > -All processors must agree on the order of delivery. If a message is sent > -from two or more processors at about the same time, the delivery will occur > -in the same order to all processors. > -.TP > -.B EVS_GUARANTEE_SAFE > -All processors must agree on the order of delivery. Further all processors > -must have a copy of the message before any delivery takes place. This mode is > -unimplemented in the EVS library. > -.PP > -The > -.I groups > -argument is of the type evs_group_t which is defined by the structure: > - > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 30n 33n > -typedef struct { > - char key[32]; > -} evs_groups_t; > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The > -.I group_entries > -argument describes the number of entries in the > -.I group > -argument. > -.PP > - > -The > -.I iovec > -argument describes the scatter/gather list which is used to transmit a message. This > -is a standard socket structure described by: > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 30n 33n > -struct iovec > -{ > - void *iov_base; /* Pointer to data. */ > - unsigned int iov_len; /* Length of data. */ > -}; > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The > -.I iovlen > -argument describes the number of entires in the > -.I iovec > -argument. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR evs_overview (8), > -.BR evs_initialize (3), > -.BR evs_finalize (3), > -.BR evs_fd_get (3), > -.BR evs_dispatch (3), > -.BR evs_leave (3), > -.BR evs_join (3), > -.BR evs_mcast_joined (3), > -.BR evs_mmembership_get (3) > -.BR evs_context_get (3) > -.BR evs_context_set (3) > -.PP > diff --git a/man/evs_mcast_groups.3.in b/man/evs_mcast_groups.3.in > new file mode 100644 > index 0000000..4bb5c00 > --- /dev/null > +++ b/man/evs_mcast_groups.3.in > @@ -0,0 +1,164 @@ > +.\"/* > +.\" * Copyright (c) 2004 MontaVista Software, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH EVS_MCAST_GROUPS 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +evs_join \- Multicast a message to selected groups > +.SH SYNOPSIS > +.B #include <sys/uio.h> > +.B #include <corosync/evs.h> > +.sp > +.BI "int evs_mcast_groups(evs_handle_t " handle ", evs_guraantee_t " guarantee ", evs_group_t *" groups ", int group_entries, struct iovec *" iovec ", int " iov_len "); > +.SH DESCRIPTION > +The > +.B evs_mcast_groups(3) > +function multicasts a message to all the groups specified in the arguemnt > +.I groups. > +Messages are delivered to all processors in the system that are described by the current > +configuration. > +.PP > +The argument > +.I handle > +describes a handle created with > +.B evs_initialize(3). > +.PP > +The argument > +.I guarantee > +requests a delivery guarantee for the message to be sent. The evs_guarantee_t type is > +defined by: > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 30n 33n > +typedef enum { > + EVS_TYPE_UNORDERED, /* not implemented */ > + EVS_TYPE_FIFO, /* same as agreed */ > + EVS_TYPE_AGREED, /* implemented */ > + EVS_TYPE_SAFE /* not implemented */ > +} evs_guarantee_t; > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The meanings of the evs_guarantee_t typedef are: > +.TP > +.B EVS_GUARANTEE_UNORDERED > +Messages are guaranteed to be delivered, but with no particular order. This > +mode is unimplemented in the EVS library. > +.TP > +.B EVS_GUARANTEE_FIFO > +Messages are guaranteed to be delivered in first sent first delivery order > +from one one. In fact, this guarantee is actually the AGREED guarantee. > +.TP > +.B EVS_GUARANTEE_AGREED > +All processors must agree on the order of delivery. If a message is sent > +from two or more processors at about the same time, the delivery will occur > +in the same order to all processors. > +.TP > +.B EVS_GUARANTEE_SAFE > +All processors must agree on the order of delivery. Further all processors > +must have a copy of the message before any delivery takes place. This mode is > +unimplemented in the EVS library. > +.PP > +The > +.I groups > +argument is of the type evs_group_t which is defined by the structure: > + > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 30n 33n > +typedef struct { > + char key[32]; > +} evs_groups_t; > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The > +.I group_entries > +argument describes the number of entries in the > +.I group > +argument. > +.PP > + > +The > +.I iovec > +argument describes the scatter/gather list which is used to transmit a message. This > +is a standard socket structure described by: > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 30n 33n > +struct iovec > +{ > + void *iov_base; /* Pointer to data. */ > + unsigned int iov_len; /* Length of data. */ > +}; > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The > +.I iovlen > +argument describes the number of entires in the > +.I iovec > +argument. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR evs_overview (8), > +.BR evs_initialize (3), > +.BR evs_finalize (3), > +.BR evs_fd_get (3), > +.BR evs_dispatch (3), > +.BR evs_leave (3), > +.BR evs_join (3), > +.BR evs_mcast_joined (3), > +.BR evs_mmembership_get (3) > +.BR evs_context_get (3) > +.BR evs_context_set (3) > +.PP > diff --git a/man/evs_mcast_joined.3 b/man/evs_mcast_joined.3 > deleted file mode 100644 > index 4d7d78e..0000000 > --- a/man/evs_mcast_joined.3 > +++ /dev/null > @@ -1,137 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2004 MontaVista Software, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH EVS_MCAST_JOINED 3 3004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -evs_join \- Multicasts to all groups joined to an handle > -.SH SYNOPSIS > -.B #include <sys/uio.h> > -.B #include <corosync/evs.h> > -.sp > -.BI "int evs_mcast_joined(evs_handle_t " handle ", evs_guraantee_t " guarantee ", struct iovec *" iovec ", int " iov_len "); > -.SH DESCRIPTION > -The > -.B evs_mcast_joined > -function is multicast a message to all the groups that have been joined with the > -.B evs_join(3) > -function for the argument > -.I handle. > -Messages that are sent to any of the groups joined to the parameter > -.I handle > -will be delivered to all processors in the system. > -.PP > -The argument > -.I guarantee > -requests a delivery guarantee for the message to be sent. The evs_guarantee_t type is > -defined by: > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 30n 33n > -typedef enum { > - EVS_TYPE_UNORDERED, /* not implemented */ > - EVS_TYPE_FIFO, /* same as agreed */ > - EVS_TYPE_AGREED, /* implemented */ > - EVS_TYPE_SAFE /* not implemented */ > -} evs_guarantee_t; > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The meanings of the evs_guarantee_t typedef are: > -.TP > -.B EVS_GUARANTEE_UNORDERED > -Messages are guaranteed to be delivered, but with no particular order. This > -mode is unimplemented in the EVS library. > -.TP > -.B EVS_GUARANTEE_FIFO > -Messages are guaranteed to be delivered in first sent first delivery order > -from one one. In fact, this guarantee is actually the AGREED guarantee. > -.TP > -.B EVS_GUARANTEE_AGREED > -All processors must agree on the order of delivery. If a message is sent > -from two or more processors at about the same time, the delivery will occur > -in the same order to all processors. > -.TP > -.B EVS_GUARANTEE_SAFE > -All processors must agree on the order of delivery. Further all processors > -must have a copy of the message before any delivery takes place. This mode is > -unimplemented in the EVS library. > -.PP > -The > -.I iovec > -argument describes the scatter/gather list which is used to transmit a message. This > -is a standard socket structure described by: > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 30n 33n > -struct iovec > -{ > - void *iov_base; /* Pointer to data. */ > - unsigned int iov_len; /* Length of data. */ > -}; > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The > -.I iovlen > -argument describes the number of entires in the > -.I iovec > -argument. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR evs_overview (8), > -.BR evs_initialize (3), > -.BR evs_finalize (3), > -.BR evs_fd_get (3), > -.BR evs_dispatch (3), > -.BR evs_leave (3), > -.BR evs_join (3), > -.BR evs_mcast_groups (3), > -.BR evs_mmembership_get (3) > -.BR evs_context_get (3) > -.BR evs_context_set (3) > -.PP > diff --git a/man/evs_mcast_joined.3.in b/man/evs_mcast_joined.3.in > new file mode 100644 > index 0000000..4d7d78e > --- /dev/null > +++ b/man/evs_mcast_joined.3.in > @@ -0,0 +1,137 @@ > +.\"/* > +.\" * Copyright (c) 2004 MontaVista Software, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH EVS_MCAST_JOINED 3 3004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +evs_join \- Multicasts to all groups joined to an handle > +.SH SYNOPSIS > +.B #include <sys/uio.h> > +.B #include <corosync/evs.h> > +.sp > +.BI "int evs_mcast_joined(evs_handle_t " handle ", evs_guraantee_t " guarantee ", struct iovec *" iovec ", int " iov_len "); > +.SH DESCRIPTION > +The > +.B evs_mcast_joined > +function is multicast a message to all the groups that have been joined with the > +.B evs_join(3) > +function for the argument > +.I handle. > +Messages that are sent to any of the groups joined to the parameter > +.I handle > +will be delivered to all processors in the system. > +.PP > +The argument > +.I guarantee > +requests a delivery guarantee for the message to be sent. The evs_guarantee_t type is > +defined by: > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 30n 33n > +typedef enum { > + EVS_TYPE_UNORDERED, /* not implemented */ > + EVS_TYPE_FIFO, /* same as agreed */ > + EVS_TYPE_AGREED, /* implemented */ > + EVS_TYPE_SAFE /* not implemented */ > +} evs_guarantee_t; > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The meanings of the evs_guarantee_t typedef are: > +.TP > +.B EVS_GUARANTEE_UNORDERED > +Messages are guaranteed to be delivered, but with no particular order. This > +mode is unimplemented in the EVS library. > +.TP > +.B EVS_GUARANTEE_FIFO > +Messages are guaranteed to be delivered in first sent first delivery order > +from one one. In fact, this guarantee is actually the AGREED guarantee. > +.TP > +.B EVS_GUARANTEE_AGREED > +All processors must agree on the order of delivery. If a message is sent > +from two or more processors at about the same time, the delivery will occur > +in the same order to all processors. > +.TP > +.B EVS_GUARANTEE_SAFE > +All processors must agree on the order of delivery. Further all processors > +must have a copy of the message before any delivery takes place. This mode is > +unimplemented in the EVS library. > +.PP > +The > +.I iovec > +argument describes the scatter/gather list which is used to transmit a message. This > +is a standard socket structure described by: > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 30n 33n > +struct iovec > +{ > + void *iov_base; /* Pointer to data. */ > + unsigned int iov_len; /* Length of data. */ > +}; > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The > +.I iovlen > +argument describes the number of entires in the > +.I iovec > +argument. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR evs_overview (8), > +.BR evs_initialize (3), > +.BR evs_finalize (3), > +.BR evs_fd_get (3), > +.BR evs_dispatch (3), > +.BR evs_leave (3), > +.BR evs_join (3), > +.BR evs_mcast_groups (3), > +.BR evs_mmembership_get (3) > +.BR evs_context_get (3) > +.BR evs_context_set (3) > +.PP > diff --git a/man/evs_membership_get.3 b/man/evs_membership_get.3 > deleted file mode 100644 > index 657b243..0000000 > --- a/man/evs_membership_get.3 > +++ /dev/null > @@ -1,74 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2004 MontaVista Software, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH EVS_JOIN 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -evs_join \- Joins one or more groups in the EVS library > -.SH SYNOPSIS > -.B #include <corosync/evs.h> > -.sp > -.BI "int evs_membership_get(evs_handle_t " handle ", unsigned int *" local_nodeid ", unsigned int *" member_list ", int *" member_list_entries "); > -.SH DESCRIPTION > -The > -.B evs_membership_get > -function is used to determine the current processors in the configuration and also > -the local processor identifier. > -The argument > -.I handle > -is used to reference the evs instantiation. > -The argument > -.I local_nodeid > -will return the local node id of the processor. > -The argument > -.I member_list > -will return the list of processors in the current membership. > -The argument > -.I member_list_entries > -should be set with the size of member_list and will return the size of the > -member_list after return from the function. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR evs_overview (8), > -.BR evs_initialize (3), > -.BR evs_finalize (3), > -.BR evs_fd_get (3), > -.BR evs_dispatch (3), > -.BR evs_leave (3), > -.BR evs_mcast_joined (3), > -.BR evs_mcast_groups (3), > -.BR evs_mmembership_get (3) > -.BR evs_context_get (3) > -.BR evs_context_set (3) > -.PP > diff --git a/man/evs_membership_get.3.in b/man/evs_membership_get.3.in > new file mode 100644 > index 0000000..657b243 > --- /dev/null > +++ b/man/evs_membership_get.3.in > @@ -0,0 +1,74 @@ > +.\"/* > +.\" * Copyright (c) 2004 MontaVista Software, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Steven Dake (sdake@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH EVS_JOIN 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +evs_join \- Joins one or more groups in the EVS library > +.SH SYNOPSIS > +.B #include <corosync/evs.h> > +.sp > +.BI "int evs_membership_get(evs_handle_t " handle ", unsigned int *" local_nodeid ", unsigned int *" member_list ", int *" member_list_entries "); > +.SH DESCRIPTION > +The > +.B evs_membership_get > +function is used to determine the current processors in the configuration and also > +the local processor identifier. > +The argument > +.I handle > +is used to reference the evs instantiation. > +The argument > +.I local_nodeid > +will return the local node id of the processor. > +The argument > +.I member_list > +will return the list of processors in the current membership. > +The argument > +.I member_list_entries > +should be set with the size of member_list and will return the size of the > +member_list after return from the function. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR evs_overview (8), > +.BR evs_initialize (3), > +.BR evs_finalize (3), > +.BR evs_fd_get (3), > +.BR evs_dispatch (3), > +.BR evs_leave (3), > +.BR evs_mcast_joined (3), > +.BR evs_mcast_groups (3), > +.BR evs_mmembership_get (3) > +.BR evs_context_get (3) > +.BR evs_context_set (3) > +.PP > diff --git a/man/quorum_context_get.3 b/man/quorum_context_get.3 > deleted file mode 100644 > index 6295961..0000000 > --- a/man/quorum_context_get.3 > +++ /dev/null > @@ -1,57 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH QUORUM_CONTEXT_GET 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -quorum_context_get \- Gets the context variable for a QUORUM instance > -.SH SYNOPSIS > -.B #include <corosync/quorum.h> > -.sp > -.BI "int quorum_context_get(quorum_handle_t " handle ", void **" context "); > -.SH DESCRIPTION > -The > -.B quorum_context_get > -function is used to retrieve the context variable previously stored using > -.B quorum_context_set(3) > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR quorum_initialize (3), > -.BR quorum_finalize (3), > -.BR quorum_fd_get (3), > -.BR quorum_dispatch (3), > -.BR quorum_context_set (3), > -.PP > diff --git a/man/quorum_context_get.3.in b/man/quorum_context_get.3.in > new file mode 100644 > index 0000000..6295961 > --- /dev/null > +++ b/man/quorum_context_get.3.in > @@ -0,0 +1,57 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH QUORUM_CONTEXT_GET 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +quorum_context_get \- Gets the context variable for a QUORUM instance > +.SH SYNOPSIS > +.B #include <corosync/quorum.h> > +.sp > +.BI "int quorum_context_get(quorum_handle_t " handle ", void **" context "); > +.SH DESCRIPTION > +The > +.B quorum_context_get > +function is used to retrieve the context variable previously stored using > +.B quorum_context_set(3) > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR quorum_initialize (3), > +.BR quorum_finalize (3), > +.BR quorum_fd_get (3), > +.BR quorum_dispatch (3), > +.BR quorum_context_set (3), > +.PP > diff --git a/man/quorum_context_set.3 b/man/quorum_context_set.3 > deleted file mode 100644 > index 42fd216..0000000 > --- a/man/quorum_context_set.3 > +++ /dev/null > @@ -1,59 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH QUORUM_CONTEXT_SET 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -quorum_context_set \- Sets the context variable for a QUORUM instance > -.SH SYNOPSIS > -.B #include <corosync/quorum.h> > -.sp > -.BI "int quorum_context_set(quorum_handle_t " handle ", void *" context "); > -.SH DESCRIPTION > -The > -.B quorum_context_set > -function is used to set the context variable for a quorum instance. It has no > -meaning insire libquorum itself and will not be touched by the library. It can > -be retrieved using > -.B quorum_context_get(3) > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR quorum_initialize (3), > -.BR quorum_finalize (3), > -.BR quorum_fd_get (3), > -.BR quorum_dispatch (3), > -.BR quorum_context_get (3), > -.PP > diff --git a/man/quorum_context_set.3.in b/man/quorum_context_set.3.in > new file mode 100644 > index 0000000..42fd216 > --- /dev/null > +++ b/man/quorum_context_set.3.in > @@ -0,0 +1,59 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH QUORUM_CONTEXT_SET 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +quorum_context_set \- Sets the context variable for a QUORUM instance > +.SH SYNOPSIS > +.B #include <corosync/quorum.h> > +.sp > +.BI "int quorum_context_set(quorum_handle_t " handle ", void *" context "); > +.SH DESCRIPTION > +The > +.B quorum_context_set > +function is used to set the context variable for a quorum instance. It has no > +meaning insire libquorum itself and will not be touched by the library. It can > +be retrieved using > +.B quorum_context_get(3) > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR quorum_initialize (3), > +.BR quorum_finalize (3), > +.BR quorum_fd_get (3), > +.BR quorum_dispatch (3), > +.BR quorum_context_get (3), > +.PP > diff --git a/man/quorum_dispatch.3 b/man/quorum_dispatch.3 > deleted file mode 100644 > index 8f7c3a0..0000000 > --- a/man/quorum_dispatch.3 > +++ /dev/null > @@ -1,99 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH QUORUM_DISPATCH 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -quorum_dispatch \- Dispatches callbacks from the quorum service > -.SH SYNOPSIS > -.B #include <corosync/quorum.h> > -.sp > -.BI "int quorum_dispatch(quorum_handle_t " handle ", quorum_dispatch_t *" dispatch_types ");" > -.SH DESCRIPTION > -The > -.B quorum_dispatch > -function is used to dispatch configuration changes. > -.PP > -Each application may have several connections to the quorum API. Each application > -uses the > -.I handle > -argument to uniquely identify the connection. > -.PP > -The > -.I dispatch_types > -argument is used to identify the type of dispatch to execute. The possible types are > -defined by the structure: > - > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 30n 33n > -typedef enum { > - CS_DISPATCH_ONE, > - CS_DISPATCH_ALL, > - CS_DISPATCH_BLOCKING > -} quorum_dispatch_t; > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The dispatch values have the following meanings: > -.TP > -.B CS_DISPATCH_ONE > -Dispatch at least one callback, blocking until the callback is dispatched. > -.TP > -.B CS_DISPATCH_ALL > -Dispatch all waiting callbacks without blocking to wait for any callbacks. > -.TP > -.B CS_DISPATCH_BLOCKING > -Dispatch all callbacks blocking indefinitely. This is used in a threaded > -program where a thread is created, and then quorum_dispatch() is called immediately > -from the created thread to execute callbacks. > -.TP > -.B CS_DISPATCH_ONE_NONBLOCKING > -Dispatch at most one callback. If there is no pending callback, > -CS_ERR_TRY_AGAIN is returned. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR quorum_initialize (3), > -.BR quorum_finalize (3), > -.BR quorum_fd_get (3), > - > -.PP > diff --git a/man/quorum_dispatch.3.in b/man/quorum_dispatch.3.in > new file mode 100644 > index 0000000..8f7c3a0 > --- /dev/null > +++ b/man/quorum_dispatch.3.in > @@ -0,0 +1,99 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH QUORUM_DISPATCH 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +quorum_dispatch \- Dispatches callbacks from the quorum service > +.SH SYNOPSIS > +.B #include <corosync/quorum.h> > +.sp > +.BI "int quorum_dispatch(quorum_handle_t " handle ", quorum_dispatch_t *" dispatch_types ");" > +.SH DESCRIPTION > +The > +.B quorum_dispatch > +function is used to dispatch configuration changes. > +.PP > +Each application may have several connections to the quorum API. Each application > +uses the > +.I handle > +argument to uniquely identify the connection. > +.PP > +The > +.I dispatch_types > +argument is used to identify the type of dispatch to execute. The possible types are > +defined by the structure: > + > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 30n 33n > +typedef enum { > + CS_DISPATCH_ONE, > + CS_DISPATCH_ALL, > + CS_DISPATCH_BLOCKING > +} quorum_dispatch_t; > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The dispatch values have the following meanings: > +.TP > +.B CS_DISPATCH_ONE > +Dispatch at least one callback, blocking until the callback is dispatched. > +.TP > +.B CS_DISPATCH_ALL > +Dispatch all waiting callbacks without blocking to wait for any callbacks. > +.TP > +.B CS_DISPATCH_BLOCKING > +Dispatch all callbacks blocking indefinitely. This is used in a threaded > +program where a thread is created, and then quorum_dispatch() is called immediately > +from the created thread to execute callbacks. > +.TP > +.B CS_DISPATCH_ONE_NONBLOCKING > +Dispatch at most one callback. If there is no pending callback, > +CS_ERR_TRY_AGAIN is returned. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR quorum_initialize (3), > +.BR quorum_finalize (3), > +.BR quorum_fd_get (3), > + > +.PP > diff --git a/man/quorum_fd_get.3 b/man/quorum_fd_get.3 > deleted file mode 100644 > index b41eba1..0000000 > --- a/man/quorum_fd_get.3 > +++ /dev/null > @@ -1,62 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH QUORUM_FD_GET 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -quorum_fd_get \- Dispatches callbacks from the quorum service > -.SH SYNOPSIS > -.B #include <corosync/quorum.h> > -.sp > -.BI "int quorum_fd_get(quorum_handle_t " handle ", int *" fd ");" > -.SH DESCRIPTION > -The > -.B quorum_fd_get > -function is used to retrieve the file descriptor that may be used with the poll > -system call to determine when > -.B quorum_dispatch(3) > -won't block. The > -.I handle > -argument may not be used directly with > -.B poll > -because it is not the file descriptor, but instead an internal identifier used > -by the quorum library. > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR quorum_initialize (3), > -.BR quorum_finalize (3), > -.BR quorum_dispatch (3), > -.PP > diff --git a/man/quorum_fd_get.3.in b/man/quorum_fd_get.3.in > new file mode 100644 > index 0000000..b41eba1 > --- /dev/null > +++ b/man/quorum_fd_get.3.in > @@ -0,0 +1,62 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH QUORUM_FD_GET 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +quorum_fd_get \- Dispatches callbacks from the quorum service > +.SH SYNOPSIS > +.B #include <corosync/quorum.h> > +.sp > +.BI "int quorum_fd_get(quorum_handle_t " handle ", int *" fd ");" > +.SH DESCRIPTION > +The > +.B quorum_fd_get > +function is used to retrieve the file descriptor that may be used with the poll > +system call to determine when > +.B quorum_dispatch(3) > +won't block. The > +.I handle > +argument may not be used directly with > +.B poll > +because it is not the file descriptor, but instead an internal identifier used > +by the quorum library. > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR quorum_initialize (3), > +.BR quorum_finalize (3), > +.BR quorum_dispatch (3), > +.PP > diff --git a/man/quorum_finalize.3 b/man/quorum_finalize.3 > deleted file mode 100644 > index d745cbb..0000000 > --- a/man/quorum_finalize.3 > +++ /dev/null > @@ -1,59 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH QUORUM_FINALIZE 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -quorum_finalize \- Terminate a connection to the quorum service > -.SH SYNOPSIS > -.B #include <corosync/quorum.h> > -.sp > -.BI "int quorum_finalize(quorum_handle_t " handle ");" > -.SH DESCRIPTION > -The > -.B quorum_finalize > -function is used to close a connection to the quorum API. > -Once the connection is finalized, the handle may not be used again by applications. > -No more callbacks will be dispatched from the > -.B quorum_dispatch function. > -.PP > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR quorum_initialize (3), > -.BR quorum_dispatch (3), > -.BR quorum_fd_get (3), > - > -.PP > diff --git a/man/quorum_finalize.3.in b/man/quorum_finalize.3.in > new file mode 100644 > index 0000000..d745cbb > --- /dev/null > +++ b/man/quorum_finalize.3.in > @@ -0,0 +1,59 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH QUORUM_FINALIZE 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +quorum_finalize \- Terminate a connection to the quorum service > +.SH SYNOPSIS > +.B #include <corosync/quorum.h> > +.sp > +.BI "int quorum_finalize(quorum_handle_t " handle ");" > +.SH DESCRIPTION > +The > +.B quorum_finalize > +function is used to close a connection to the quorum API. > +Once the connection is finalized, the handle may not be used again by applications. > +No more callbacks will be dispatched from the > +.B quorum_dispatch function. > +.PP > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR quorum_initialize (3), > +.BR quorum_dispatch (3), > +.BR quorum_fd_get (3), > + > +.PP > diff --git a/man/quorum_getquorate.3 b/man/quorum_getquorate.3 > deleted file mode 100644 > index ae6e34e..0000000 > --- a/man/quorum_getquorate.3 > +++ /dev/null > @@ -1,54 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH QUORUM_GETQUORATE 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -quorum_getquorate \- Gets the quorate status of the node. > -.SH SYNOPSIS > -.B #include <corosync/quorum.h> > -.sp > -.BI "int quorum_getquorate(quorum_handle_t " handle ", int *" quorate "); > -.SH DESCRIPTION > -The > -.B quorum_getquorate > -function is used to retrieve the quorate status of the node. quorate is 0 if the node > -is not part of a quorate partition or 1 otherwise. > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR quorum_initialize (3), > -.BR quorum_finalize (3), > -.PP > diff --git a/man/quorum_getquorate.3.in b/man/quorum_getquorate.3.in > new file mode 100644 > index 0000000..ae6e34e > --- /dev/null > +++ b/man/quorum_getquorate.3.in > @@ -0,0 +1,54 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH QUORUM_GETQUORATE 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +quorum_getquorate \- Gets the quorate status of the node. > +.SH SYNOPSIS > +.B #include <corosync/quorum.h> > +.sp > +.BI "int quorum_getquorate(quorum_handle_t " handle ", int *" quorate "); > +.SH DESCRIPTION > +The > +.B quorum_getquorate > +function is used to retrieve the quorate status of the node. quorate is 0 if the node > +is not part of a quorate partition or 1 otherwise. > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR quorum_initialize (3), > +.BR quorum_finalize (3), > +.PP > diff --git a/man/quorum_initialize.3 b/man/quorum_initialize.3 > deleted file mode 100644 > index 5d92415..0000000 > --- a/man/quorum_initialize.3 > +++ /dev/null > @@ -1,128 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH QUORUM_INITIALIZE 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -quorum_initialize \- Create a new connection to the Quorum service > -.SH SYNOPSIS > -.B #include <corosync/quorum.h> > -.sp > -.BI "int quorum_initialize(quorum_handle_t *" handle ", quorum_callbacks_t *" callbacks ", uint32_t *" quorum_type "); > -.SH DESCRIPTION > -The > -.B quorum_initialize > -function is used to initialize a connection to the quorum API. > -.PP > -Each application may have several connections to the quorum API. Each application > -uses the > -.I handle > -argument to uniquely identify the connection. The > -.I handle > -argument is then used in other function calls to identify the connection to be used > -for communication with the quorum service. > -.PP > -Every time the voting configuraton changes (eg a node joins or leave the cluster) or the quorum status change, > -the callback is called. > -The callback function is described by the following type definitions: > - > -typedef void (*quorum_notification_fn_t) ( > - quorum_handle_t handle, > - uint32_t quorate, > - uint64_t ring_seq, > - uint32_t view_list_entries, > - uint32_t *view_list > - ); > - > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The > -.I callbacks > -argument is of the type: > -.IP > -.RS > -.ne 18 > -.nf > -.PP > -typedef struct { > - quorum_notification_fn_t quorum_notify_fn; > -} quorum_callbacks_t; > - > -.ta > -.fi > -.RE > -.IP > -.PP > -The > -.I quorum_type > -argument is set to: > -.IP > -.RS > -.ne 18 > -.nf > -.PP > -#define QUORUM_FREE 0 > -#define QUORUM_SET 1 > - > -.ta > -.fi > -.RE > -.IP > -.PP > -.I QUORUM_FREE > -value means that no quorum algorithm is loaded and that no callbacks will take place. > -.PP > -.I QUORUM_SET > -value means that one quorum algorithm is configured and that callbacks will take place. > -.PP > -When a configuration change occurs, the callback > -is called from the > -.B quorum_dispatch() > -function. > -.PP > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH BUGS > -Callbacks are not support at the moment. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR quorum_finalize (3), > -.BR quorum_fd_get (3), > -.BR quorum_dispatch (3), > -.PP > diff --git a/man/quorum_initialize.3.in b/man/quorum_initialize.3.in > new file mode 100644 > index 0000000..5d92415 > --- /dev/null > +++ b/man/quorum_initialize.3.in > @@ -0,0 +1,128 @@ > +.\"/* > +.\" * Copyright (c) 2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH QUORUM_INITIALIZE 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +quorum_initialize \- Create a new connection to the Quorum service > +.SH SYNOPSIS > +.B #include <corosync/quorum.h> > +.sp > +.BI "int quorum_initialize(quorum_handle_t *" handle ", quorum_callbacks_t *" callbacks ", uint32_t *" quorum_type "); > +.SH DESCRIPTION > +The > +.B quorum_initialize > +function is used to initialize a connection to the quorum API. > +.PP > +Each application may have several connections to the quorum API. Each application > +uses the > +.I handle > +argument to uniquely identify the connection. The > +.I handle > +argument is then used in other function calls to identify the connection to be used > +for communication with the quorum service. > +.PP > +Every time the voting configuraton changes (eg a node joins or leave the cluster) or the quorum status change, > +the callback is called. > +The callback function is described by the following type definitions: > + > +typedef void (*quorum_notification_fn_t) ( > + quorum_handle_t handle, > + uint32_t quorate, > + uint64_t ring_seq, > + uint32_t view_list_entries, > + uint32_t *view_list > + ); > + > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The > +.I callbacks > +argument is of the type: > +.IP > +.RS > +.ne 18 > +.nf > +.PP > +typedef struct { > + quorum_notification_fn_t quorum_notify_fn; > +} quorum_callbacks_t; > + > +.ta > +.fi > +.RE > +.IP > +.PP > +The > +.I quorum_type > +argument is set to: > +.IP > +.RS > +.ne 18 > +.nf > +.PP > +#define QUORUM_FREE 0 > +#define QUORUM_SET 1 > + > +.ta > +.fi > +.RE > +.IP > +.PP > +.I QUORUM_FREE > +value means that no quorum algorithm is loaded and that no callbacks will take place. > +.PP > +.I QUORUM_SET > +value means that one quorum algorithm is configured and that callbacks will take place. > +.PP > +When a configuration change occurs, the callback > +is called from the > +.B quorum_dispatch() > +function. > +.PP > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH BUGS > +Callbacks are not support at the moment. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR quorum_finalize (3), > +.BR quorum_fd_get (3), > +.BR quorum_dispatch (3), > +.PP > diff --git a/man/sam_data_getsize.3 b/man/sam_data_getsize.3 > deleted file mode 100644 > index 33d527e..0000000 > --- a/man/sam_data_getsize.3 > +++ /dev/null > @@ -1,68 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2010 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "SAM_DATA_GETSIZE" 3 "04/15/2010" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -sam_data_getsize \- Return size of stored data in bytes > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/sam.h>\fR > - > -.P > -\fBcs_error_t sam_data_getsize (size_t *\fIsize\fB);\fR > - > -.SH DESCRIPTION > -.P > -The \fBsam_data_getsize\fR function is used to return size of stored > -data. Size is returned in bytes. If user data is NULL, zero is returned. > -Function is intended to be used before \fBsam_data_restore(3)\fR call to > -properly allocate buffer for restored data. > - > -.SH RETURN VALUE > -.P > -This call return CS_OK value if successful, otherwise and error is returned. > - > -.SH ERRORS > -.TP > -CS_ERR_BAD_HANDLE > -component was not initialized by calling \fBsam_initialize(3)\fR or it was finalized. > -.TP > -CS_ERR_INVALID_PARAM > -size parameter is NULL > - > -.SH "SEE ALSO" > -.BR sam_data_store (3), > -.BR sam_data_restore (3) > diff --git a/man/sam_data_getsize.3.in b/man/sam_data_getsize.3.in > new file mode 100644 > index 0000000..33d527e > --- /dev/null > +++ b/man/sam_data_getsize.3.in > @@ -0,0 +1,68 @@ > +.\"/* > +.\" * Copyright (c) 2010 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "SAM_DATA_GETSIZE" 3 "04/15/2010" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +sam_data_getsize \- Return size of stored data in bytes > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/sam.h>\fR > + > +.P > +\fBcs_error_t sam_data_getsize (size_t *\fIsize\fB);\fR > + > +.SH DESCRIPTION > +.P > +The \fBsam_data_getsize\fR function is used to return size of stored > +data. Size is returned in bytes. If user data is NULL, zero is returned. > +Function is intended to be used before \fBsam_data_restore(3)\fR call to > +properly allocate buffer for restored data. > + > +.SH RETURN VALUE > +.P > +This call return CS_OK value if successful, otherwise and error is returned. > + > +.SH ERRORS > +.TP > +CS_ERR_BAD_HANDLE > +component was not initialized by calling \fBsam_initialize(3)\fR or it was finalized. > +.TP > +CS_ERR_INVALID_PARAM > +size parameter is NULL > + > +.SH "SEE ALSO" > +.BR sam_data_store (3), > +.BR sam_data_restore (3) > diff --git a/man/sam_data_restore.3 b/man/sam_data_restore.3 > deleted file mode 100644 > index 32b816a..0000000 > --- a/man/sam_data_restore.3 > +++ /dev/null > @@ -1,77 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2010 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "SAM_DATA_RESTORE" 3 "04/15/2010" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -sam_data_restore \- Restore previously saved user data > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/sam.h>\fR > - > -.P > -\fBcs_error_t sam_data_restore (void *\fIdata\fB, size_t \fIsize\fB);\fR > - > -.SH DESCRIPTION > -.P > -The \fBsam_data_restore\fR function is used to restore data, previously > -saved by calling \fBsam_data_store(3)\fR. Such data survives between instances. > - > -.P > -The \fIdata\fR parameter is pointer to memory initialized by caller. Stored data > -are copied there. This also means, that caller is responsible for freeing memory. > - > -.P > -The \fIsize\fR parameter is length of \fIdata\fR. This one must be at least same > -length as previously stored data otherwise error is returned. Parameter can > -be larger but only stored data size bytes are changed. > - > -Use \fBsam_data_getsize(3)\fR to find out length of stored data. > - > -.SH RETURN VALUE > -.P > -This call return CS_OK value if successful, otherwise and error is returned. > - > -.SH ERRORS > -.TP > -CS_ERR_BAD_HANDLE > -component was not initialized by calling \fBsam_initialize(3)\fR or it was finalized. > -.TP > -CS_ERR_INVALID_PARAM > -data parameter is NULL or size is less then currently stored data length > - > -.SH "SEE ALSO" > -.BR sam_data_getsize (3), > -.BR sam_data_store (3) > diff --git a/man/sam_data_restore.3.in b/man/sam_data_restore.3.in > new file mode 100644 > index 0000000..32b816a > --- /dev/null > +++ b/man/sam_data_restore.3.in > @@ -0,0 +1,77 @@ > +.\"/* > +.\" * Copyright (c) 2010 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "SAM_DATA_RESTORE" 3 "04/15/2010" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +sam_data_restore \- Restore previously saved user data > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/sam.h>\fR > + > +.P > +\fBcs_error_t sam_data_restore (void *\fIdata\fB, size_t \fIsize\fB);\fR > + > +.SH DESCRIPTION > +.P > +The \fBsam_data_restore\fR function is used to restore data, previously > +saved by calling \fBsam_data_store(3)\fR. Such data survives between instances. > + > +.P > +The \fIdata\fR parameter is pointer to memory initialized by caller. Stored data > +are copied there. This also means, that caller is responsible for freeing memory. > + > +.P > +The \fIsize\fR parameter is length of \fIdata\fR. This one must be at least same > +length as previously stored data otherwise error is returned. Parameter can > +be larger but only stored data size bytes are changed. > + > +Use \fBsam_data_getsize(3)\fR to find out length of stored data. > + > +.SH RETURN VALUE > +.P > +This call return CS_OK value if successful, otherwise and error is returned. > + > +.SH ERRORS > +.TP > +CS_ERR_BAD_HANDLE > +component was not initialized by calling \fBsam_initialize(3)\fR or it was finalized. > +.TP > +CS_ERR_INVALID_PARAM > +data parameter is NULL or size is less then currently stored data length > + > +.SH "SEE ALSO" > +.BR sam_data_getsize (3), > +.BR sam_data_store (3) > diff --git a/man/sam_data_store.3 b/man/sam_data_store.3 > deleted file mode 100644 > index 6e90651..0000000 > --- a/man/sam_data_store.3 > +++ /dev/null > @@ -1,83 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2010 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "SAM_DATA_STORE" 3 "04/15/2010" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -sam_data_store \- Store user data > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/sam.h>\fR > - > -.P > -\fBcs_error_t sam_data_store (const void *\fIdata\fB, size_t \fIsize\fB);\fR > - > -.SH DESCRIPTION > -.P > -The \fBsam_data_store\fR function is used to store data, which survives between > -instances. > - > -.P > -The \fIdata\fR parameter is pointer to memory with data to store. Data > -are stored in newly allocated memory inside library, so caller can safely remove > -them after call of function. > - > -You can use NULL as parameter to remove and free previously saved data. In this > -case \fIsize\fR argument is ignored. > - > -.P > -The \fIsize\fR parameter is length of \fIdata\fR. > - > -Use \fBsam_data_getsize(3)\fR to find out length of stored data and \fBsam_data_restore(3)\fR > -to restore stored data. > - > -.SH RETURN VALUE > -.P > -This call return CS_OK value if successful, otherwise and error is returned. > - > -.SH ERRORS > -.TP > -CS_ERR_BAD_HANDLE > -component was not initialized by calling \fBsam_initialize(3)\fR or it was finalized. > -.TP > -CS_ERR_NO_MEMORY > -internal malloc/realloc failed because data are too large > -.TP > -CS_ERR_LIBRARY > -some internal error appeared (mostly because communication with parent process failed) > - > -.SH "SEE ALSO" > -.BR sam_data_getsize (3), > -.BR sam_data_restore (3) > diff --git a/man/sam_data_store.3.in b/man/sam_data_store.3.in > new file mode 100644 > index 0000000..6e90651 > --- /dev/null > +++ b/man/sam_data_store.3.in > @@ -0,0 +1,83 @@ > +.\"/* > +.\" * Copyright (c) 2010 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "SAM_DATA_STORE" 3 "04/15/2010" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +sam_data_store \- Store user data > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/sam.h>\fR > + > +.P > +\fBcs_error_t sam_data_store (const void *\fIdata\fB, size_t \fIsize\fB);\fR > + > +.SH DESCRIPTION > +.P > +The \fBsam_data_store\fR function is used to store data, which survives between > +instances. > + > +.P > +The \fIdata\fR parameter is pointer to memory with data to store. Data > +are stored in newly allocated memory inside library, so caller can safely remove > +them after call of function. > + > +You can use NULL as parameter to remove and free previously saved data. In this > +case \fIsize\fR argument is ignored. > + > +.P > +The \fIsize\fR parameter is length of \fIdata\fR. > + > +Use \fBsam_data_getsize(3)\fR to find out length of stored data and \fBsam_data_restore(3)\fR > +to restore stored data. > + > +.SH RETURN VALUE > +.P > +This call return CS_OK value if successful, otherwise and error is returned. > + > +.SH ERRORS > +.TP > +CS_ERR_BAD_HANDLE > +component was not initialized by calling \fBsam_initialize(3)\fR or it was finalized. > +.TP > +CS_ERR_NO_MEMORY > +internal malloc/realloc failed because data are too large > +.TP > +CS_ERR_LIBRARY > +some internal error appeared (mostly because communication with parent process failed) > + > +.SH "SEE ALSO" > +.BR sam_data_getsize (3), > +.BR sam_data_restore (3) > diff --git a/man/sam_finalize.3 b/man/sam_finalize.3 > deleted file mode 100644 > index c633a70..0000000 > --- a/man/sam_finalize.3 > +++ /dev/null > @@ -1,63 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "SAM_FINALIZE" 3 "12/01/2009" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -sam_finalize \- Terminate SAM service > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/sam.h>\fR > - > -.P > -\fBcs_error_t sam_finalize (void);\fR > - > -.SH DESCRIPTION > -.P > -The \fBsam_finalize\fR function is used to terminate SAM API. Once the connection is finalized, > -the SAM may not be used again by application. Whole functionality (health checking) will be > -stopped and after application fail, recovery action will not be taken. > - > -.SH RETURN VALUE > -.P > -This call return CS_OK value if successful, otherwise and error is returned. > - > -.SH ERRORS > -.TP > -CS_ERR_BAD_HANDLE > -library was not initialized by \fBsam_init(3)\fR function or was finished already. > - > -.SH "SEE ALSO" > -.BR sam_initialize (3) > diff --git a/man/sam_finalize.3.in b/man/sam_finalize.3.in > new file mode 100644 > index 0000000..c633a70 > --- /dev/null > +++ b/man/sam_finalize.3.in > @@ -0,0 +1,63 @@ > +.\"/* > +.\" * Copyright (c) 2009 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "SAM_FINALIZE" 3 "12/01/2009" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +sam_finalize \- Terminate SAM service > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/sam.h>\fR > + > +.P > +\fBcs_error_t sam_finalize (void);\fR > + > +.SH DESCRIPTION > +.P > +The \fBsam_finalize\fR function is used to terminate SAM API. Once the connection is finalized, > +the SAM may not be used again by application. Whole functionality (health checking) will be > +stopped and after application fail, recovery action will not be taken. > + > +.SH RETURN VALUE > +.P > +This call return CS_OK value if successful, otherwise and error is returned. > + > +.SH ERRORS > +.TP > +CS_ERR_BAD_HANDLE > +library was not initialized by \fBsam_init(3)\fR function or was finished already. > + > +.SH "SEE ALSO" > +.BR sam_initialize (3) > diff --git a/man/sam_hc_callback_register.3 b/man/sam_hc_callback_register.3 > deleted file mode 100644 > index 91be22d..0000000 > --- a/man/sam_hc_callback_register.3 > +++ /dev/null > @@ -1,89 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "SAM_HC_CALLBACK_REGISTER" 3 "12/01/2009" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -sam_hc_callback_register \- Register health check callback > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/sam.h>\fR > - > -.P > -\fBcs_error_t sam_hc_callback_register (sam_hc_callback_t cb);\fR > - > -.SH DESCRIPTION > -.P > -The \fBsam_hc_callback_register\fR function is used to register a user provided > -healthcheck callback. After calling of this function, the SAM is switched > -from application driven healthchecking to event driven healthchecking. In this > -mode, \fBsam_hc_send(3)\fR does not need to be executed. > - > -.P > -The parameter \fIcb\fR is callback function of type \fIsam_hc_callback_t\fR > -defined as: > - > -.nf > - typedef int (*sam_hc_callback_t)(void); > -.fi > - > -.P > -This function will be regulargly called and must return 0 if the process is > -functioning normally, or -1 if the process is executing abnormally. When -1 is > -returned, the SAM server execute the registered recovery policy. > - > -.P > -A value of NULL can be passed into this function to switch into application > -driven healthchecking. > -\fIcb\fR to NULL. > - > -.SH RETURN VALUE > -.P > -This call return CS_OK value if successful, otherwise and error is returned. > - > -.SH ERRORS > -.TP > -CS_ERR_BAD_HANDLE > -SAM was not initialized and registered or health checking is in running state > -.TP > -CS_ERR_LIBRARY > -internal library call failed. This can occur during fork() or pipe () system > -calls and the errno variable can be read to retrieve more information. > - > -.SH "SEE ALSO" > -.BR sam_start (3), > -.BR sam_stop (3), > -.BR sam_hc_send (3), > -.BR sam_register (3), > diff --git a/man/sam_hc_callback_register.3.in b/man/sam_hc_callback_register.3.in > new file mode 100644 > index 0000000..91be22d > --- /dev/null > +++ b/man/sam_hc_callback_register.3.in > @@ -0,0 +1,89 @@ > +.\"/* > +.\" * Copyright (c) 2009 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "SAM_HC_CALLBACK_REGISTER" 3 "12/01/2009" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +sam_hc_callback_register \- Register health check callback > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/sam.h>\fR > + > +.P > +\fBcs_error_t sam_hc_callback_register (sam_hc_callback_t cb);\fR > + > +.SH DESCRIPTION > +.P > +The \fBsam_hc_callback_register\fR function is used to register a user provided > +healthcheck callback. After calling of this function, the SAM is switched > +from application driven healthchecking to event driven healthchecking. In this > +mode, \fBsam_hc_send(3)\fR does not need to be executed. > + > +.P > +The parameter \fIcb\fR is callback function of type \fIsam_hc_callback_t\fR > +defined as: > + > +.nf > + typedef int (*sam_hc_callback_t)(void); > +.fi > + > +.P > +This function will be regulargly called and must return 0 if the process is > +functioning normally, or -1 if the process is executing abnormally. When -1 is > +returned, the SAM server execute the registered recovery policy. > + > +.P > +A value of NULL can be passed into this function to switch into application > +driven healthchecking. > +\fIcb\fR to NULL. > + > +.SH RETURN VALUE > +.P > +This call return CS_OK value if successful, otherwise and error is returned. > + > +.SH ERRORS > +.TP > +CS_ERR_BAD_HANDLE > +SAM was not initialized and registered or health checking is in running state > +.TP > +CS_ERR_LIBRARY > +internal library call failed. This can occur during fork() or pipe () system > +calls and the errno variable can be read to retrieve more information. > + > +.SH "SEE ALSO" > +.BR sam_start (3), > +.BR sam_stop (3), > +.BR sam_hc_send (3), > +.BR sam_register (3), > diff --git a/man/sam_hc_send.3 b/man/sam_hc_send.3 > deleted file mode 100644 > index c8e9131..0000000 > --- a/man/sam_hc_send.3 > +++ /dev/null > @@ -1,68 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "SAM_HC_SEND" 3 "12/01/2009" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -sam_hc_send \- Send health check confirmation > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/sam.h>\fR > - > -.P > -\fBcs_error_t sam_hc_send (void);\fR > - > -.SH DESCRIPTION > -.P > -The \fBsam_hc_send\fR function is used to send healthcheck confirmation from > -the applicatoin. This function should be called reguarly when configured for > -application driven healthchecking, otherwise recovery actoin will be taken. > - > -When using event driven healthchecking, this function should not be used. > - > -.SH RETURN VALUE > -.P > -This call return CS_OK value if successful, otherwise and error is returned. > - > -.SH ERRORS > -.TP > -CS_ERR_BAD_HANDLE > -health checking is not in running state (\fBsam_start(3)\fR has not been > -executed) or function is called after stop/finalization of SAM. > - > -.SH "SEE ALSO" > -.BR sam_start (3), > -.BR sam_stop (3), > -.BR sam_hc_callback_register (3) > diff --git a/man/sam_hc_send.3.in b/man/sam_hc_send.3.in > new file mode 100644 > index 0000000..c8e9131 > --- /dev/null > +++ b/man/sam_hc_send.3.in > @@ -0,0 +1,68 @@ > +.\"/* > +.\" * Copyright (c) 2009 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "SAM_HC_SEND" 3 "12/01/2009" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +sam_hc_send \- Send health check confirmation > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/sam.h>\fR > + > +.P > +\fBcs_error_t sam_hc_send (void);\fR > + > +.SH DESCRIPTION > +.P > +The \fBsam_hc_send\fR function is used to send healthcheck confirmation from > +the applicatoin. This function should be called reguarly when configured for > +application driven healthchecking, otherwise recovery actoin will be taken. > + > +When using event driven healthchecking, this function should not be used. > + > +.SH RETURN VALUE > +.P > +This call return CS_OK value if successful, otherwise and error is returned. > + > +.SH ERRORS > +.TP > +CS_ERR_BAD_HANDLE > +health checking is not in running state (\fBsam_start(3)\fR has not been > +executed) or function is called after stop/finalization of SAM. > + > +.SH "SEE ALSO" > +.BR sam_start (3), > +.BR sam_stop (3), > +.BR sam_hc_callback_register (3) > diff --git a/man/sam_initialize.3 b/man/sam_initialize.3 > deleted file mode 100644 > index 5a3334f..0000000 > --- a/man/sam_initialize.3 > +++ /dev/null > @@ -1,123 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009-2010 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "SAM_INITIALIZE" 3 "21/05/2010" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -sam_initialize \- Initialize health checking > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/sam.h>\fR > - > -.P > -\fBcs_error_t sam_initialize (int\fR \fItime_interval\fR\fB, sam_recovery_policy_t \fIrecovery_policy\fR);\fR > - > -.SH DESCRIPTION > -.P > -The \fBsam_initialize\fR function is used to initialize health checking of a process. > - > -.P > -Application can have only one instance of SAM. This function must be called > -before any other of SAM functions. It is recommended to initialize before the > -process begins any process initialization. > - > -.P > -The \fItime_interval\fR parameter is a timeout in milliseconds before taking > -recovery action after having not received a healthcheck. > - > -If \fItime_interval\fR parameter is zero, there is no time limit and no > -healthcheck must be sent by the process. In this operational mode, a process > -failure will continue to execute the recovery policy. > - > -.P > -The \fIrecovery_policy\fR is defined as type: > - > -.nf > - typedef enum { > - SAM_RECOVERY_POLICY_QUIT = 1, > - SAM_RECOVERY_POLICY_RESTART = 2, > - SAM_RECOVERY_POLICY_QUORUM = 0x08, > - SAM_RECOVERY_POLICY_QUORUM_QUIT = SAM_RECOVERY_POLICY_QUORUM | SAM_RECOVERY_POLICY_QUIT, > - SAM_RECOVERY_POLICY_QUORUM_RESTART = SAM_RECOVERY_POLICY_QUORUM | SAM_RECOVERY_POLICY_RESTART, > - SAM_RECOVERY_POLICY_CONFDB = 0x10, > - } sam_recovery_policy_t; > -.fi > - > -.P > -where > - > -.TP > -SAM_RECOVERY_POLICY_QUIT > -on failure, the process will terminate. > -.TP > -SAM_RECOVERY_POLICY_RESTART > -on failure, the process will restart. > -.TP > -SAM_RECOVERY_POLICY_QUORUM > -is not policy. Used only as flag meaning quorum integration > -.TP > -SAM_RECOVERY_POLICY_QUORUM_QUIT > -same as \fISAM_RECOVERY_POLICY_QUIT\fR but \fBsam_start (3)\fR will block until corosync becomes > -quorate and process will be terminated if quorum is lost. > -.TP > -SAM_RECOVERY_POLICY_QUORUM_RESTART > -same as \fISAM_RECOVERY_POLICY_RESTART\fR but \fBsam_start (3)\fR will block until corosync becomes > -quorate and process will be restarted if quorum is lost. > -.TP > -SAM_RECOVERY_POLICY_CONFDB > -is not policy. Used only as flag meaning confdb integration. It can be used with all previous policies. > - > -.P > -To perform event driven healthchecking, \fBsam_register(3)\fR and > -\fBsam_start(3)\fR functions must called. Event driven healthchecking causes > -the duplicate standby process running the SAM serve rto periodically request > -healthchecks from the active process. > - > -.SH RETURN VALUE > -.P > -This call return CS_OK value if successful, otherwise and error is returned. > - > -.SH ERRORS > -.TP > -CS_ERR_BAD_HANDLE > -can happened in case of double initialization. > -.TP > -CS_ERR_INVALID_PARAM > -\fIrecovery_policy\fR has invalid value. > - > -.SH "SEE ALSO" > -.BR sam_register (3), > -.BR sam_start (3), > -.BR sam_hc_callback_register (3) > diff --git a/man/sam_initialize.3.in b/man/sam_initialize.3.in > new file mode 100644 > index 0000000..5a3334f > --- /dev/null > +++ b/man/sam_initialize.3.in > @@ -0,0 +1,123 @@ > +.\"/* > +.\" * Copyright (c) 2009-2010 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "SAM_INITIALIZE" 3 "21/05/2010" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +sam_initialize \- Initialize health checking > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/sam.h>\fR > + > +.P > +\fBcs_error_t sam_initialize (int\fR \fItime_interval\fR\fB, sam_recovery_policy_t \fIrecovery_policy\fR);\fR > + > +.SH DESCRIPTION > +.P > +The \fBsam_initialize\fR function is used to initialize health checking of a process. > + > +.P > +Application can have only one instance of SAM. This function must be called > +before any other of SAM functions. It is recommended to initialize before the > +process begins any process initialization. > + > +.P > +The \fItime_interval\fR parameter is a timeout in milliseconds before taking > +recovery action after having not received a healthcheck. > + > +If \fItime_interval\fR parameter is zero, there is no time limit and no > +healthcheck must be sent by the process. In this operational mode, a process > +failure will continue to execute the recovery policy. > + > +.P > +The \fIrecovery_policy\fR is defined as type: > + > +.nf > + typedef enum { > + SAM_RECOVERY_POLICY_QUIT = 1, > + SAM_RECOVERY_POLICY_RESTART = 2, > + SAM_RECOVERY_POLICY_QUORUM = 0x08, > + SAM_RECOVERY_POLICY_QUORUM_QUIT = SAM_RECOVERY_POLICY_QUORUM | SAM_RECOVERY_POLICY_QUIT, > + SAM_RECOVERY_POLICY_QUORUM_RESTART = SAM_RECOVERY_POLICY_QUORUM | SAM_RECOVERY_POLICY_RESTART, > + SAM_RECOVERY_POLICY_CONFDB = 0x10, > + } sam_recovery_policy_t; > +.fi > + > +.P > +where > + > +.TP > +SAM_RECOVERY_POLICY_QUIT > +on failure, the process will terminate. > +.TP > +SAM_RECOVERY_POLICY_RESTART > +on failure, the process will restart. > +.TP > +SAM_RECOVERY_POLICY_QUORUM > +is not policy. Used only as flag meaning quorum integration > +.TP > +SAM_RECOVERY_POLICY_QUORUM_QUIT > +same as \fISAM_RECOVERY_POLICY_QUIT\fR but \fBsam_start (3)\fR will block until corosync becomes > +quorate and process will be terminated if quorum is lost. > +.TP > +SAM_RECOVERY_POLICY_QUORUM_RESTART > +same as \fISAM_RECOVERY_POLICY_RESTART\fR but \fBsam_start (3)\fR will block until corosync becomes > +quorate and process will be restarted if quorum is lost. > +.TP > +SAM_RECOVERY_POLICY_CONFDB > +is not policy. Used only as flag meaning confdb integration. It can be used with all previous policies. > + > +.P > +To perform event driven healthchecking, \fBsam_register(3)\fR and > +\fBsam_start(3)\fR functions must called. Event driven healthchecking causes > +the duplicate standby process running the SAM serve rto periodically request > +healthchecks from the active process. > + > +.SH RETURN VALUE > +.P > +This call return CS_OK value if successful, otherwise and error is returned. > + > +.SH ERRORS > +.TP > +CS_ERR_BAD_HANDLE > +can happened in case of double initialization. > +.TP > +CS_ERR_INVALID_PARAM > +\fIrecovery_policy\fR has invalid value. > + > +.SH "SEE ALSO" > +.BR sam_register (3), > +.BR sam_start (3), > +.BR sam_hc_callback_register (3) > diff --git a/man/sam_mark_failed.3 b/man/sam_mark_failed.3 > deleted file mode 100644 > index dabe2da..0000000 > --- a/man/sam_mark_failed.3 > +++ /dev/null > @@ -1,73 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2010 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "SAM_STOP" 3 "21/05/2010" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -sam_mark_failed \- Mark process failed > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/sam.h>\fR > - > -.P > -\fBcs_error_t sam_mark_failed (void);\fR > - > -.SH DESCRIPTION > -.P > -The \fBsam_mark_failed\fR function is used with SAM_RECOVERY_POLICY_CONFDB mostly > -together with SAM_RECOVERY_POLICY_RESTART to mark process failed. Process marked > -failed is killed without sending warn signal and control process will exit > -as with SAM_RECOVERY_POLICY_QUIT policy. Condb key state will be set to failed so > -corosync watchdog can take required action. > - > -.SH RETURN VALUE > -.P > -This call return CS_OK value if successful, otherwise and error is returned. > - > -.SH ERRORS > -.TP > -CS_ERR_BAD_HANDLE > -library was not initialized by calling \fBsam_initialize(3)\fR or was already finalized > - > -.TP > -CS_ERR_INVALID_PARAM > -recovery policy doesn't has SAM_RECOVERY_POLICY_CONFDB flag set > - > -.TP > -CS_ERR_LIBRARY > -some internal error appeared (communication with parent process) > - > -.SH "SEE ALSO" > -.BR sam_initialize (3) > diff --git a/man/sam_mark_failed.3.in b/man/sam_mark_failed.3.in > new file mode 100644 > index 0000000..dabe2da > --- /dev/null > +++ b/man/sam_mark_failed.3.in > @@ -0,0 +1,73 @@ > +.\"/* > +.\" * Copyright (c) 2010 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "SAM_STOP" 3 "21/05/2010" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +sam_mark_failed \- Mark process failed > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/sam.h>\fR > + > +.P > +\fBcs_error_t sam_mark_failed (void);\fR > + > +.SH DESCRIPTION > +.P > +The \fBsam_mark_failed\fR function is used with SAM_RECOVERY_POLICY_CONFDB mostly > +together with SAM_RECOVERY_POLICY_RESTART to mark process failed. Process marked > +failed is killed without sending warn signal and control process will exit > +as with SAM_RECOVERY_POLICY_QUIT policy. Condb key state will be set to failed so > +corosync watchdog can take required action. > + > +.SH RETURN VALUE > +.P > +This call return CS_OK value if successful, otherwise and error is returned. > + > +.SH ERRORS > +.TP > +CS_ERR_BAD_HANDLE > +library was not initialized by calling \fBsam_initialize(3)\fR or was already finalized > + > +.TP > +CS_ERR_INVALID_PARAM > +recovery policy doesn't has SAM_RECOVERY_POLICY_CONFDB flag set > + > +.TP > +CS_ERR_LIBRARY > +some internal error appeared (communication with parent process) > + > +.SH "SEE ALSO" > +.BR sam_initialize (3) > diff --git a/man/sam_register.3 b/man/sam_register.3 > deleted file mode 100644 > index 2af86d2..0000000 > --- a/man/sam_register.3 > +++ /dev/null > @@ -1,88 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "SAM_REGISTER" 3 "12/01/2009" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -sam_rehister \- Register component for health checking > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/sam.h>\fR > - > -.P > -\fBcs_error_t sam_register (unsigned int *\fIinstance_id\fR);\fR > - > -.SH DESCRIPTION > -.P > -The \fBsam_register\fR function is used to register a process for healthchecking. > -If recovery policy is set to \fISAM_RECOVERY_POLICY_RESTART\fR and recovery > -action will be taken, the new process instance will begin execution at the next > -code line after this function is called. > - > -.P > -This function can be called only once and SAM must be initialized by > -\fBsam_initialize(3)\fR function. > - > -.P > -The \fIinstance_id\fR argument is a pointer to a value storing the current > -iteration instance. If this parameter is NULL, no \fIinstance_id\fR is returned. > -and then, no \fIinstance_id\fR will be returned. This value starts at 0 for the > -first iteration instance, and increases by 1 each time a recovery restart is > -executed. After reaching MAX_INT, the instance_id will reset to 0. > - > -.P > -The placement of this function is important because after it is called, the > -process id will change. > - > -.P > -After registration, event driven health checking is not running. > - > -.SH RETURN VALUE > -.P > -This call return CS_OK value if successful, otherwise and error is returned. > - > -.SH ERRORS > -.TP > -CS_ERR_BAD_HANDLE > -health checking was not started by calling \fBsam_start(3)\fR function. > -.TP > -CS_ERR_LIBRARY > -internal library call failed. This can be one of pipe creation or fork. > -It's possible to get more information from errno. > - > -.SH "SEE ALSO" > -.BR sam_start (3), > -.BR sam_initialize (3), > -.BR sam_hc_callback_register (3) > diff --git a/man/sam_register.3.in b/man/sam_register.3.in > new file mode 100644 > index 0000000..2af86d2 > --- /dev/null > +++ b/man/sam_register.3.in > @@ -0,0 +1,88 @@ > +.\"/* > +.\" * Copyright (c) 2009 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "SAM_REGISTER" 3 "12/01/2009" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +sam_rehister \- Register component for health checking > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/sam.h>\fR > + > +.P > +\fBcs_error_t sam_register (unsigned int *\fIinstance_id\fR);\fR > + > +.SH DESCRIPTION > +.P > +The \fBsam_register\fR function is used to register a process for healthchecking. > +If recovery policy is set to \fISAM_RECOVERY_POLICY_RESTART\fR and recovery > +action will be taken, the new process instance will begin execution at the next > +code line after this function is called. > + > +.P > +This function can be called only once and SAM must be initialized by > +\fBsam_initialize(3)\fR function. > + > +.P > +The \fIinstance_id\fR argument is a pointer to a value storing the current > +iteration instance. If this parameter is NULL, no \fIinstance_id\fR is returned. > +and then, no \fIinstance_id\fR will be returned. This value starts at 0 for the > +first iteration instance, and increases by 1 each time a recovery restart is > +executed. After reaching MAX_INT, the instance_id will reset to 0. > + > +.P > +The placement of this function is important because after it is called, the > +process id will change. > + > +.P > +After registration, event driven health checking is not running. > + > +.SH RETURN VALUE > +.P > +This call return CS_OK value if successful, otherwise and error is returned. > + > +.SH ERRORS > +.TP > +CS_ERR_BAD_HANDLE > +health checking was not started by calling \fBsam_start(3)\fR function. > +.TP > +CS_ERR_LIBRARY > +internal library call failed. This can be one of pipe creation or fork. > +It's possible to get more information from errno. > + > +.SH "SEE ALSO" > +.BR sam_start (3), > +.BR sam_initialize (3), > +.BR sam_hc_callback_register (3) > diff --git a/man/sam_start.3 b/man/sam_start.3 > deleted file mode 100644 > index c49f230..0000000 > --- a/man/sam_start.3 > +++ /dev/null > @@ -1,83 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009-2010 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "SAM_START" 3 "30/04/2010" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -sam_start \- Start health checking > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/sam.h>\fR > - > -.P > -\fBcs_error_t sam_start (void);\fR > - > -.SH DESCRIPTION > -.P > -The \fBsam_start\fR function is used to start health checking of application. > -After calling this function, the active process needs to send healthchecks > -within the registered time interval by calling \fBsam_hc_send(3)\fR. If > -event driven healthchecking is configured by calling \fBsam_register(3)\fR, > -an internal thread will be created and send health check confirmations four > -times per \fItime_interval\fR. > - > -.P > -Application must be registered by calling \fBsam_register(3)\fR before this > -function can be called. > - > -.P > -An application can always stop health checking by calling the \fBsam_stop(3)\fR > -function. > - > -.P > -If SAM is initialized with quorum policy \fISAM_RECOVERY_POLICY_QUIT\fR or > -\fISAM_RECOVERY_POLICY_RESTART\fR \fBsam_start\fR will block until corosync > -becomes quorate. > - > -.SH RETURN VALUE > -.P > -This call return CS_OK value if successful, otherwise and error is returned. If > -SAM is initialized with quorum policy, returned error can also be quorum error. > - > -.SH ERRORS > -.TP > -CS_ERR_BAD_HANDLE > -component was not registered by calling \fBsam_register(3)\fR function. > - > -.SH "SEE ALSO" > -.BR sam_hc_send (3), > -.BR sam_stop (3), > -.BR sam_register (3), > -.BR sam_hc_callback_register (3) > diff --git a/man/sam_start.3.in b/man/sam_start.3.in > new file mode 100644 > index 0000000..c49f230 > --- /dev/null > +++ b/man/sam_start.3.in > @@ -0,0 +1,83 @@ > +.\"/* > +.\" * Copyright (c) 2009-2010 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "SAM_START" 3 "30/04/2010" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +sam_start \- Start health checking > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/sam.h>\fR > + > +.P > +\fBcs_error_t sam_start (void);\fR > + > +.SH DESCRIPTION > +.P > +The \fBsam_start\fR function is used to start health checking of application. > +After calling this function, the active process needs to send healthchecks > +within the registered time interval by calling \fBsam_hc_send(3)\fR. If > +event driven healthchecking is configured by calling \fBsam_register(3)\fR, > +an internal thread will be created and send health check confirmations four > +times per \fItime_interval\fR. > + > +.P > +Application must be registered by calling \fBsam_register(3)\fR before this > +function can be called. > + > +.P > +An application can always stop health checking by calling the \fBsam_stop(3)\fR > +function. > + > +.P > +If SAM is initialized with quorum policy \fISAM_RECOVERY_POLICY_QUIT\fR or > +\fISAM_RECOVERY_POLICY_RESTART\fR \fBsam_start\fR will block until corosync > +becomes quorate. > + > +.SH RETURN VALUE > +.P > +This call return CS_OK value if successful, otherwise and error is returned. If > +SAM is initialized with quorum policy, returned error can also be quorum error. > + > +.SH ERRORS > +.TP > +CS_ERR_BAD_HANDLE > +component was not registered by calling \fBsam_register(3)\fR function. > + > +.SH "SEE ALSO" > +.BR sam_hc_send (3), > +.BR sam_stop (3), > +.BR sam_register (3), > +.BR sam_hc_callback_register (3) > diff --git a/man/sam_stop.3 b/man/sam_stop.3 > deleted file mode 100644 > index 708d079..0000000 > --- a/man/sam_stop.3 > +++ /dev/null > @@ -1,67 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "SAM_STOP" 3 "12/01/2009" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -sam_stop \- Stop health checking > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/sam.h>\fR > - > -.P > -\fBcs_error_t sam_stop (void);\fR > - > -.SH DESCRIPTION > -.P > -The \fBsam_stop\fR function is used to stop health checking of an active > -process. After calling this function, the application no longer should send > -helathchecks. In the case of event driven healthchecking, the healthchecking > -thread will be stopped. > - > -.P > -A process can always start health checking again by calling \fBsam_start(3)\fR function. > - > -.SH RETURN VALUE > -.P > -This call return CS_OK value if successful, otherwise and error is returned. > - > -.SH ERRORS > -.TP > -CS_ERR_BAD_HANDLE > -health checking was not started by calling \fBsam_start(3)\fR function. > - > -.SH "SEE ALSO" > -.BR sam_start (3) > diff --git a/man/sam_stop.3.in b/man/sam_stop.3.in > new file mode 100644 > index 0000000..708d079 > --- /dev/null > +++ b/man/sam_stop.3.in > @@ -0,0 +1,67 @@ > +.\"/* > +.\" * Copyright (c) 2009 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "SAM_STOP" 3 "12/01/2009" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +sam_stop \- Stop health checking > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/sam.h>\fR > + > +.P > +\fBcs_error_t sam_stop (void);\fR > + > +.SH DESCRIPTION > +.P > +The \fBsam_stop\fR function is used to stop health checking of an active > +process. After calling this function, the application no longer should send > +helathchecks. In the case of event driven healthchecking, the healthchecking > +thread will be stopped. > + > +.P > +A process can always start health checking again by calling \fBsam_start(3)\fR function. > + > +.SH RETURN VALUE > +.P > +This call return CS_OK value if successful, otherwise and error is returned. > + > +.SH ERRORS > +.TP > +CS_ERR_BAD_HANDLE > +health checking was not started by calling \fBsam_start(3)\fR function. > + > +.SH "SEE ALSO" > +.BR sam_start (3) > diff --git a/man/sam_warn_signal_set.3 b/man/sam_warn_signal_set.3 > deleted file mode 100644 > index ffc31eb..0000000 > --- a/man/sam_warn_signal_set.3 > +++ /dev/null > @@ -1,63 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2010 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the Red Hat, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH "SAM_WARN_SIGNAL_SET" 3 "03/11/2010" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > - > -.SH NAME > -.P > -sam_warn_signal_set \- Set warn signal > - > -.SH SYNOPSIS > -.P > -\fB#include <corosync/sam.h>\fR > - > -.P > -\fBcs_error_t sam_warn_signal_set (int warn_signal);\fR > - > -.SH DESCRIPTION > -.P > -The \fBsam_warn_signal_set\fR function is used to configure warning signal > -sent before real killing of unresponsive application. Default value is > -SIGTERM. SIGKILL can be used to emulate "not warning signal send" behaviour. > - > -.SH RETURN VALUE > -.P > -This call return CS_OK value if successful, otherwise and error is returned. > - > -.SH ERRORS > -.TP > -CS_ERR_BAD_HANDLE > -component was not initialized by calling \fBsam_initialize(3)\fR or it was finalized. > - > -.SH "SEE ALSO" > -.BR sam_initialize (3) > diff --git a/man/sam_warn_signal_set.3.in b/man/sam_warn_signal_set.3.in > new file mode 100644 > index 0000000..ffc31eb > --- /dev/null > +++ b/man/sam_warn_signal_set.3.in > @@ -0,0 +1,63 @@ > +.\"/* > +.\" * Copyright (c) 2010 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the Red Hat, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH "SAM_WARN_SIGNAL_SET" 3 "03/11/2010" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > + > +.SH NAME > +.P > +sam_warn_signal_set \- Set warn signal > + > +.SH SYNOPSIS > +.P > +\fB#include <corosync/sam.h>\fR > + > +.P > +\fBcs_error_t sam_warn_signal_set (int warn_signal);\fR > + > +.SH DESCRIPTION > +.P > +The \fBsam_warn_signal_set\fR function is used to configure warning signal > +sent before real killing of unresponsive application. Default value is > +SIGTERM. SIGKILL can be used to emulate "not warning signal send" behaviour. > + > +.SH RETURN VALUE > +.P > +This call return CS_OK value if successful, otherwise and error is returned. > + > +.SH ERRORS > +.TP > +CS_ERR_BAD_HANDLE > +component was not initialized by calling \fBsam_initialize(3)\fR or it was finalized. > + > +.SH "SEE ALSO" > +.BR sam_initialize (3) > diff --git a/man/votequorum_context_get.3 b/man/votequorum_context_get.3 > deleted file mode 100644 > index a8e42d0..0000000 > --- a/man/votequorum_context_get.3 > +++ /dev/null > @@ -1,58 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2007 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH VOTEQUORUM_CONTEXT_GET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -votequorum_context_get \- Gets the context variable for a VOTEQUORUM instance > -.SH SYNOPSIS > -.B #include <corosync/votequorum.h> > -.sp > -.BI "int votequorum_context_get(votequorum_handle_t " handle ", void **" context "); > -.SH DESCRIPTION > -The > -.B votequorum_context_get > -function is used to retrieve the context variable previously stored using > -.B votequorum_context_set(3) > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR votequorum_initialize (3), > -.BR votequorum_finalize (3), > -.BR votequorum_fd_get (3), > -.BR votequorum_dispatch (3), > -.BR votequorum_context_get (3), > -.BR votequorum_context_set (3), > -.PP > diff --git a/man/votequorum_context_get.3.in b/man/votequorum_context_get.3.in > new file mode 100644 > index 0000000..a8e42d0 > --- /dev/null > +++ b/man/votequorum_context_get.3.in > @@ -0,0 +1,58 @@ > +.\"/* > +.\" * Copyright (c) 2007 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH VOTEQUORUM_CONTEXT_GET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +votequorum_context_get \- Gets the context variable for a VOTEQUORUM instance > +.SH SYNOPSIS > +.B #include <corosync/votequorum.h> > +.sp > +.BI "int votequorum_context_get(votequorum_handle_t " handle ", void **" context "); > +.SH DESCRIPTION > +The > +.B votequorum_context_get > +function is used to retrieve the context variable previously stored using > +.B votequorum_context_set(3) > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR votequorum_initialize (3), > +.BR votequorum_finalize (3), > +.BR votequorum_fd_get (3), > +.BR votequorum_dispatch (3), > +.BR votequorum_context_get (3), > +.BR votequorum_context_set (3), > +.PP > diff --git a/man/votequorum_context_set.3 b/man/votequorum_context_set.3 > deleted file mode 100644 > index f8ef0af..0000000 > --- a/man/votequorum_context_set.3 > +++ /dev/null > @@ -1,60 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2007 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH VOTEQUORUM_CONTEXT_SET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -votequorum_context_set \- Sets the context variable for a VOTEQUORUM instance > -.SH SYNOPSIS > -.B #include <corosync/votequorum.h> > -.sp > -.BI "int votequorum_context_set(votequorum_handle_t " handle ", void *" context "); > -.SH DESCRIPTION > -The > -.B votequorum_context_set > -function is used to set the context variable for a votequorum instance. It has no > -meaning insire libvotequorum itself and will not be touched by the library. It can > -be retrieved using > -.B votequorum_context_get(3) > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR votequorum_initialize (3), > -.BR votequorum_finalize (3), > -.BR votequorum_fd_get (3), > -.BR votequorum_dispatch (3), > -.BR votequorum_context_get (3), > -.BR votequorum_context_set (3), > -.PP > diff --git a/man/votequorum_context_set.3.in b/man/votequorum_context_set.3.in > new file mode 100644 > index 0000000..f8ef0af > --- /dev/null > +++ b/man/votequorum_context_set.3.in > @@ -0,0 +1,60 @@ > +.\"/* > +.\" * Copyright (c) 2007 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Patrick Caulfield <pcaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH VOTEQUORUM_CONTEXT_SET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +votequorum_context_set \- Sets the context variable for a VOTEQUORUM instance > +.SH SYNOPSIS > +.B #include <corosync/votequorum.h> > +.sp > +.BI "int votequorum_context_set(votequorum_handle_t " handle ", void *" context "); > +.SH DESCRIPTION > +The > +.B votequorum_context_set > +function is used to set the context variable for a votequorum instance. It has no > +meaning insire libvotequorum itself and will not be touched by the library. It can > +be retrieved using > +.B votequorum_context_get(3) > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR votequorum_initialize (3), > +.BR votequorum_finalize (3), > +.BR votequorum_fd_get (3), > +.BR votequorum_dispatch (3), > +.BR votequorum_context_get (3), > +.BR votequorum_context_set (3), > +.PP > diff --git a/man/votequorum_dispatch.3 b/man/votequorum_dispatch.3 > deleted file mode 100644 > index 8d5f8d1..0000000 > --- a/man/votequorum_dispatch.3 > +++ /dev/null > @@ -1,100 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH VOTEQUORUM_DISPATCH 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -votequorum_dispatch \- Dispatches callbacks from the votequorum service > -.SH SYNOPSIS > -.B #include <corosync/votequorum.h> > -.sp > -.BI "int votequorum_dispatch(votequorum_handle_t " handle ", votequorum_dispatch_t *" dispatch_types ");" > -.SH DESCRIPTION > -The > -.B votequorum_dispatch > -function is used to dispatch configuration changes. > -.PP > -Each application may have several connections to the votequorum API. Each application > -uses the > -.I handle > -argument to uniquely identify the connection. > -.PP > -The > -.I dispatch_types > -argument is used to identify the type of dispatch to execute. The possible types are > -defined by the structure: > - > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 30n 33n > -typedef enum { > - CS_DISPATCH_ONE, > - CS_DISPATCH_ALL, > - CS_DISPATCH_BLOCKING > -} votequorum_dispatch_t; > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The dispatch values have the following meanings: > -.TP > -.B CS_DISPATCH_ONE > -Dispatch at least one callback, blocking until the callback is dispatched. > -.TP > -.B CS_DISPATCH_ALL > -Dispatch all waiting callbacks without blocking to wait for any callbacks. > -.TP > -.B CS_DISPATCH_BLOCKING > -Dispatch all callbacks blocking indefinitely. This is used in a threaded > -program where a thread is created, and then votequorum_dispatch() is called immediately > -from the created thread to execute callbacks. > -.TP > -.B CS_DISPATCH_ONE_NONBLOCKING > -Dispatch at most one callback. If there is no pending callback, > -CS_ERR_TRY_AGAIN is returned. > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR votequorum_overview (8), > -.BR votequorum_initialize (3), > -.BR votequorum_finalize (3), > -.BR votequorum_fd_get (3), > - > -.PP > diff --git a/man/votequorum_dispatch.3.in b/man/votequorum_dispatch.3.in > new file mode 100644 > index 0000000..8d5f8d1 > --- /dev/null > +++ b/man/votequorum_dispatch.3.in > @@ -0,0 +1,100 @@ > +.\"/* > +.\" * Copyright (c) 2009 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH VOTEQUORUM_DISPATCH 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +votequorum_dispatch \- Dispatches callbacks from the votequorum service > +.SH SYNOPSIS > +.B #include <corosync/votequorum.h> > +.sp > +.BI "int votequorum_dispatch(votequorum_handle_t " handle ", votequorum_dispatch_t *" dispatch_types ");" > +.SH DESCRIPTION > +The > +.B votequorum_dispatch > +function is used to dispatch configuration changes. > +.PP > +Each application may have several connections to the votequorum API. Each application > +uses the > +.I handle > +argument to uniquely identify the connection. > +.PP > +The > +.I dispatch_types > +argument is used to identify the type of dispatch to execute. The possible types are > +defined by the structure: > + > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 30n 33n > +typedef enum { > + CS_DISPATCH_ONE, > + CS_DISPATCH_ALL, > + CS_DISPATCH_BLOCKING > +} votequorum_dispatch_t; > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The dispatch values have the following meanings: > +.TP > +.B CS_DISPATCH_ONE > +Dispatch at least one callback, blocking until the callback is dispatched. > +.TP > +.B CS_DISPATCH_ALL > +Dispatch all waiting callbacks without blocking to wait for any callbacks. > +.TP > +.B CS_DISPATCH_BLOCKING > +Dispatch all callbacks blocking indefinitely. This is used in a threaded > +program where a thread is created, and then votequorum_dispatch() is called immediately > +from the created thread to execute callbacks. > +.TP > +.B CS_DISPATCH_ONE_NONBLOCKING > +Dispatch at most one callback. If there is no pending callback, > +CS_ERR_TRY_AGAIN is returned. > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR votequorum_overview (8), > +.BR votequorum_initialize (3), > +.BR votequorum_finalize (3), > +.BR votequorum_fd_get (3), > + > +.PP > diff --git a/man/votequorum_fd_get.3 b/man/votequorum_fd_get.3 > deleted file mode 100644 > index 2687bc3..0000000 > --- a/man/votequorum_fd_get.3 > +++ /dev/null > @@ -1,64 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH VOTEQUORUM_FD_GET 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -votequorum_fd_get \- Dispatches callbacks from the votequorum service > -.SH SYNOPSIS > -.B #include <corosync/votequorum.h> > -.sp > -.BI "int votequorum_fd_get(votequorum_handle_t " handle ", int *" fd ");" > -.SH DESCRIPTION > -The > -.B votequorum_fd_get > -function is used to retrieve the file descriptor that may be used with the poll > -system call to determine when > -.B votequorum_dispatch(3) > -won't block. The > -.I handle > -argument may not be used directly with > -.B poll > -because it is not the file descriptor, but instead an internal identifier used > -by the votequorum library. > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR votequorum_overview (8), > -.BR votequorum_initialize (3), > -.BR votequorum_finalize (3), > -.BR votequorum_dispatch (3), > -.BR votequorum_fd_get (3), > -.PP > diff --git a/man/votequorum_fd_get.3.in b/man/votequorum_fd_get.3.in > new file mode 100644 > index 0000000..2687bc3 > --- /dev/null > +++ b/man/votequorum_fd_get.3.in > @@ -0,0 +1,64 @@ > +.\"/* > +.\" * Copyright (c) 2009 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH VOTEQUORUM_FD_GET 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +votequorum_fd_get \- Dispatches callbacks from the votequorum service > +.SH SYNOPSIS > +.B #include <corosync/votequorum.h> > +.sp > +.BI "int votequorum_fd_get(votequorum_handle_t " handle ", int *" fd ");" > +.SH DESCRIPTION > +The > +.B votequorum_fd_get > +function is used to retrieve the file descriptor that may be used with the poll > +system call to determine when > +.B votequorum_dispatch(3) > +won't block. The > +.I handle > +argument may not be used directly with > +.B poll > +because it is not the file descriptor, but instead an internal identifier used > +by the votequorum library. > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR votequorum_overview (8), > +.BR votequorum_initialize (3), > +.BR votequorum_finalize (3), > +.BR votequorum_dispatch (3), > +.BR votequorum_fd_get (3), > +.PP > diff --git a/man/votequorum_finalize.3 b/man/votequorum_finalize.3 > deleted file mode 100644 > index c58aa89..0000000 > --- a/man/votequorum_finalize.3 > +++ /dev/null > @@ -1,61 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH VOTEQUORUM_FINALIZE 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -votequorum_finalize \- Terminate a connection to the votequorum service > -.SH SYNOPSIS > -.B #include <corosync/votequorum.h> > -.sp > -.BI "int votequorum_finalize(votequorum_handle_t " handle ");" > -.SH DESCRIPTION > -The > -.B votequorum_finalize > -function is used to close a connection to the configuration dabatase API. > -Once the connection is finalized, the handle may not be used again by applications. > -No more callbacks will be dispatched from the > -.B votequorum_dispatch function. > -.PP > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR votequorum_overview (8), > -.BR votequorum_initialize (3), > -.BR votequorum_finalize (3), > -.BR votequorum_dispatch (3), > -.BR votequorum_fd_get (3), > - > -.PP > diff --git a/man/votequorum_finalize.3.in b/man/votequorum_finalize.3.in > new file mode 100644 > index 0000000..c58aa89 > --- /dev/null > +++ b/man/votequorum_finalize.3.in > @@ -0,0 +1,61 @@ > +.\"/* > +.\" * Copyright (c) 2009 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH VOTEQUORUM_FINALIZE 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +votequorum_finalize \- Terminate a connection to the votequorum service > +.SH SYNOPSIS > +.B #include <corosync/votequorum.h> > +.sp > +.BI "int votequorum_finalize(votequorum_handle_t " handle ");" > +.SH DESCRIPTION > +The > +.B votequorum_finalize > +function is used to close a connection to the configuration dabatase API. > +Once the connection is finalized, the handle may not be used again by applications. > +No more callbacks will be dispatched from the > +.B votequorum_dispatch function. > +.PP > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR votequorum_overview (8), > +.BR votequorum_initialize (3), > +.BR votequorum_finalize (3), > +.BR votequorum_dispatch (3), > +.BR votequorum_fd_get (3), > + > +.PP > diff --git a/man/votequorum_getinfo.3 b/man/votequorum_getinfo.3 > deleted file mode 100644 > index 3a40104..0000000 > --- a/man/votequorum_getinfo.3 > +++ /dev/null > @@ -1,93 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH VOTEQUORUM_GETINFO 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -votequorum_getinfo \- Get information about the VoteQuorum service > -.SH SYNOPSIS > -.B #include <corosync/votequorum.h> > -.sp > -.BI "int votequorum_getinfo(votequorum_handle_t *" handle ", unsigned int " nodeid ", struct votequorum_info *" info "); > -.SH DESCRIPTION > -The > -.B votequorum_getinfo > -function is used to get information about the voteing system and its nodes. > - > -The votequorum_info structure is defined as follows: > -.PP > -.PP > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 20n 32n > - > -struct votequorum_info { > - unsigned int node_id; > - unsigned int node_votes; > - unsigned int node_expected_votes; > - unsigned int highest_expected; > - unsigned int total_votes; > - unsigned int quorum; > - unsigned int flags; > -}; > - > -#define VOTEQUORUM_INFO_FLAG_TWONODE 1 > -#define VOTEQUORUM_INFO_FLAG_QUORATE 2 > -#define VOTEQUORUM_INFO_WAIT_FOR_ALL 4 > -#define VOTEQUORUM_INFO_LAST_MAN_STANDING 8 > -#define VOTEQUORUM_INFO_AUTO_TIE_BREAKER 16 > -#define VOTEQUORUM_INFO_LEAVE_REMOVE 32 > - > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The members starting node_ hold information specific to the requested nodeid, the other are > -general to the voting system. > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH BUGS > -Callbacks are not support at the moment. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR votequorum_overview (8), > -.BR votequorum_finalize (3), > -.BR votequorum_fd_get (3), > -.BR votequorum_dispatch (3), > -.PP > diff --git a/man/votequorum_getinfo.3.in b/man/votequorum_getinfo.3.in > new file mode 100644 > index 0000000..3a40104 > --- /dev/null > +++ b/man/votequorum_getinfo.3.in > @@ -0,0 +1,93 @@ > +.\"/* > +.\" * Copyright (c) 2009 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH VOTEQUORUM_GETINFO 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +votequorum_getinfo \- Get information about the VoteQuorum service > +.SH SYNOPSIS > +.B #include <corosync/votequorum.h> > +.sp > +.BI "int votequorum_getinfo(votequorum_handle_t *" handle ", unsigned int " nodeid ", struct votequorum_info *" info "); > +.SH DESCRIPTION > +The > +.B votequorum_getinfo > +function is used to get information about the voteing system and its nodes. > + > +The votequorum_info structure is defined as follows: > +.PP > +.PP > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 20n 32n > + > +struct votequorum_info { > + unsigned int node_id; > + unsigned int node_votes; > + unsigned int node_expected_votes; > + unsigned int highest_expected; > + unsigned int total_votes; > + unsigned int quorum; > + unsigned int flags; > +}; > + > +#define VOTEQUORUM_INFO_FLAG_TWONODE 1 > +#define VOTEQUORUM_INFO_FLAG_QUORATE 2 > +#define VOTEQUORUM_INFO_WAIT_FOR_ALL 4 > +#define VOTEQUORUM_INFO_LAST_MAN_STANDING 8 > +#define VOTEQUORUM_INFO_AUTO_TIE_BREAKER 16 > +#define VOTEQUORUM_INFO_LEAVE_REMOVE 32 > + > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The members starting node_ hold information specific to the requested nodeid, the other are > +general to the voting system. > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH BUGS > +Callbacks are not support at the moment. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR votequorum_overview (8), > +.BR votequorum_finalize (3), > +.BR votequorum_fd_get (3), > +.BR votequorum_dispatch (3), > +.PP > diff --git a/man/votequorum_initialize.3 b/man/votequorum_initialize.3 > deleted file mode 100644 > index 55548eb..0000000 > --- a/man/votequorum_initialize.3 > +++ /dev/null > @@ -1,106 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH VOTEQUORUM_INITIALIZE 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -votequorum_initialize \- Create a new connection to the VoteQuorum service > -.SH SYNOPSIS > -.B #include <corosync/votequorum.h> > -.sp > -.BI "int votequorum_initialize(votequorum_handle_t *" handle ", votequorum_callbacks_t *" callbacks "); > -.SH DESCRIPTION > -The > -.B votequorum_initialize > -function is used to initialize a connection to the vote-based quorum database API. > -.PP > -Each application may have several connections to the votequorum API. Each application > -uses the > -.I handle > -argument to uniquely identify the connection. The > -.I handle > -argument is then used in other function calls to identify the connection to be used > -for communication with the votequorum service. > -.PP > -Every time the voting configuraton changes (eg a node joins or leave the cluster), the callback is called. > -The callback function is described by the following type definitions: > - > -typedef void (*votequorum_notification_fn_t) ( > - votequorum_handle_t handle, > - uint64_t context, > - uint32_t quorate, > - uint32_t node_list_entries, > - votequorum_node_t node_list[] > - ); > - > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > -The > -.I callbacks > -argument is of the type: > -.IP > -.RS > -.ne 18 > -.nf > -.PP > -typedef struct { > - votequorum_notification_fn_t votequorum_notify_fn; > -} votequorum_callbacks_t; > - > -.ta > -.fi > -.RE > -.IP > -.PP > -When a configuration change occurs, the callback > -is called from the > -.B votequorum_dispatch() > -function. > -.PP > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH BUGS > -Callbacks are not support at the moment. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR votequorum_overview (8), > -.BR votequorum_finalize (3), > -.BR votequorum_fd_get (3), > -.BR votequorum_dispatch (3), > -.PP > diff --git a/man/votequorum_initialize.3.in b/man/votequorum_initialize.3.in > new file mode 100644 > index 0000000..55548eb > --- /dev/null > +++ b/man/votequorum_initialize.3.in > @@ -0,0 +1,106 @@ > +.\"/* > +.\" * Copyright (c) 2009 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH VOTEQUORUM_INITIALIZE 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +votequorum_initialize \- Create a new connection to the VoteQuorum service > +.SH SYNOPSIS > +.B #include <corosync/votequorum.h> > +.sp > +.BI "int votequorum_initialize(votequorum_handle_t *" handle ", votequorum_callbacks_t *" callbacks "); > +.SH DESCRIPTION > +The > +.B votequorum_initialize > +function is used to initialize a connection to the vote-based quorum database API. > +.PP > +Each application may have several connections to the votequorum API. Each application > +uses the > +.I handle > +argument to uniquely identify the connection. The > +.I handle > +argument is then used in other function calls to identify the connection to be used > +for communication with the votequorum service. > +.PP > +Every time the voting configuraton changes (eg a node joins or leave the cluster), the callback is called. > +The callback function is described by the following type definitions: > + > +typedef void (*votequorum_notification_fn_t) ( > + votequorum_handle_t handle, > + uint64_t context, > + uint32_t quorate, > + uint32_t node_list_entries, > + votequorum_node_t node_list[] > + ); > + > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > +The > +.I callbacks > +argument is of the type: > +.IP > +.RS > +.ne 18 > +.nf > +.PP > +typedef struct { > + votequorum_notification_fn_t votequorum_notify_fn; > +} votequorum_callbacks_t; > + > +.ta > +.fi > +.RE > +.IP > +.PP > +When a configuration change occurs, the callback > +is called from the > +.B votequorum_dispatch() > +function. > +.PP > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH BUGS > +Callbacks are not support at the moment. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR votequorum_overview (8), > +.BR votequorum_finalize (3), > +.BR votequorum_fd_get (3), > +.BR votequorum_dispatch (3), > +.PP > diff --git a/man/votequorum_qdevice_getinfo.3 b/man/votequorum_qdevice_getinfo.3 > deleted file mode 100644 > index 90b5b51..0000000 > --- a/man/votequorum_qdevice_getinfo.3 > +++ /dev/null > @@ -1,80 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009,2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH VOTEQUORUM_QDEVICE_GETINFO 3 2012-01-27 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -votequorum_qdevice_getinfo \- Get details of the quorum device > -.SH SYNOPSIS > -.B #include <corosync/votequorum.h> > -.sp > -.BI "int votequorum_qdevice_getinfo(votequorum_handle_t " handle ", struct votequorum_qdevice_info " *info ");" > -.SH DESCRIPTION > -The > -.B votequorum_qdevice_getinfo > -Returns information about the quorum device in the following structure: > -.PP > -.PP > -.IP > -.RS > -.ne 18 > -.nf > -.ta 4n 20n 32n > - > -struct votequorum_qdevice_info { > - unsigned int votes; > - unsigned int state; > - char name[VOTEQUORUM_MAX_QDEVICE_NAME_LEN]; > -}; > - > -.ta > -.fi > -.RE > -.IP > -.PP > -.PP > - > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR votequorum_overview (8), > -.BR votequorum_initialize (3), > -.BR votequorum_finalize (3), > -.BR votequorum_dispatch (3), > -.BR votequorum_fd_get (3), > -.BR votequorum_qdevice_poll (3), > -.BR votequorum_qdevice_unregister (3), > -.BR votequorum_qdevice_getinfo (3), > -.PP > diff --git a/man/votequorum_qdevice_getinfo.3.in b/man/votequorum_qdevice_getinfo.3.in > new file mode 100644 > index 0000000..90b5b51 > --- /dev/null > +++ b/man/votequorum_qdevice_getinfo.3.in > @@ -0,0 +1,80 @@ > +.\"/* > +.\" * Copyright (c) 2009,2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH VOTEQUORUM_QDEVICE_GETINFO 3 2012-01-27 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +votequorum_qdevice_getinfo \- Get details of the quorum device > +.SH SYNOPSIS > +.B #include <corosync/votequorum.h> > +.sp > +.BI "int votequorum_qdevice_getinfo(votequorum_handle_t " handle ", struct votequorum_qdevice_info " *info ");" > +.SH DESCRIPTION > +The > +.B votequorum_qdevice_getinfo > +Returns information about the quorum device in the following structure: > +.PP > +.PP > +.IP > +.RS > +.ne 18 > +.nf > +.ta 4n 20n 32n > + > +struct votequorum_qdevice_info { > + unsigned int votes; > + unsigned int state; > + char name[VOTEQUORUM_MAX_QDEVICE_NAME_LEN]; > +}; > + > +.ta > +.fi > +.RE > +.IP > +.PP > +.PP > + > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR votequorum_overview (8), > +.BR votequorum_initialize (3), > +.BR votequorum_finalize (3), > +.BR votequorum_dispatch (3), > +.BR votequorum_fd_get (3), > +.BR votequorum_qdevice_poll (3), > +.BR votequorum_qdevice_unregister (3), > +.BR votequorum_qdevice_getinfo (3), > +.PP > diff --git a/man/votequorum_qdevice_poll.3 b/man/votequorum_qdevice_poll.3 > deleted file mode 100644 > index 12030a6..0000000 > --- a/man/votequorum_qdevice_poll.3 > +++ /dev/null > @@ -1,69 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009,2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH VOTEQUORUM_QDEVICE_POLL 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -votequorum_qdevice_poll \- Tells votequorum the result of the quorum device poll > -.SH SYNOPSIS > -.B #include <corosync/votequorum.h> > -.sp > -.BI "int votequorum_qdevice_poll(votequorum_handle_t " handle ", unsigned int " state ");" > -.SH DESCRIPTION > -The > -.B votequorum_qdevice_poll > -is called by the quorum device subsystem (not provided as part of votequorum) to tell > -the voting system if the qurum device is present/active or not. If > -.B state > -is 1 then the votes for the device are included in the quorum calculation, otherwise not. > -This routine should be called at regular intervals to ensure that the device status > -is always known to votequorum. If > -.B votequorum_qdevice_poll > -is not called after (default) 10 seconds then the device will be deeded to be dead and > -its votes removed from the cluster. This does not unregister the device. > -The default poll time can be changed by setting the object database variable > -quorum.quorumdev_poll. > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR votequorum_overview (8), > -.BR votequorum_initialize (3), > -.BR votequorum_finalize (3), > -.BR votequorum_dispatch (3), > -.BR votequorum_fd_get (3), > -.BR votequorum_qdevice_register (3), > -.BR votequorum_qdevice_unregister (3), > -.BR votequorum_qdevice_getinfo (3), > -.PP > diff --git a/man/votequorum_qdevice_poll.3.in b/man/votequorum_qdevice_poll.3.in > new file mode 100644 > index 0000000..12030a6 > --- /dev/null > +++ b/man/votequorum_qdevice_poll.3.in > @@ -0,0 +1,69 @@ > +.\"/* > +.\" * Copyright (c) 2009,2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH VOTEQUORUM_QDEVICE_POLL 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +votequorum_qdevice_poll \- Tells votequorum the result of the quorum device poll > +.SH SYNOPSIS > +.B #include <corosync/votequorum.h> > +.sp > +.BI "int votequorum_qdevice_poll(votequorum_handle_t " handle ", unsigned int " state ");" > +.SH DESCRIPTION > +The > +.B votequorum_qdevice_poll > +is called by the quorum device subsystem (not provided as part of votequorum) to tell > +the voting system if the qurum device is present/active or not. If > +.B state > +is 1 then the votes for the device are included in the quorum calculation, otherwise not. > +This routine should be called at regular intervals to ensure that the device status > +is always known to votequorum. If > +.B votequorum_qdevice_poll > +is not called after (default) 10 seconds then the device will be deeded to be dead and > +its votes removed from the cluster. This does not unregister the device. > +The default poll time can be changed by setting the object database variable > +quorum.quorumdev_poll. > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR votequorum_overview (8), > +.BR votequorum_initialize (3), > +.BR votequorum_finalize (3), > +.BR votequorum_dispatch (3), > +.BR votequorum_fd_get (3), > +.BR votequorum_qdevice_register (3), > +.BR votequorum_qdevice_unregister (3), > +.BR votequorum_qdevice_getinfo (3), > +.PP > diff --git a/man/votequorum_qdevice_register.3 b/man/votequorum_qdevice_register.3 > deleted file mode 100644 > index a8704fd..0000000 > --- a/man/votequorum_qdevice_register.3 > +++ /dev/null > @@ -1,68 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009,2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH VOTEQUORUM_QDEVICE_REGISTER 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -votequorum_qdevice_register \- Registers a new quorum device > -.SH SYNOPSIS > -.B #include <corosync/votequorum.h> > -.sp > -.BI "int votequorum_qdevice_register(votequorum_handle_t " handle ", char * " name ", unsigned int " votes ");" > -.SH DESCRIPTION > -The > -.B votequorum_qdevice_register > -is used to register a new quorum device. A quorum device is an external way of adding votes to a small > -cluster. The quorum device is, in effect, a pseudo node in the cluster that provide votes based on some > -external device, usually a shared disk partition or perhaps a network router. > -.br > -This call creates the device but does not mark it active. > -.B votequorum_qdevice_poll > -must be called for the votes to be included in the quorum calculation. > -.br > -Note that it is the responsibility of the quorum device subsystem (not provided as part of votequorum) > -to keep all nodes informed of the quorum device status. > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR votequorum_overview (8), > -.BR votequorum_initialize (3), > -.BR votequorum_finalize (3), > -.BR votequorum_dispatch (3), > -.BR votequorum_fd_get (3), > -.BR votequorum_qdevice_poll (3), > -.BR votequorum_qdevice_unregister (3), > -.BR votequorum_qdevice_getinfo (3), > -.PP > diff --git a/man/votequorum_qdevice_register.3.in b/man/votequorum_qdevice_register.3.in > new file mode 100644 > index 0000000..a8704fd > --- /dev/null > +++ b/man/votequorum_qdevice_register.3.in > @@ -0,0 +1,68 @@ > +.\"/* > +.\" * Copyright (c) 2009,2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH VOTEQUORUM_QDEVICE_REGISTER 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +votequorum_qdevice_register \- Registers a new quorum device > +.SH SYNOPSIS > +.B #include <corosync/votequorum.h> > +.sp > +.BI "int votequorum_qdevice_register(votequorum_handle_t " handle ", char * " name ", unsigned int " votes ");" > +.SH DESCRIPTION > +The > +.B votequorum_qdevice_register > +is used to register a new quorum device. A quorum device is an external way of adding votes to a small > +cluster. The quorum device is, in effect, a pseudo node in the cluster that provide votes based on some > +external device, usually a shared disk partition or perhaps a network router. > +.br > +This call creates the device but does not mark it active. > +.B votequorum_qdevice_poll > +must be called for the votes to be included in the quorum calculation. > +.br > +Note that it is the responsibility of the quorum device subsystem (not provided as part of votequorum) > +to keep all nodes informed of the quorum device status. > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR votequorum_overview (8), > +.BR votequorum_initialize (3), > +.BR votequorum_finalize (3), > +.BR votequorum_dispatch (3), > +.BR votequorum_fd_get (3), > +.BR votequorum_qdevice_poll (3), > +.BR votequorum_qdevice_unregister (3), > +.BR votequorum_qdevice_getinfo (3), > +.PP > diff --git a/man/votequorum_qdevice_unregister.3 b/man/votequorum_qdevice_unregister.3 > deleted file mode 100644 > index 4c72192..0000000 > --- a/man/votequorum_qdevice_unregister.3 > +++ /dev/null > @@ -1,60 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009,2012 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH VOTEQUORUM_QDEVICE_UNREGISTER 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -votequorum_qdevice_unregister \- Unregisters a new quorum device > -.SH SYNOPSIS > -.B #include <corosync/votequorum.h> > -.sp > -.BI "int votequorum_qdevice_unregister(votequorum_handle_t " handle ");" > -.SH DESCRIPTION > -The > -.B votequorum_qdevice_unregister > -unregisters a quorum device. Any votes it had will be removed from the cluster. Not that this could > -make the cluster inquorate. > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR votequorum_overview (8), > -.BR votequorum_initialize (3), > -.BR votequorum_finalize (3), > -.BR votequorum_dispatch (3), > -.BR votequorum_fd_get (3), > -.BR votequorum_qdevice_poll (3), > -.BR votequorum_qdevice_register (3), > -.BR votequorum_qdevice_getinfo (3), > -.PP > diff --git a/man/votequorum_qdevice_unregister.3.in b/man/votequorum_qdevice_unregister.3.in > new file mode 100644 > index 0000000..4c72192 > --- /dev/null > +++ b/man/votequorum_qdevice_unregister.3.in > @@ -0,0 +1,60 @@ > +.\"/* > +.\" * Copyright (c) 2009,2012 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH VOTEQUORUM_QDEVICE_UNREGISTER 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +votequorum_qdevice_unregister \- Unregisters a new quorum device > +.SH SYNOPSIS > +.B #include <corosync/votequorum.h> > +.sp > +.BI "int votequorum_qdevice_unregister(votequorum_handle_t " handle ");" > +.SH DESCRIPTION > +The > +.B votequorum_qdevice_unregister > +unregisters a quorum device. Any votes it had will be removed from the cluster. Not that this could > +make the cluster inquorate. > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR votequorum_overview (8), > +.BR votequorum_initialize (3), > +.BR votequorum_finalize (3), > +.BR votequorum_dispatch (3), > +.BR votequorum_fd_get (3), > +.BR votequorum_qdevice_poll (3), > +.BR votequorum_qdevice_register (3), > +.BR votequorum_qdevice_getinfo (3), > +.PP > diff --git a/man/votequorum_setexpected.3 b/man/votequorum_setexpected.3 > deleted file mode 100644 > index d33a6c9..0000000 > --- a/man/votequorum_setexpected.3 > +++ /dev/null > @@ -1,60 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH VOTEQUORUM_SETEXPECTED 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -votequorum_setexpected \- Sets the expected votes for the cluster > -.SH SYNOPSIS > -.B #include <corosync/votequorum.h> > -.sp > -.BI "int votequorum_setexpected(votequorum_handle_t " handle ", int " expected_votes ");" > -.SH DESCRIPTION > -The > -.B votequorum_setexpected > -function is used to change the expected votes in the cluster. Expected votes is used to calculate > -quorum and should normally be the total number of votes that will exist when all the expected nodes > -are joined. Quorum will usually be half of this (rounded up). > -.br > -It is not possible to set expected votes up so that it makes the cluster inquorate using this command. > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR votequorum_overview (8), > -.BR votequorum_initialize (3), > -.BR votequorum_finalize (3), > -.BR votequorum_dispatch (3), > -.BR votequorum_fd_get (3), > -.PP > diff --git a/man/votequorum_setexpected.3.in b/man/votequorum_setexpected.3.in > new file mode 100644 > index 0000000..d33a6c9 > --- /dev/null > +++ b/man/votequorum_setexpected.3.in > @@ -0,0 +1,60 @@ > +.\"/* > +.\" * Copyright (c) 2009 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH VOTEQUORUM_SETEXPECTED 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +votequorum_setexpected \- Sets the expected votes for the cluster > +.SH SYNOPSIS > +.B #include <corosync/votequorum.h> > +.sp > +.BI "int votequorum_setexpected(votequorum_handle_t " handle ", int " expected_votes ");" > +.SH DESCRIPTION > +The > +.B votequorum_setexpected > +function is used to change the expected votes in the cluster. Expected votes is used to calculate > +quorum and should normally be the total number of votes that will exist when all the expected nodes > +are joined. Quorum will usually be half of this (rounded up). > +.br > +It is not possible to set expected votes up so that it makes the cluster inquorate using this command. > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR votequorum_overview (8), > +.BR votequorum_initialize (3), > +.BR votequorum_finalize (3), > +.BR votequorum_dispatch (3), > +.BR votequorum_fd_get (3), > +.PP > diff --git a/man/votequorum_setvotes.3 b/man/votequorum_setvotes.3 > deleted file mode 100644 > index 4fed319..0000000 > --- a/man/votequorum_setvotes.3 > +++ /dev/null > @@ -1,57 +0,0 @@ > -.\"/* > -.\" * Copyright (c) 2009 Red Hat, Inc. > -.\" * > -.\" * All rights reserved. > -.\" * > -.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > -.\" * > -.\" * This software licensed under BSD license, the text of which follows: > -.\" * > -.\" * Redistribution and use in source and binary forms, with or without > -.\" * modification, are permitted provided that the following conditions are met: > -.\" * > -.\" * - Redistributions of source code must retain the above copyright notice, > -.\" * this list of conditions and the following disclaimer. > -.\" * - Redistributions in binary form must reproduce the above copyright notice, > -.\" * this list of conditions and the following disclaimer in the documentation > -.\" * and/or other materials provided with the distribution. > -.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > -.\" * contributors may be used to endorse or promote products derived from this > -.\" * software without specific prior written permission. > -.\" * > -.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > -.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > -.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > -.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > -.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > -.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > -.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > -.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > -.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > -.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > -.\" * THE POSSIBILITY OF SUCH DAMAGE. > -.\" */ > -.TH VOTEQUORUM_VOTES 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > -.SH NAME > -votequorum_setvotes \- Sets the number of votes for a node > -.SH SYNOPSIS > -.B #include <corosync/votequorum.h> > -.sp > -.BI "int votequorum_setexpected(votequorum_handle_t " handle ", unsigned int " nodeid ", int " votes ");" > -.SH DESCRIPTION > -The > -.B votequorum_setvotes > -is used to change the number of votes that a node has. Note that it is not possible, using this function, > -to change the number of node votes such that the cluster goes inquorate. > -.SH RETURN VALUE > -This call returns the CS_OK value if successful, otherwise an error is returned. > -.PP > -.SH ERRORS > -The errors are undocumented. > -.SH "SEE ALSO" > -.BR votequorum_overview (8), > -.BR votequorum_initialize (3), > -.BR votequorum_finalize (3), > -.BR votequorum_dispatch (3), > -.BR votequorum_fd_get (3), > -.PP > diff --git a/man/votequorum_setvotes.3.in b/man/votequorum_setvotes.3.in > new file mode 100644 > index 0000000..4fed319 > --- /dev/null > +++ b/man/votequorum_setvotes.3.in > @@ -0,0 +1,57 @@ > +.\"/* > +.\" * Copyright (c) 2009 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Christine Caulfield <ccaulfie@xxxxxxxxxx> > +.\" * > +.\" * This software licensed under BSD license, the text of which follows: > +.\" * > +.\" * Redistribution and use in source and binary forms, with or without > +.\" * modification, are permitted provided that the following conditions are met: > +.\" * > +.\" * - Redistributions of source code must retain the above copyright notice, > +.\" * this list of conditions and the following disclaimer. > +.\" * - Redistributions in binary form must reproduce the above copyright notice, > +.\" * this list of conditions and the following disclaimer in the documentation > +.\" * and/or other materials provided with the distribution. > +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its > +.\" * contributors may be used to endorse or promote products derived from this > +.\" * software without specific prior written permission. > +.\" * > +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" > +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE > +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE > +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE > +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR > +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS > +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN > +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) > +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF > +.\" * THE POSSIBILITY OF SUCH DAMAGE. > +.\" */ > +.TH VOTEQUORUM_VOTES 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" > +.SH NAME > +votequorum_setvotes \- Sets the number of votes for a node > +.SH SYNOPSIS > +.B #include <corosync/votequorum.h> > +.sp > +.BI "int votequorum_setexpected(votequorum_handle_t " handle ", unsigned int " nodeid ", int " votes ");" > +.SH DESCRIPTION > +The > +.B votequorum_setvotes > +is used to change the number of votes that a node has. Note that it is not possible, using this function, > +to change the number of node votes such that the cluster goes inquorate. > +.SH RETURN VALUE > +This call returns the CS_OK value if successful, otherwise an error is returned. > +.PP > +.SH ERRORS > +The errors are undocumented. > +.SH "SEE ALSO" > +.BR votequorum_overview (8), > +.BR votequorum_initialize (3), > +.BR votequorum_finalize (3), > +.BR votequorum_dispatch (3), > +.BR votequorum_fd_get (3), > +.PP _______________________________________________ discuss mailing list discuss@xxxxxxxxxxxx http://lists.corosync.org/mailman/listinfo/discuss