Test your AI Agents with the all-new Agent to Agent Testing Platform.Learn More

How to use SocketCommunicationManager method of Microsoft.TestPlatform.Protocol.SocketCommunicationManager class

Best Vstest code snippet using Microsoft.TestPlatform.Protocol.SocketCommunicationManager.SocketCommunicationManager

CommunicationChannel.cs

Source:CommunicationChannel.cs

...5556        private Socket socket;5758        /// <summary>59        /// Initializes a new instance of the <see cref="SocketCommunicationManager"/> class.60        /// </summary>61        public CommunicationChannel()62            : this(JsonDataSerializer.Instance)63        {64        }6566        internal CommunicationChannel(JsonDataSerializer dataSerializer)67        {68            this.dataSerializer = dataSerializer;69        }7071        #region ServerMethods7273        /// <summary>74        /// Host TCP Socket Server and start listening75        /// </summary>76        /// <param name="endpoint">End point where server is hosted</param>77        /// <returns>Port of the listener</returns>78        public IPEndPoint HostServer(IPEndPoint endpoint)79        {80            this.tcpListener = new TcpListener(endpoint);81            this.tcpListener.Start();82            EqtTrace.Info("Listening on Endpoint : {0}", (IPEndPoint)this.tcpListener.LocalEndpoint);8384            return (IPEndPoint)this.tcpListener.LocalEndpoint;85        }8687        /// <summary>88        /// Accepts client async89        /// </summary>90        /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>91        public async Task AcceptClientAsync()92        {93            if (this.tcpListener != null)94            {95                this.clientConnectedEvent.Reset();9697                var client = await this.tcpListener.AcceptTcpClientAsync();98                this.socket = client.Client;99                this.socket.NoDelay = true;100101                // Using Buffered stream only in case of write, and Network stream in case of read.102                var bufferedStream = new PlatformStream().CreateBufferedStream(client.GetStream(), JSTest.Constants.StreamBufferSize);103                var networkStream = client.GetStream();104                this.binaryReader = new BinaryReader(networkStream);105                this.binaryWriter = new BinaryWriter(bufferedStream);106107                this.clientConnectedEvent.Set();108                if (EqtTrace.IsInfoEnabled)109                {110                    EqtTrace.Info("Using the buffer size of {0} bytes", JSTest.Constants.StreamBufferSize);111                    EqtTrace.Info("Accepted Client request and set the flag");112                }113            }114        }115116        /// <summary>117        /// Waits for Client Connection118        /// </summary>119        /// <param name="clientConnectionTimeout">Time to Wait for the connection</param>120        /// <returns>True if Client is connected, false otherwise</returns>121        public bool WaitForClientConnection(int clientConnectionTimeout)122        {123            return this.clientConnectedEvent.WaitOne(clientConnectionTimeout);124        }125126        /// <summary>127        /// Stop Listener128        /// </summary>129        public void StopServer()130        {131            this.tcpListener?.Stop();132            this.tcpListener = null;133            this.binaryReader?.Dispose();134            this.binaryWriter?.Dispose();135        }136137        #endregion138        139        /// <summary>140        /// Writes message to the binary writer.141        /// </summary>142        /// <param name="messageType">Type of Message to be sent, for instance TestSessionStart</param>143        public void SendMessage(string messageType )144        {145            var serializedObject = this.dataSerializer.SerializePayload(messageType, null, JSTest.Constants.MessageProtocolVersion);146            this.WriteAndFlushToChannel(serializedObject);147148            var ph = new ProcessHelper();149            EqtTrace.Info("PROTOCOL    {0} Send: {1}", ph.GetProcessName(ph.GetCurrentProcessId()), serializedObject);150        }151152        /// <summary>153        ///  Writes message to the binary writer with payload154        /// </summary>155        /// <param name="messageType">Type of Message to be sent, for instance TestSessionStart</param>156        /// <param name="payload">payload to be sent</param>157        public void SendMessage(string messageType, object payload)158        {159            var rawMessage = this.dataSerializer.SerializePayload(messageType, payload, JSTest.Constants.MessageProtocolVersion);160            this.WriteAndFlushToChannel(rawMessage);161162            var ph = new ProcessHelper();163            EqtTrace.Info("PROTOCOL    {0} Send: {1}", ph.GetProcessName(ph.GetCurrentProcessId()), rawMessage);164        }165166167        /// <summary>168        /// Reads message from the binary reader169        /// </summary>170        /// <returns>Returns message read from the binary reader</returns>171        public Message ReceiveMessage()172        {173            var rawMessage = this.ReceiveRawMessage();174175            var ph = new ProcessHelper();176            EqtTrace.Info("PROTOCOL    {0} Receive: {1}", ph.GetProcessName(ph.GetCurrentProcessId()), rawMessage);177178            return this.dataSerializer.DeserializeMessage(rawMessage);179        }180181        /// <summary>182        /// Reads message from the binary reader using read timeout183        /// </summary>184        /// <param name="cancellationToken">185        /// The cancellation Token.186        /// </param>187        /// <returns>188        /// Returns message read from the binary reader189        /// </returns>190        public async Task<Message> ReceiveMessageAsync(CancellationToken cancellationToken)191        {192            var rawMessage = await this.ReceiveRawMessageAsync(cancellationToken);193            if (!string.IsNullOrEmpty(rawMessage))194            {195                return this.dataSerializer.DeserializeMessage(rawMessage);196            }197198            return null;199        }200201        /// <summary>202        /// Reads message from the binary reader203        /// </summary>204        /// <returns> Raw message string </returns>205        public string ReceiveRawMessage()206        {207            return this.binaryReader.ReadString();208        }209210        /// <summary>211        /// Reads message from the binary reader using read timeout212        /// </summary>213        /// <param name="cancellationToken">214        /// The cancellation Token.215        /// </param>216        /// <returns>217        /// Raw message string218        /// </returns>219        public async Task<string> ReceiveRawMessageAsync(CancellationToken cancellationToken)220        {221            var str = await Task.Run(() => this.TryReceiveRawMessage(cancellationToken));222            return str;223        }224225        private string TryReceiveRawMessage(CancellationToken cancellationToken)226        {227            string str = null;228            bool success = false;229230            // Set read timeout to avoid blocking receive raw message231            while (!cancellationToken.IsCancellationRequested && !success)232            {233                try234                {235                    if (this.socket.Poll(STREAMREADTIMEOUT, SelectMode.SelectRead))236                    {237                        str = this.ReceiveRawMessage();238                        success = true;239                    }240                }241                catch (IOException ioException)242                {243                    var socketException = ioException.InnerException as SocketException;244                    if (socketException != null245                        && socketException.SocketErrorCode == SocketError.TimedOut)246                    {247                        EqtTrace.Info(248                            "SocketCommunicationManager ReceiveMessage: failed to receive message because read timeout {0}",249                            ioException);250                    }251                    else252                    {253                        EqtTrace.Error(254                            "SocketCommunicationManager ReceiveMessage: failed to receive message {0}",255                            ioException);256                        break;257                    }258                }259                catch (Exception exception)260                {261                    EqtTrace.Error(262                        "SocketCommunicationManager ReceiveMessage: failed to receive message {0}",263                        exception);264                    break;265                }266            }267268            return str;269        }270271        /// <summary>272        /// Writes the data on socket and flushes the buffer273        /// </summary>274        /// <param name="rawMessage">message to write</param>275        private void WriteAndFlushToChannel(string rawMessage)276        {
...

SocketCommunicationManager.cs

Source:SocketCommunicationManager.cs

...10    using System.Threading.Tasks;11    /// <summary>12    /// Facilitates communication using sockets13    /// </summary>14    public class SocketCommunicationManager15    {16        /// <summary>17        /// TCP Listener to host TCP channel and listen18        /// </summary>19        private TcpListener tcpListener;20        /// <summary>21        /// Binary Writer to write to channel stream22        /// </summary>23        private BinaryWriter binaryWriter;24        /// <summary>25        /// Binary reader to read from channel stream26        /// </summary>27        private BinaryReader binaryReader;28        /// <summary>29        /// Serializer for the data objects30        /// </summary>31        private JsonDataSerializer dataSerializer;32        /// <summary>33        /// Event used to maintain client connection state34        /// </summary>35        private ManualResetEvent clientConnectedEvent = new ManualResetEvent(false);36        /// <summary>37        /// Sync object for sending messages38        /// SendMessage over socket channel is NOT thread-safe39        /// </summary>40        private object sendSyncObject = new object();41        /// <summary>42        /// Stream to use read timeout43        /// </summary>44        private NetworkStream stream;45        private Socket socket;46        /// <summary>47        /// The server stream read timeout constant (in microseconds).48        /// </summary>49        private const int StreamReadTimeout = 1000 * 1000;50        /// <summary>51        /// Initializes a new instance of the <see cref="SocketCommunicationManager"/> class.52        /// </summary>53        public SocketCommunicationManager() : this(JsonDataSerializer.Instance)54        {55        }56        internal SocketCommunicationManager(JsonDataSerializer dataSerializer)57        {58            this.dataSerializer = dataSerializer;59        }60        #region ServerMethods61        /// <summary>62        /// Host TCP Socket Server and start listening63        /// </summary>64        /// <returns></returns>65        public int HostServer()66        {67            var endpoint = new IPEndPoint(IPAddress.Loopback, 0);68            this.tcpListener = new TcpListener(endpoint);69            this.tcpListener.Start();70            var portNumber = ((IPEndPoint)this.tcpListener.LocalEndpoint).Port;...

SocketCommunicationManager

Using AI Code Generation

1using System;2using System.IO;3using System.Net;4using System.Net.Sockets;5using System.Text;6using System.Threading;7using System.Threading.Tasks;8using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities;9using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities.Interfaces;10using Microsoft.VisualStudio.TestPlatform.ObjectModel;11using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;12using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;13using Microsoft.VisualStudio.TestPlatform.PlatformAbstractions;14using Microsoft.VisualStudio.TestPlatform.PlatformAbstractions.Interfaces;15{16    {17        private const int DefaultBufferSize = 1024;18        private const int DefaultBacklog = 100;19        private readonly ICommunicationEndPoint serverEndPoint;20        private readonly ICommunicationEndPoint clientEndPoint;21        private readonly ITestLoggerEvents testMessageLogger;22        private readonly IEnvironment environment;23        private readonly ICommunicationChannel channel;24        private readonly int bufferSize;25        private readonly ManualResetEventSlim waitForConnection;26        private bool disposed;27        private SocketCommunicationManager(28        {29            this.serverEndPoint = serverEndPoint;30            this.clientEndPoint = clientEndPoint;31            this.channel = channel;32            this.testMessageLogger = testMessageLogger;33            this.environment = environment;34            this.bufferSize = bufferSize;35            this.waitForConnection = new ManualResetEventSlim(false);36        }37        public event EventHandler<EndpointConnectedEventArgs> EndpointConnected;38        public event EventHandler<EndpointDisconnectedEventArgs> EndpointDisconnected;39        public event EventHandler<RawMessageEventArgs> MessageReceived;40        public static SocketCommunicationManager CreateClient(41        {42            if (serverEndPoint == null)43            {44                throw new ArgumentNullException("serverEndPoint");45            }46            if (channel == null)47            {48                throw new ArgumentNullException("channel");49            }50            if (testMessageLogger == null)51            {52                throw new ArgumentNullException("testMessageLogger");53            }54            if (environment == null)55            {56                throw new ArgumentNullException("environment");57            }58            return new SocketCommunicationManager(null, serverEndPoint, channel, testMessageLogger, environment, bufferSize);59        }60        public static SocketCommunicationManager CreateServer(

SocketCommunicationManager

Using AI Code Generation

1using Microsoft.TestPlatform.CommunicationUtilities;2using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities;3using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities.Interfaces;4using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities.ObjectModel;5using Microsoft.VisualStudio.TestPlatform.ObjectModel;6using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;7using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine;8using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;9using Microsoft.VisualStudio.TestPlatform.Utilities;10using System;11using System.Collections.Generic;12using System.Diagnostics;13using System.IO;14using System.Linq;15using System.Reflection;16using System.Runtime.Serialization;17using System.Runtime.Serialization.Formatters.Binary;18using System.Text;19using System.Threading;20using System.Threading.Tasks;21{22    {23        private readonly ICommunicationEndPoint endpoint;24        private readonly IProtocolSerializer protocol;25        private MessageType messageType;26        private Version messageVersion;27        private string messageBody;28        private string messageHeader;29        private int messageBodyLength;30        private int messageHeaderLength;31        private int messageBodyReceived;32        private int messageHeaderReceived;33        private byte[] messageBodyBuffer;34        private byte[] messageHeaderBuffer;35        private ManualResetEvent messageReceivedEvent;

SocketCommunicationManager

Using AI Code Generation

1var socketCommunicationManager = new SocketCommunicationManager();2var data = socketCommunicationManager.ReceiveMessage();3var socketCommunicationManager = new SocketCommunicationManager();4socketCommunicationManager.SendMessage(data);5var socketCommunicationManager = new SocketCommunicationManager();6socketCommunicationManager.Close();7var socketCommunicationManager = new SocketCommunicationManager();8var data = socketCommunicationManager.ReceiveMessage();9var socketCommunicationManager = new SocketCommunicationManager();10socketCommunicationManager.SendMessage(data);11var socketCommunicationManager = new SocketCommunicationManager();12socketCommunicationManager.Close();13var socketCommunicationManager = new SocketCommunicationManager();14var data = socketCommunicationManager.ReceiveMessage();15var socketCommunicationManager = new SocketCommunicationManager();16socketCommunicationManager.SendMessage(data);17var socketCommunicationManager = new SocketCommunicationManager();18socketCommunicationManager.Close();19var socketCommunicationManager = new SocketCommunicationManager();20var data = socketCommunicationManager.ReceiveMessage();21var socketCommunicationManager = new SocketCommunicationManager();22socketCommunicationManager.SendMessage(data);23var socketCommunicationManager = new SocketCommunicationManager();24socketCommunicationManager.Close();25var socketCommunicationManager = new SocketCommunicationManager();26var data = socketCommunicationManager.ReceiveMessage();27var socketCommunicationManager = new SocketCommunicationManager();28socketCommunicationManager.SendMessage(data);

SocketCommunicationManager

Using AI Code Generation

1using Microsoft.TestPlatform.Protocol;2SocketCommunicationManager manager = new SocketCommunicationManager();3manager.SetConnectionInfo("localhost", 1234);4manager.InitializeCommunication();5using Microsoft.TestPlatform.CommunicationUtilities;6SocketCommunicationManager manager = new SocketCommunicationManager();7manager.SetConnectionInfo("localhost", 1234);8manager.InitializeCommunication();

SocketCommunicationManager

Using AI Code Generation

1public void SocketCommunicationManagerMethod()2{3    SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();4    socketCommunicationManager.StartClient();5    socketCommunicationManager.SendMessage("message");6    socketCommunicationManager.ReceiveMessage();7    socketCommunicationManager.Close();8}9public void SocketCommunicationManagerMethod()10{11    SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();12    socketCommunicationManager.StartServer();13    socketCommunicationManager.SendMessage("message");14    socketCommunicationManager.ReceiveMessage();15    socketCommunicationManager.Close();16}17public void SocketCommunicationManagerMethod()18{19    SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();20    socketCommunicationManager.StartClient();21    socketCommunicationManager.SendMessage("message");22    socketCommunicationManager.ReceiveMessage();23    socketCommunicationManager.Close();24}25public void SocketCommunicationManagerMethod()26{27    SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();28    socketCommunicationManager.StartServer();29    socketCommunicationManager.SendMessage("message");30    socketCommunicationManager.ReceiveMessage();31    socketCommunicationManager.Close();32}33public void SocketCommunicationManagerMethod()34{35    SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();36    socketCommunicationManager.StartClient();37    socketCommunicationManager.SendMessage("message");38    socketCommunicationManager.ReceiveMessage();39    socketCommunicationManager.Close();40}41public void SocketCommunicationManagerMethod()42{43    SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();44    socketCommunicationManager.StartServer();45    socketCommunicationManager.SendMessage("message");46    socketCommunicationManager.ReceiveMessage();47    socketCommunicationManager.Close();48}49public void SocketCommunicationManagerMethod()50{51    SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();52    socketCommunicationManager.StartClient();53    socketCommunicationManager.SendMessage("message");54    socketCommunicationManager.ReceiveMessage();

SocketCommunicationManager

Using AI Code Generation

1{2    using System;3    using System.Collections.Generic;4    using System.IO;5    using System.Net;6    using System.Net.Sockets;7    using System.Runtime.Serialization;8    using System.Threading;9    using System.Threading.Tasks;10    using Microsoft.VisualStudio.TestPlatform.ObjectModel;11    using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;12    using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine;13    using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine.ClientProtocol;14    using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine.TesthostProtocol;15    using Microsoft.VisualStudio.TestPlatform.PlatformAbstractions.Interfaces;16    using Microsoft.VisualStudio.TestPlatform.Utilities.Helpers;17    using Microsoft.VisualStudio.TestPlatform.Utilities.Helpers.Interfaces;

SocketCommunicationManager

Using AI Code Generation

1var socketCommunicationManager = new SocketCommunicationManager();2socketCommunicationManager.SendMessage(data);3var socketCommunicationManager = new SocketCommunicationManager();4socketCommunicationManager.Close();5var socketCommunicationManager = new SocketCommunicationManager();6var data = socketCommunicationManager.ReceiveMessage();7var socketCommunicationManager = new SocketCommunicationManager();8socketCommunicationManager.SendMessage(data);9var socketCommunicationManager = new SocketCommunicationManager();10socketCommunicationManager.Close();11var socketCommunicationManager = new SocketCommunicationManager();12var data = socketCommunicationManager.ReceiveMessage();13var socketCommunicationManager = new SocketCommunicationManager();14socketCommunicationManager.SendMessage(data);15var socketCommunicationManager = new SocketCommunicationManager();16socketCommunicationManager.Close();17var socketCommunicationManager = new SocketCommunicationManager();18var data = socketCommunicationManager.ReceiveMessage();19var socketCommunicationManager = new SocketCommunicationManager();20socketCommunicationManager.SendMessage(data);

SocketCommunicationManager

Using AI Code Generation

1using Microsoft.TestPlatform.Protocol;2SocketCommunicationManager manager = new SocketCommunicationManager();3manager.SetConnectionInfo("localhost", 1234);4manager.InitializeCommunication();5using Microsoft.TestPlatform.CommunicationUtilities;6SocketCommunicationManager manager = new SocketCommunicationManager();7manager.SetConnectionInfo("localhost", 1234);8manager.InitializeCommunication();

SocketCommunicationManager

Using AI Code Generation

1public void SocketCommunicationManagerMethod()2{3    SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();4    socketCommunicationManager.StartClient();5    socketCommunicationManager.SendMessage("message");6    socketCommunicationManager.ReceiveMessage();7    socketCommunicationManager.Close();8}9public void SocketCommunicationManagerMethod()10{11    SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();12    socketCommunicationManager.StartServer();13    socketCommunicationManager.SendMessage("message");14    socketCommunicationManager.ReceiveMessage();15    socketCommunicationManager.Close();16}17public void SocketCommunicationManagerMethod()18{19    SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();20    socketCommunicationManager.StartClient();21    socketCommunicationManager.SendMessage("message");22    socketCommunicationManager.ReceiveMessage();23    socketCommunicationManager.Close();24}25public void SocketCommunicationManagerMethod()26{27    SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();28    socketCommunicationManager.StartServer();29    socketCommunicationManager.SendMessage("message");30    socketCommunicationManager.ReceiveMessage();31    socketCommunicationManager.Close();32}33public void SocketCommunicationManagerMethod()34{35    SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();36    socketCommunicationManager.StartClient();37    socketCommunicationManager.SendMessage("message");38    socketCommunicationManager.ReceiveMessage();39    socketCommunicationManager.Close();40}41public void SocketCommunicationManagerMethod()42{43    SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();44    socketCommunicationManager.StartServer();45    socketCommunicationManager.SendMessage("message");46    socketCommunicationManager.ReceiveMessage();47    socketCommunicationManager.Close();48}49public void SocketCommunicationManagerMethod()50{51    SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();52    socketCommunicationManager.StartClient();53    socketCommunicationManager.SendMessage("message");54    socketCommunicationManager.ReceiveMessage();

SocketCommunicationManager

Using AI Code Generation

1{2    using System;3    using System.Collections.Generic;4    using System.IO;5    using System.Net;6    using System.Net.Sockets;7    using System.Runtime.Serialization;8    using System.Threading;9    using System.Threading.Tasks;10    using Microsoft.VisualStudio.TestPlatform.ObjectModel;11    using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;12    using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine;13    using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine.ClientProtocol;14    using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine.TesthostProtocol;15    using Microsoft.VisualStudio.TestPlatform.PlatformAbstractions.Interfaces;16    using Microsoft.VisualStudio.TestPlatform.Utilities.Helpers;17    using Microsoft.VisualStudio.TestPlatform.Utilities.Helpers.Interfaces;

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.