Factory for IGroup objects. More...

Public Types
enum	GroupMemberEvent { GroupMemberEvent.JOINED = 0, GroupMemberEvent.LEFT, GroupMemberEvent.DISCONNECTED }
	Group member event; enumeration. More...

enum	GroupMemberServerConnection { GroupMemberServerConnection.UNAVAILABLE = 0, GroupMemberServerConnection.AVAILABLE }
	Group member connection to group server; enumeration. More...

Static Public Member Functions
static IGroup	Join (IRealm realm, string groupName, ITibProperties props)
	Join a group, and create a group object. More...

Static Public Attributes
static readonly string	ADVISORY_FIELD_GROUP = "group"
	Group name (field name). More...

static readonly string	ADVISORY_FIELD_ORDINAL = "ordinal"
	Group member ordinal (field name). More...

static readonly string	ADVISORY_MODULE_GROUP = "GROUP"
	The advisory message pertains to the group library implementation code (module). More...

static readonly string	ADVISORY_NAME_GROUP_STATUS = "GROUP_STATUS"
	The advisory message reports a group status update. More...

static readonly string	ADVISORY_NAME_ORDINAL_UPDATE = "ORDINAL_UPDATE"
	The advisory message reports an ordinal update. More...

static readonly string	FIELD_GROUP_MEMBER_DESCRIPTOR = "group_member_descriptor"
	Group member descriptor (field name). More...

static readonly string	FIELD_GROUP_MEMBER_EVENT = "group_member_event"
	Group member event (field name). More...

static readonly string	FIELD_GROUP_MEMBER_STATUS_LIST = "group_member_status_list"
	Group member status list (field name). More...

static readonly string	FIELD_GROUP_SERVER_AVAILABLE = "group_server_available"
	Group member connection to group server (field name). More...

static readonly string	PROPERTY_BOOLEAN_OBSERVER = "com.tibco.ftl.group.observer"
	Property name to monitor a group as an observer. More...

static readonly string	PROPERTY_DOUBLE_ACTIVATION_INTERVAL = "com.tibco.ftl.group.activationinterval"
	Property name for group activation interval; double. More...

static readonly string	PROPERTY_MESSAGE_MEMBER_DESCRIPTOR = "com.tibco.ftl.group.memberdescriptor"
	Property name for group member descriptor. More...

Properties
static String	Version `[get]`
	Release string identifying the FTL group class library. More...

Detailed Description

Factory for IGroup objects.

Member Enumeration Documentation

enum TIBCO.FTL.GROUP.GroupFactory.GroupMemberEvent

Group member event; enumeration.

The group member event field of a member status submessage can contain a value of this enumerated type.

See Also: FIELD_GROUP_MEMBER_EVENT

Enumerator
JOINED	The member joined the group, or is a member connected to the group server.
LEFT	The member left the group using an API call.
DISCONNECTED	The member unexpectedly disconnected from the group server.

enum TIBCO.FTL.GROUP.GroupFactory.GroupMemberServerConnection

Group member connection to group server; enumeration.

The group server available field of a group status advisory message can contain a value of this enumerated type.

See Also: FIELD_GROUP_SERVER_AVAILABLE

Enumerator
UNAVAILABLE	The application is not connected to the group server.
AVAILABLE	The application is connected to the group server.

Member Function Documentation

static IGroup TIBCO.FTL.GROUP.GroupFactory.Join	(	IRealm	realm,
		string	groupName,
		ITibProperties	props
	)

inlinestatic

Join a group, and create a group object.

The group object connects to the group server.

In best practice, programs first subscribe to the ORDINAL_UPDATE advisory, and then join a group.

Parameters

realm	The call contacts the group server, which operates inside the realm server for this realm object. Furthermore, the group facility raises advisory messages within this realm.
groupName	The program supplies a string.
props	Optional; to omit, supply `NULL`. Properties configure interaction with the group server and with other group members. GroupFactory.PROPERTY_DOUBLE_ACTIVATION_INTERVAL GroupFactory.PROPERTY_MESSAGE_MEMBER_DESCRIPTOR GroupFactory.PROPERTY_BOOLEAN_OBSERVER Properties configure interaction with the group server.

Returns: This call returns an IGroup object.

Member Data Documentation

readonly string TIBCO.FTL.GROUP.GroupFactory.ADVISORY_FIELD_GROUP = "group"

static

Group name (field name).

The string value of the group name field is the name of the group to which the advisory pertains.

readonly string TIBCO.FTL.GROUP.GroupFactory.ADVISORY_FIELD_ORDINAL = "ordinal"

static

Group member ordinal (field name).

The positive long value of the ordinal field represents the new ordinal of the group member.

The value -1 indicates that the group object is disconnected from the group server. The group object automatically attempts to reconnect, and continues until the program explicitly destroys it. Meanwhile, the group server could reassign the member's previous ordinal to another group member.

Zero is a reserved value.

readonly string TIBCO.FTL.GROUP.GroupFactory.ADVISORY_MODULE_GROUP = "GROUP"

static

The advisory message pertains to the group library implementation code (module).

This string value can appear in the module field.

readonly string TIBCO.FTL.GROUP.GroupFactory.ADVISORY_NAME_GROUP_STATUS = "GROUP_STATUS"

static

The advisory message reports a group status update.

This string value can appear in the name field.

See Also: Advisory.FIELD_NAME, ADVISORY_FIELD_GROUP, FIELD_GROUP_MEMBER_STATUS_LIST, FIELD_GROUP_MEMBER_DESCRIPTOR, FIELD_GROUP_MEMBER_EVENT, FIELD_GROUP_SERVER_AVAILABLE, Advisory.SEVERITY_INFO

readonly string TIBCO.FTL.GROUP.GroupFactory.ADVISORY_NAME_ORDINAL_UPDATE = "ORDINAL_UPDATE"

static

The advisory message reports an ordinal update.

This string value can appear in the name field.

See Also: Advisory.FIELD_NAME, ADVISORY_FIELD_GROUP, ADVISORY_FIELD_ORDINAL, Advisory.SEVERITY_INFO

readonly string TIBCO.FTL.GROUP.GroupFactory.FIELD_GROUP_MEMBER_DESCRIPTOR = "group_member_descriptor"

static

Group member descriptor (field name).

This field can can appear in a member status submessage. Its value is a group member descriptor, that is, a message that identifies a group member.

readonly string TIBCO.FTL.GROUP.GroupFactory.FIELD_GROUP_MEMBER_EVENT = "group_member_event"

static

Group member event (field name).

This field can appear in a member status submessage. Its value is a GroupMemberEvent, that is, a long value that indicates the group member's current state or recent state change.

readonly string TIBCO.FTL.GROUP.GroupFactory.FIELD_GROUP_MEMBER_STATUS_LIST = "group_member_status_list"

static

Group member status list (field name).

This field can appear in group status advisory messages. Its value is an array of member status submessages. Each submessage reports the status of one group member.

readonly string TIBCO.FTL.GROUP.GroupFactory.FIELD_GROUP_SERVER_AVAILABLE = "group_server_available"

static

Group member connection to group server (field name).

This field can appear in a group status message. Its value is a GroupMemberServerConnection, that is, a long value that indicates whether the application process is connected to the group server.

readonly string TIBCO.FTL.GROUP.GroupFactory.PROPERTY_BOOLEAN_OBSERVER = "com.tibco.ftl.group.observer"

static

Property name to monitor a group as an observer.

To monitor a group as an observer, supply this optional property with value true to Join.

An observer never receives an ordinal, and does not trigger group member events.

readonly string TIBCO.FTL.GROUP.GroupFactory.PROPERTY_DOUBLE_ACTIVATION_INTERVAL = "com.tibco.ftl.group.activationinterval"

static

Property name for group activation interval; double.

Supply this (optional) property to Join, which derives heartbeat and timeout intervals from this property value (in seconds). When absent, the default value is 5 seconds.

readonly string TIBCO.FTL.GROUP.GroupFactory.PROPERTY_MESSAGE_MEMBER_DESCRIPTOR = "com.tibco.ftl.group.memberdescriptor"

static

Property name for group member descriptor.

To identify a group member to the other members, supply this optional property to Join.

The application programmer determines the content of the descriptor message. In best practice, each group member process supplies a unique descriptor.

Property Documentation

String TIBCO.FTL.GROUP.GroupFactory.Version

staticget

Release string identifying the FTL group class library.

Programs can use this string to output the FTL group version in a start banner or in debug output.

Public Types

Static Public Member Functions

Static Public Attributes

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation

Property Documentation