net.officefloor.plugin.comet.internal.CometSubscriptionService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of officeplugin_comet Show documentation

OfficeFloor plug-in for Comet

There is a newer version: 2.12.0

/*
 * OfficeFloor - http://www.officefloor.net
 * Copyright (C) 2005-2012 Daniel Sagenschneider
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */

package net.officefloor.plugin.comet.internal;

import com.google.gwt.user.client.rpc.RemoteService;
import com.google.gwt.user.client.rpc.RemoteServiceRelativePath;

import net.officefloor.plugin.comet.api.CometSubscriber;

/**
 * RPC Service for the {@link CometSubscriber}.
 * 
 * @author Daniel Sagenschneider
 */
@RemoteServiceRelativePath("comet-subscribe")
public interface CometSubscriptionService extends RemoteService {

	/**
	 * Subscribes by sending a {@link CometRequest} and when an event is
	 * available, responds with {@link CometResponse} containing details of the
	 * event(s).
	 * 
	 * @param request
	 *            {@link CometRequest}.
	 * @return {@link CometResponse} containing the event.
	 */
	CometResponse subscribe(CometRequest request);

}