WebSocketClient.java

/*
 * Copyright (C) 2012 Google 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 interactivespaces.service.web.client;

import interactivespaces.service.web.WebSocketConnection;
import interactivespaces.service.web.WebSocketHandler;
import interactivespaces.util.resource.ManagedResource;

/**
 * A web socket client.
 *
 * @author Keith M. Hughes
 */
public interface WebSocketClient extends WebSocketConnection, ManagedResource {

  /**
   * Set the web socket handler to be used for callbacks.
   *
   * <p>
   * This must be set before {@link #startup()} is called.
   *
   * @param handler
   *          the handler
   */
  void setWebSocketHandler(WebSocketHandler handler);

  /**
   * Ping the server.
   */
  void ping();
}