com.aoindustries.aoserv.client.AOServConnection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aoserv-client Show documentation

Java client for the AOServ Platform.

There is a newer version: 1.92.0

/*
 * aoserv-client - Java client for the AOServ Platform.
 * Copyright (C) 2001-2009, 2016, 2017, 2018, 2019  AO Industries, Inc.
 *     [email protected]
 *     7262 Bull Pen Cir
 *     Mobile, AL 36695
 *
 * This file is part of aoserv-client.
 *
 * aoserv-client is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * aoserv-client is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with aoserv-client.  If not, see .
 */
package com.aoindustries.aoserv.client;

import com.aoindustries.aoserv.client.schema.AoservProtocol;
import com.aoindustries.io.stream.StreamableInput;
import com.aoindustries.io.stream.StreamableOutput;
import java.io.IOException;

/**
 * An AOServConnection is one stream of communication
 * between the client and the server.
 *
 * @see  AOServConnector
 *
 * @author  AO Industries, Inc.
 */
abstract public class AOServConnection {

	/**
	 * The connector that this connection is part of.
	 */
	protected final AOServConnector connector;

	/**
	 * Creates a new AOServConnection.
	 */
	protected AOServConnection(AOServConnector connector) {
		this.connector=connector;
	}

	/**
	 * Closes this connection to the server
	 * so that a reconnect is forced in the
	 * future.
	 */
	abstract void close();

	/**
	 * Gets the stream to write to the server.
	 */
	abstract StreamableOutput getRequestOut(AoservProtocol.CommandID commID) throws IOException;

	/**
	 * Gets the stream to read from the server.
	 */
	abstract StreamableInput getResponseIn() throws IOException;
}