using Google.Protobuf; using System.Net.Sockets; using UnityEngine; using MLAgents.CommunicatorObjects; using System.Threading.Tasks; #if UNITY_EDITOR using UnityEditor; #endif namespace MLAgents { public class SocketCommunicator : Communicator { private const float TimeOut = 10f; private const int MessageLength = 12000; byte[] m_messageHolder = new byte[MessageLength]; int m_comPort; Socket m_sender; byte[] m_lengthHolder = new byte[4]; CommunicatorParameters communicatorParameters; public SocketCommunicator(CommunicatorParameters communicatorParameters) { this.communicatorParameters = communicatorParameters; } /// /// Initialize the communicator by sending the first UnityOutput and receiving the /// first UnityInput. The second UnityInput is stored in the unityInput argument. /// /// The first Unity Input. /// The first Unity Output. /// The second Unity input. public UnityInput Initialize(UnityOutput unityOutput, out UnityInput unityInput) { m_sender = new Socket( AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp); m_sender.Connect("localhost", communicatorParameters.port); UnityMessage initializationInput = UnityMessage.Parser.ParseFrom(Receive()); Send(WrapMessage(unityOutput, 200).ToByteArray()); unityInput = UnityMessage.Parser.ParseFrom(Receive()).UnityInput; #if UNITY_EDITOR #if UNITY_2017_2_OR_NEWER EditorApplication.playModeStateChanged += HandleOnPlayModeChanged; #else EditorApplication.playmodeStateChanged += HandleOnPlayModeChanged; #endif #endif return initializationInput.UnityInput; } /// /// Uses the socke to receive a byte[] from External. Reassemble a message that was split /// by External if it was too long. /// /// The byte[] sent by External. byte[] Receive() { m_sender.Receive(m_lengthHolder); int totalLength = System.BitConverter.ToInt32(m_lengthHolder, 0); int location = 0; byte[] result = new byte[totalLength]; while (location != totalLength) { int fragment = m_sender.Receive(m_messageHolder); System.Buffer.BlockCopy( m_messageHolder, 0, result, location, fragment); location += fragment; } return result; } /// /// Send the specified input via socket to External. Split the message into smaller /// parts if it is too long. /// /// The byte[] to be sent. void Send(byte[] input) { byte[] newArray = new byte[input.Length + 4]; input.CopyTo(newArray, 4); System.BitConverter.GetBytes(input.Length).CopyTo(newArray, 0); m_sender.Send(newArray); } /// /// Close the communicator gracefully on both sides of the communication. /// public void Close() { Send(WrapMessage(null, 400).ToByteArray()); } /// /// Send a UnityOutput and receives a UnityInput. /// /// The next UnityInput. /// The UnityOutput to be sent. public UnityInput Exchange(UnityOutput unityOutput) { Send(WrapMessage(unityOutput, 200).ToByteArray()); byte[] received = null; var task = Task.Run(() => received = Receive()); if (!task.Wait(System.TimeSpan.FromSeconds(TimeOut))) { throw new UnityAgentsException( "The communicator took too long to respond."); } var message = UnityMessage.Parser.ParseFrom(received); if (message.Header.Status != 200) { return null; } return message.UnityInput; } /// /// Wraps the UnityOuptut into a message with the appropriate status. /// /// The UnityMessage corresponding. /// The UnityOutput to be wrapped. /// The status of the message. private static UnityMessage WrapMessage(UnityOutput content, int status) { return new UnityMessage { Header = new Header { Status = status }, UnityOutput = content }; } /// /// When the Unity application quits, the communicator must be closed /// private void OnApplicationQuit() { Close(); } #if UNITY_EDITOR #if UNITY_2017_2_OR_NEWER /// /// When the editor exits, the communicator must be closed /// /// State. private void HandleOnPlayModeChanged(PlayModeStateChange state) { // This method is run whenever the playmode state is changed. if (state==PlayModeStateChange.ExitingPlayMode) { Close(); } } #else /// /// When the editor exits, the communicator must be closed /// private void HandleOnPlayModeChanged() { // This method is run whenever the playmode state is changed. if (!EditorApplication.isPlayingOrWillChangePlaymode) { Close(); } } #endif #endif } }