| 1 | #region License Information
|
|---|
| 2 | /* HeuristicLab
|
|---|
| 3 | * Copyright (C) Heuristic and Evolutionary Algorithms Laboratory (HEAL)
|
|---|
| 4 | *
|
|---|
| 5 | * This file is part of HeuristicLab.
|
|---|
| 6 | *
|
|---|
| 7 | * HeuristicLab is free software: you can redistribute it and/or modify
|
|---|
| 8 | * it under the terms of the GNU General Public License as published by
|
|---|
| 9 | * the Free Software Foundation, either version 3 of the License, or
|
|---|
| 10 | * (at your option) any later version.
|
|---|
| 11 | *
|
|---|
| 12 | * HeuristicLab is distributed in the hope that it will be useful,
|
|---|
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|---|
| 15 | * GNU General Public License for more details.
|
|---|
| 16 | *
|
|---|
| 17 | * You should have received a copy of the GNU General Public License
|
|---|
| 18 | * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
|
|---|
| 19 | */
|
|---|
| 20 | #endregion
|
|---|
| 21 |
|
|---|
| 22 | using Google.ProtocolBuffers;
|
|---|
| 23 | using HeuristicLab.Core;
|
|---|
| 24 | using HEAL.Attic;
|
|---|
| 25 |
|
|---|
| 26 | namespace HeuristicLab.Problems.ExternalEvaluation {
|
|---|
| 27 | [StorableType("8e62ba0d-03f5-4243-8411-3bd5f14c42be")]
|
|---|
| 28 | public interface IEvaluationChannel : INamedItem {
|
|---|
| 29 | /// <summary>
|
|---|
| 30 | /// A flag that describes whether the channel has been initialized or not.
|
|---|
| 31 | /// </summary>
|
|---|
| 32 | bool IsInitialized { get; }
|
|---|
| 33 | /// <summary>
|
|---|
| 34 | /// Opens the channel for communication.
|
|---|
| 35 | /// </summary>
|
|---|
| 36 | /// <remarks>
|
|---|
| 37 | /// Must be called before calling <seealso cref="Send"/> or <seealso cref="Receive"/>.
|
|---|
| 38 | /// The concrete implementation of the channel may require additional information on how to start a connection,
|
|---|
| 39 | /// which should be passed into the concrete channel's constructor.
|
|---|
| 40 | /// </remarks>
|
|---|
| 41 | void Open();
|
|---|
| 42 | /// <summary>
|
|---|
| 43 | /// Sends a message over the channel.
|
|---|
| 44 | /// </summary>
|
|---|
| 45 | /// <param name="solution">The message to send.</param>
|
|---|
| 46 | void Send(IMessage solution);
|
|---|
| 47 | /// <summary>
|
|---|
| 48 | /// Receives a message from the channel and merges the message with the given builder.
|
|---|
| 49 | /// </summary>
|
|---|
| 50 | /// <param name="builder">The builder that must match the message type that is to be received.</param>
|
|---|
| 51 | /// <returns>The received message.</returns>
|
|---|
| 52 | IMessage Receive(IBuilder builder, ExtensionRegistry extensions);
|
|---|
| 53 | /// <summary>
|
|---|
| 54 | /// Tells the channel to close down and terminate open connections.
|
|---|
| 55 | /// </summary>
|
|---|
| 56 | void Close();
|
|---|
| 57 | }
|
|---|
| 58 | }
|
|---|
