io.hotmoka.websockets.client.AbstractRemote Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of io-hotmoka-websockets-client Show documentation

This module implements a websocket client.

The newest version!

/*
Copyright 2024 Fausto Spoto

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 io.hotmoka.websockets.client;

import io.hotmoka.annotations.ThreadSafe;
import io.hotmoka.websockets.client.internal.AbstractRemoteImpl;

/**
 * A partial implementation of a remote object that presents a programmatic interface
 * to a service for the API of another object of the same class.
 * 
 * @param  the type of the exceptions thrown if the remote behaves incorrectly
 */
@ThreadSafe
public abstract class AbstractRemote extends AbstractRemoteImpl {

	/**
	 * Creates and opens a new remote application for the API of another application
	 * whose web service is already published.
	 * 
	 * @param timeout the time (in milliseconds) allowed for a call to the network service;
	 *                beyond that threshold, a timeout exception is thrown
	 */
	protected AbstractRemote(int timeout) {
		super(timeout);
	}

	/**
	 * The endpoint class that can be extended to implement the remote call for each API method.
	 */
	public abstract class Endpoint extends AbstractRemoteImpl.Endpoint {

		/**
		 * Creates the endpoint.
		 */
		protected Endpoint() {}
	}
}