C++11 library providing functionality common to all adapters.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

82 lines
2.3 KiB

  1. // This file is under GNU General Public License 3.0
  2. // see LICENSE.txt
  3. #ifndef LIBPEPADAPTER_GROUP_HH
  4. #define LIBPEPADAPTER_GROUP_HH
  5. #ifdef __cplusplus
  6. extern "C" {
  7. #endif
  8. /**
  9. * <!-- query_groups() -->
  10. *
  11. * @brief queries the list manager which groups currently exist.
  12. *
  13. * @param[in] session associated session object
  14. * @param[out] groups list of pEp_identity representing
  15. * all group identities that currently exist.
  16. *
  17. * @retval PEP_STATUS_OK on success
  18. * error on failure
  19. *
  20. * @ownership ownership of all parameters goes to the caller
  21. *
  22. */
  23. DYNAMIC_API PEP_STATUS query_groups(
  24. PEP_SESSION session,
  25. identity_list **groups
  26. );
  27. /**
  28. * <!-- query_group_manager() -->
  29. *
  30. * @brief queries the list manager for the group manager of a given group.
  31. *
  32. * @param[in] session associated session object
  33. * @param[in] group pEp_Identity representing the group identity in question
  34. * @param[out] manager pEp_identity representing the group manager for "group"
  35. *
  36. * @retval PEP_STATUS_OK on success
  37. * error on failure
  38. *
  39. * @ownership ownership of all parameters goes to the caller
  40. *
  41. */
  42. DYNAMIC_API PEP_STATUS query_group_manager(
  43. PEP_SESSION session,
  44. const pEp_identity * const group,
  45. pEp_identity **manager
  46. );
  47. /**
  48. * <!-- query_group_members() -->
  49. *
  50. * @brief queries the list manager for all members of a given group.
  51. *
  52. * @param[in] session associated session object
  53. * @param[in] group pEp_Identity representing the group identity in question
  54. * @param[out] members list of pEp_identity representing all the members of "group"
  55. *
  56. * @retval PEP_STATUS_OK on success
  57. * error on failure
  58. *
  59. * @ownership ownership of all parameters goes to the caller
  60. *
  61. */
  62. DYNAMIC_API PEP_STATUS query_group_members(
  63. PEP_SESSION session,
  64. const pEp_identity * const group,
  65. identity_list **members
  66. );
  67. #ifdef __cplusplus
  68. };
  69. #endif
  70. #endif //LIBPEPADAPTER_GROUP_HH