SocketListener.java

/*
 * Copyright (C) 2011 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 net.thesocialos.client.channelApi;

/**
 * Listener to receive messages from the server.
 * 
 * <p>
 * For more information about the events handled by this listener, see the Channel API JavaScript Reference:
 * {@link "http://code.google.com/appengine/docs/java/channel/javascript.html"}.
 * </p>
 */
public interface SocketListener {
	/** Called when the channel is closed. */
	void onClose();
	
	/** Called when the channel receives an error. */
	void onError(SocketError error);
	
	/** Called when the channel receives a message from the server. */
	void onMessage(String encodedString);
	
	/** Called when the channel is opened. */
	void onOpen();
}