Infinity.CommunicationHostedGroup

Subclasses:

None

Methods

Inherited:

Infinity.CommunicationGroup (10), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

	add_member (connection)
	add_method (method)
	remove_member (connection)

Virtual Methods

Inherited:

Infinity.CommunicationGroup (4), GObject.Object (7)

Properties

Inherited:

Infinity.CommunicationGroup (4)

Signals

Inherited:

Infinity.CommunicationGroup (2), GObject.Object (1)

Fields

Inherited:

Infinity.CommunicationGroup (2), GObject.Object (1)

Name	Type	Access	Description
parent_instance	Infinity.CommunicationGroup	r

Class Details

class Infinity.CommunicationHostedGroup(**kwargs)

Bases:

Infinity.CommunicationGroup

Abstract:

No

Structure:

Infinity.CommunicationHostedGroupClass

Infinity.CommunicationHostedGroup is an opaque data type. You should only access it via the public API functions.

add_member(connection)

Parameters:

connection (Infinity.XmlConnection) – A Infinity.XmlConnection to add to group.

Adds connection as a member to self. On the remote site, a Infinity.CommunicationJoinedGroup with the same name and method used for connection (see Infinity.CommunicationGroup.get_method_for_connection()) needs to be created for successful communication.

add_method(method)

Parameters:

method (str) – The method name to add.

Adds a method to the hosted group. When a connection from a given network is added to the group the first time, a Infinity.CommunicationMethod is instantiated to handle messaging for the group within this network. The first method added will be tried first. If the communication manager does support it (meaning Infinity.CommunicationManager.get_factory_for() for the connection’s network and the chosen method returns non-None), then it will be used, otherwise the next method will be tried, etc. If no method is supported, or no methods are added to the group, then the “central” method will be used as a fallback.

remove_member(connection)

Parameters:

connection (Infinity.XmlConnection) – The InfXmlConnection to remove from the group.

Removes connection's membership from group. On the remote site, the corresponding Infinity.CommunicationJoinedGroup needs to be freed.