/*
 * Copyright 2011 JBoss, by Red Hat, Inc
 *
 * Licensed 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.jboss.errai.bus.server.api;

/**
 * This interface, <tt>SessionControl</tt>, provides functions for checking up on a session
 */
public interface SessionControl {

  /**
   * Returns true if the current session is still valid
   *
   * @return true if session is valid, false otherwise
   */
  public boolean isSessionValid();

  /**
   * This function indicates activity on the session, so the session knows when the last time there was activity.
   * For example, <tt>MessageQueue</tt> relies on this function to figure out whether or not to timeout
   */
  public void activity();
}
