seb-win-refactoring/SafeExamBrowser.Communication.Contracts/ICommunicationHost.cs

/*
 * Copyright (c) 2024 ETH Zürich, IT Services
 * 
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

namespace SafeExamBrowser.Communication.Contracts
{
	/// <summary>
	/// Defines the common functionality for all communication hosts. A communication host can be hosted by an application component to
	/// allow for inter-process communication with other components (e.g. runtime -> client communication).
	/// </summary>
	public interface ICommunicationHost
	{
		/// <summary>
		/// Indicates whether the host is running and ready for communication.
		/// </summary>
		bool IsRunning { get; }

		/// <summary>
		/// Starts the host and opens it for communication.
		/// </summary>
		/// <exception cref="System.ServiceModel.CommunicationException">If the host fails to start.</exception>
		void Start();

		/// <summary>
		/// Closes and terminates the host.
		/// </summary>
		/// <exception cref="System.ServiceModel.CommunicationException">If the host fails to terminate.</exception>
		void Stop();
	}
}