UDPPush - Revision history

Mheiland at 13:17, 27 June 2009

2009-06-27T13:17:36Z

2009-02-19T11:36:26Z

Remote Host Register

← Older revision		Revision as of 11:36, 19 February 2009
Line 163:		Line 163:

	This UDP package is used to discover hosts in the cluster network. Therefore this package is sent to the multicast address and port.		This UDP package is used to discover hosts in the cluster network. Therefore this package is sent to the multicast address and port.

			'''Note''', the register package must be refreshed after a configurable time. The default timeout is 60 Minutes and can be configured at ''/opt/open-xchange/etc/groupware/push.properties'', com.openexchange.push.udp.registerTimeout:3600000

	{\| id="RemoteHostRegister" cellspacing="0" border="1"		{\| id="RemoteHostRegister" cellspacing="0" border="1"

2008-11-10T10:49:24Z

Described Internal Push Sync Package

← Older revision		Revision as of 10:49, 10 November 2008
Line 127:		Line 127:

	=== Internal Push Sync Package ===		=== Internal Push Sync Package ===

			This package is sent between OX servers in the cluster to distribute the events. Before this package is sent the OX server in the cluster must be discovered by the remote host register package.

			This is only sent if event distribution is enabled. Every server should listen to this package to get informed about what is going on with all data.

	{\| id="InternalPushSyncPackage" cellspacing="0" border="1"		{\| id="InternalPushSyncPackage" cellspacing="0" border="1"

2008-11-10T10:48:02Z

Described Internal Register Sync Package

← Older revision		Revision as of 10:48, 10 November 2008
Line 72:		Line 72:

	=== Internal Register Sync Package ===		=== Internal Register Sync Package ===

			This package is sent between OX servers in the cluster to synchronize the client registrations. Before this package is sent the OX server in the cluster must be discovered by the remote host register package.

			This is only sent if register distribution is enabled. But the preferred way should be the event distribution.

	{\| id="InternalRegisterSyncPackage" cellspacing="0" border="1"		{\| id="InternalRegisterSyncPackage" cellspacing="0" border="1"

2008-11-10T10:42:38Z

Described Client Register Package

← Older revision		Revision as of 10:42, 10 November 2008
Line 11:		Line 11:
	==== Client Register Package ====		==== Client Register Package ====

	This package is sent by the client to tell the OX server he wants to receive push packages.		This package is sent by the client to tell the OX server he wants to receive push packages. The client sends this package to the server on port 44335.

	{\| id="ClientRegisterPackage" cellspacing="0" border="1"		{\| id="ClientRegisterPackage" cellspacing="0" border="1"

2008-11-10T10:37:12Z

Described Push Package

← Older revision		Revision as of 10:37, 10 November 2008
Line 60:		Line 60:

	=== Push Package ===		=== Push Package ===

			OX Server send this package to specific clients informing this about the folder that must be refreshed. This package is directly sent to the client to his registered port.

	{\| id="PushPackage" cellspacing="0" border="1"		{\| id="PushPackage" cellspacing="0" border="1"
	\|+ align="bottom" \| Push Package		\|+ align="bottom" \| Push Package

2008-11-10T10:36:07Z

Described Client Register Package

← Older revision		Revision as of 10:36, 10 November 2008
Line 10:		Line 10:
	=== Protocol ===		=== Protocol ===
	==== Client Register Package ====		==== Client Register Package ====

			This package is sent by the client to tell the OX server he wants to receive push packages.

	{\| id="ClientRegisterPackage" cellspacing="0" border="1"		{\| id="ClientRegisterPackage" cellspacing="0" border="1"
	\|+ align="bottom" \| Client Register Package		\|+ align="bottom" \| Client Register Package

2008-11-10T10:31:46Z

Described Remote Host Register

← Older revision		Revision as of 10:31, 10 November 2008
Line 147:		Line 147:

	=== Remote Host Register ===		=== Remote Host Register ===

			This UDP package is used to discover hosts in the cluster network. Therefore this package is sent to the multicast address and port.

	{\| id="RemoteHostRegister" cellspacing="0" border="1"		{\| id="RemoteHostRegister" cellspacing="0" border="1"
	\|+ align="bottom" \| Remote Host Register		\|+ align="bottom" \| Remote Host Register

2008-10-22T09:17:36Z

added example how to trigger email udp push events.

← Older revision		Revision as of 09:17, 22 October 2008
Line 198:		Line 198:

	// send the value of stringPackage		// send the value of stringPackage
			</pre>

			=== Example for creating events that trigger the UDP push mechanism ===

			Every bundle is able to create events for triggering the UDP push mechanism. This short example shows how to create events to trigger UDP push packages for email.

			<pre>
			import com.openexchange.event.CommonEvent;
			import com.openexchange.event.impl.CommonEventImpl;
			import org.osgi.service.event.Event;
			import org.osgi.service.event.EventAdmin;

			CommonEvent emailEvent = new CommonEventImpl(userId, contextId, CommonEvent.INSERT, Types.EMAIL, null, null, null, null, null);
			Hashtable<String, CommonEvent> ht = new Hashtable<String, CommonEvent>();
			ht.put(CommonEvent.EVENT_KEY, emailEvent);
			Event event = new Event("com/openexchange/mail/new", ht);
			EventAdmin.postEvent(event);
	</pre>		</pre>

2008-10-22T09:04:53Z

added sync email push.

← Older revision		Revision as of 09:04, 22 October 2008
Line 127:		Line 127:
	\| Package Length \|\| Number \|\| The length of informations in this package		\| Package Length \|\| Number \|\| The length of informations in this package
	\|-		\|-
	\| Action \|\| Number \|\| For a ~~client register~~ package the action value is always '3'		\| Action \|\| Number \|\| For a internal push sync package the action value is always '3'
	\|-		\|-
	\| Folder ID \|\| Number \|\| The folder id where the event occured		\| Folder ID \|\| Number \|\| The folder id where the event occured
Line 143:		Line 143:
	\|-		\|-
	\|}		\|}

			The module EMail is very limited. The folderId is always 1 because push is only supported in the INBOX of a user. The affected users are always only the owner of the INBOX.

	=== Remote Host Register ===		=== Remote Host Register ===