clTmsApi.h File Reference

Header file of Group Membership Service APIs. More...

#include <clCommon.h>
#include <clClmApi.h>
#include <clTmsApi.h>

Go to the source code of this file.

Macros
#define	clTmsInitialize   clGmsInitialize
	Handle to be associated with each group.

Functions
ClRcT	clTmsGetGroupInfo (CL_IN ClTmsHandleT svcHandle, CL_IN ClTmsGroupNameT *groupName, CL_IN ClTimeT timeout, CL_INOUT ClTmsGroupInfoT *groupInfo)
	Returns the information of a group specified by the groupName.
ClRcT	clTmsGroupCreate (CL_IN ClTmsHandleT svcHandle, CL_IN ClTmsGroupNameT *groupName, CL_INOUT ClTmsGroupParamsT *groupParams, CL_OUT ClTmsGroupIdT *groupId)
	Create a group.
ClRcT	clTmsGroupDestroy (CL_IN ClTmsHandleT svcHandle, CL_IN ClTmsGroupIdT groupId)
	Destroy a group.
ClRcT	clTmsGroupJoin (CL_IN ClTmsHandleT svcHandle, CL_IN ClTmsGroupIdT groupId, CL_IN ClTmsMemberIdT memberId, CL_IN ClTmsMemberNameT *memberName, CL_IN ClTmsLeadershipCredentialsT credentials, CL_IN ClTmsGroupMessageDeliveryCallbackT msgDeliveryCallback, CL_IN ClTimeT timeout)
	Join the group as a member.
ClRcT	clTmsGroupLeave (CL_IN ClTmsHandleT svcHandle, CL_IN ClTmsGroupIdT groupId, CL_IN ClTmsMemberIdT memberId, CL_IN ClTimeT timeout)
	Leave the group.
ClRcT	clTmsGroupTrack (CL_IN ClTmsHandleT svcHandle, CL_IN ClTmsGroupIdT groupId, CL_IN ClUint8T trackFlags, CL_INOUT ClTmsGroupNotificationBufferT *notificationBuffer)
	Configures the group tracking mode.
ClRcT	clTmsGroupTrackStop (CL_IN ClTmsHandleT svcHandle, CL_IN ClTmsGroupIdT groupId)
	Stops all the group tracking.
ClRcT	clTmsListGroups (CL_IN ClTmsHandleT svcHandle, CL_IN ClTimeT timeout, CL_INOUT ClTmsGroupInfoListT *groups)
	Returns the information on all the groups.
ClRcT	clTmsSendAll (CL_IN ClGmsHandleT svcHandle, CL_IN ClGmsGroupIdT groupId, CL_IN ClGmsMemberIdT memberId, CL_IN ClTimeT timeout, CL_IN ClUint32T dataSize, CL_IN ClPtrT data)
	Send a Totally ordered multicast messages to all members of a given group.

Detailed Description

Header file of Group Membership Service APIs.