1 | #region License Information
|
---|
2 | /* HeuristicLab
|
---|
3 | * Copyright (C) 2002-2019 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 |
|
---|
25 | namespace HeuristicLab.Problems.ExternalEvaluation {
|
---|
26 | public interface IEvaluationChannel : INamedItem {
|
---|
27 | /// <summary>
|
---|
28 | /// A flag that describes whether the channel has been initialized or not.
|
---|
29 | /// </summary>
|
---|
30 | bool IsInitialized { get; }
|
---|
31 | /// <summary>
|
---|
32 | /// Opens the channel for communication.
|
---|
33 | /// </summary>
|
---|
34 | /// <remarks>
|
---|
35 | /// Must be called before calling <seealso cref="Send"/> or <seealso cref="Receive"/>.
|
---|
36 | /// The concrete implementation of the channel may require additional information on how to start a connection,
|
---|
37 | /// which should be passed into the concrete channel's constructor.
|
---|
38 | /// </remarks>
|
---|
39 | void Open();
|
---|
40 | /// <summary>
|
---|
41 | /// Sends a message over the channel.
|
---|
42 | /// </summary>
|
---|
43 | /// <param name="solution">The message to send.</param>
|
---|
44 | void Send(IMessage solution);
|
---|
45 | /// <summary>
|
---|
46 | /// Receives a message from the channel and merges the message with the given builder.
|
---|
47 | /// </summary>
|
---|
48 | /// <param name="builder">The builder that must match the message type that is to be received.</param>
|
---|
49 | /// <returns>The received message.</returns>
|
---|
50 | IMessage Receive(IBuilder builder, ExtensionRegistry extensions);
|
---|
51 | /// <summary>
|
---|
52 | /// Tells the channel to close down and terminate open connections.
|
---|
53 | /// </summary>
|
---|
54 | void Close();
|
---|
55 | }
|
---|
56 | }
|
---|