org.gwtproject.rpc.websockets.shared.Client Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of endpoint-processor Show documentation

There is a newer version: 1.0-alpha-8

/*
 * #%L
 * rpc-client-common
 * %%
 * Copyright (C) 2011 - 2018 Vertispan LLC
 * %%
 * 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.
 * #L%
 */
package org.gwtproject.rpc.websockets.shared;

import org.gwtproject.rpc.websockets.shared.Endpoint.BaseClass;
import org.gwtproject.rpc.websockets.shared.Endpoint.RemoteEndpointSupplier;
import org.gwtproject.rpc.websockets.shared.impl.AbstractWebSocketClientImpl;

/**
 * Starting interface for building the methods the server may call on the client. User code may
 * provide an instance of this type to a Server instance created using GWT.create, and Client
 * instances will be created automatically on the server as connections are created.
 *
 * @see Server
 *
 */
@BaseClass(AbstractWebSocketClientImpl.class)
public interface Client, S extends Server> {

	/**
	 * Callback called when the connection to the server has been established. Should not be called
	 * directly from the server.
	 */
	void onOpen();

	/**
	 * Callback called when the connection to the server has been closed. Should not be called
	 * directly from the server.
	 */
	void onClose();

	/**
	 * Called when an error occurs while handling a message in one of the other client methods. If a
	 * ConnectionErrorHandler is provided to the server builder, that will be used in handling
	 * serialization/deserialization and connection errors.
	 * @param error the error that occurred
	 */
	void onError(Throwable error);

	void setServer(S server);

	@RemoteEndpointSupplier
	S getServer();
}