org.wicketstuff.push.IPushTarget Maven / Gradle / Ivy
Show all versions of push Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.wicketstuff.push;
import org.apache.wicket.ajax.AjaxRequestTarget;
/**
* A target used to push events to a client.
*
* Instance of this interface are usually obtained by an {@link IPushService}.
*
* This interface extends {@link IChannelTarget}, and thus provides
* methods familiar to {@link AjaxRequestTarget} users.
*
* The specificities of {@link IPushTarget} is that you have to call
* {@link #trigger()} excplictly when you want the events to actually be send
* to the client. Until the {@link #trigger()} method is called, events are
* simply queued.
*
* The {@link #isConnected()} method allows to check if the target is still connected
* to the client. It is up to the user to call this method before calling
* any method asking for clients updates.
*
* @author Xavier Hanin
*/
public interface IPushTarget extends IChannelTarget {
void trigger();
boolean isConnected();
}