//****************************************************************************************************** // TcpClient.cs - Gbtc // // Copyright © 2012, Grid Protection Alliance. All Rights Reserved. // // Licensed to the Grid Protection Alliance (GPA) under one or more contributor license agreements. See // the NOTICE file distributed with this work for additional information regarding copyright ownership. // The GPA licenses this file to you under the MIT License (MIT), the "License"; you may // not use this file except in compliance with the License. You may obtain a copy of the License at: // // http://www.opensource.org/licenses/MIT // // Unless agreed to in writing, the subject software distributed under the License is distributed on an // "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Refer to the // License for the specific language governing permissions and limitations. // // Code Modification History: // ---------------------------------------------------------------------------------------------------- // 06/02/2006 - Pinal C. Patel // Original version of source code generated. // 09/06/2006 - J. Ritchie Carroll // Added bypass optimizations for high-speed socket access. // 12/01/2006 - Pinal C. Patel // Modified code for handling "PayloadAware" transmissions. // 09/27/2007 - J. Ritchie Carroll // Added disconnect timeout overload. // 09/29/2008 - J. Ritchie Carroll // Converted to C#. // 07/08/2009 - J. Ritchie Carroll // Added WaitHandle return value from asynchronous connection. // 07/15/2009 - Pinal C. Patel // Modified Disconnect() to add error checking. // 07/17/2009 - Pinal C. Patel // Added support to specify a specific interface address on a multiple interface machine. // 09/14/2009 - Stephen C. Wills // Added new header and license agreement. // 03/24/2010 - Pinal C. Patel // Updated the interpretation of server property in ConnectionString to correctly interpret // IPv6 IP addresses according to IETF - A Recommendation for IPv6 Address Text Representation. // 11/29/2010 - Pinal C. Patel // Corrected the implementation of ConnectAsync() method. // 02/11/2011 - Pinal C. Patel // Added IntegratedSecurity property to enable integrated windows authentication. // 02/13/2011 - Pinal C. Patel // Modified ConnectAsync() to handle loopback address resolution failure on IPv6 enabled OSes. // 09/21/2011 - J. Ritchie Carroll // Added Mono implementation exception regions. // 07/23/2012 - Stephen C. Wills // Performed a full refactor to use the SocketAsyncEventArgs API calls. // 10/31/2012 - Stephen C. Wills // Replaced single-threaded BlockingCollection pattern with asynchronous loop pattern. // 12/13/2012 - Starlynn Danyelle Gilliam // Modified Header. // //****************************************************************************************************** using System; using System.Collections.Concurrent; using System.Collections.Generic; using System.ComponentModel; using System.Linq; using System.Net; using System.Net.Sockets; using System.Text; using System.Text.RegularExpressions; using System.Threading; #if !MONO using System.Net.Security; using System.Security.Authentication; #endif using GSF.Configuration; using GSF.Diagnostics; using GSF.Threading; // ReSharper disable AccessToDisposedClosure namespace GSF.Communication { ///

/// Represents a TCP-based communication client. ///

/// /// The socket can be bound to a specified interface on a machine with multiple interfaces by /// specifying the IP of the interface in the /// (Example: "Server=localhost:8888; Interface=192.168.1.15") /// /// /// This example shows how to use the component: ///


    /// using System;
    /// using GSF;
    /// using GSF.Communication;
    /// using GSF.Security.Cryptography;
    /// using GSF.IO.Compression;
    /// 
    /// class Program
    /// {
    ///     static TcpClient s_client;
    /// 
    ///     static void Main(string[] args)
    ///     {
    ///         // Initialize the client.
    ///         s_client = new TcpClient("Server=localhost:8888");
    ///         s_client.Handshake = false;
    ///         s_client.PayloadAware = false;
    ///         s_client.ReceiveTimeout = -1;
    ///         s_client.MaxConnectionAttempts = 5;
    ///         s_client.Encryption = CipherStrength.None;
    ///         s_client.Compression = CompressionStrength.NoCompression;
    ///         s_client.SecureSession = false;
    ///         s_client.Initialize();
    ///         // Register event handlers.
    ///         s_client.ConnectionAttempt += s_client_ConnectionAttempt;
    ///         s_client.ConnectionEstablished += s_client_ConnectionEstablished;
    ///         s_client.ConnectionTerminated += s_client_ConnectionTerminated;
    ///         s_client.ReceiveDataComplete += s_client_ReceiveDataComplete;
    ///         // Connect the client.
    ///         s_client.Connect();
    /// 
    ///         // Transmit user input to the server.
    ///         string input;
    ///         while (string.Compare(input = Console.ReadLine(), "Exit", true) != 0)
    ///         {
    ///             s_client.Send(input);
    ///         }
    /// 
    ///         // Disconnect the client on shutdown.
    ///         s_client.Dispose();
    ///     }
    /// 
    ///     static void s_client_ConnectionAttempt(object sender, EventArgs e)
    ///     {
    ///         Console.WriteLine("Client is connecting to server.");
    ///     }
    /// 
    ///     static void s_client_ConnectionEstablished(object sender, EventArgs e)
    ///     {
    ///         Console.WriteLine("Client connected to server.");
    ///     }
    /// 
    ///     static void s_client_ConnectionTerminated(object sender, EventArgs e)
    ///     {
    ///         Console.WriteLine("Client disconnected from server.");
    ///     }
    /// 
    ///     static void s_client_ReceiveDataComplete(object sender, EventArgs<byte[], int> e)
    ///     {
    ///         Console.WriteLine(string.Format("Received data - {0}.", s_client.TextEncoding.GetString(e.Argument1, 0, e.Argument2)));
    ///     }
    /// }
    ///

/// // ReSharper disable UnusedVariable public class TcpClient : ClientBase { #region [ Members ] // Nested Types private sealed class ConnectState : IDisposable { public Socket Socket; #if !MONO public NetworkStream NetworkStream; public NegotiateStream NegotiateStream; #endif public readonly SocketAsyncEventArgs ConnectArgs = new SocketAsyncEventArgs(); public SocketAsyncEventArgs ReceiveArgs; public SocketAsyncEventArgs SendArgs; public int ConnectionAttempts; public readonly CancellationToken Token = new CancellationToken(); public ICancellationToken TimeoutToken; public void Dispose() { ConnectArgs.Dispose(); ReceiveArgs?.Dispose(); SendArgs?.Dispose(); Socket?.Dispose(); #if !MONO NetworkStream?.Dispose(); NegotiateStream?.Dispose(); #endif } } private sealed class ReceiveState : IDisposable { public Socket Socket; public SocketAsyncEventArgs ReceiveArgs; public SocketAsyncEventArgs SendArgs; public byte[] Buffer; public int Offset; public int PayloadLength = -1; public CancellationToken Token; public void Dispose() { Dispose(Socket); Dispose(ReceiveArgs); Dispose(SendArgs); } private static void Dispose(IDisposable obj) => obj?.Dispose(); } private sealed class SendState : IDisposable { public Socket Socket; public SocketAsyncEventArgs ReceiveArgs; public SocketAsyncEventArgs SendArgs; public readonly ConcurrentQueue SendQueue = new ConcurrentQueue(); public TcpClientPayload Payload; public int Sending; public CancellationToken Token; public void Dispose() { Dispose(Socket); Dispose(ReceiveArgs); Dispose(SendArgs); while (SendQueue.TryDequeue(out TcpClientPayload payload)) { payload.WaitHandle.Set(); payload.WaitHandle.Dispose(); } } private static void Dispose(IDisposable obj) => obj?.Dispose(); } private class TcpClientPayload { public byte[] Data; public int Offset; public int Length; public ManualResetEvent WaitHandle; } private class CancellationToken { private int m_cancelled; public bool Cancelled => Interlocked.CompareExchange(ref m_cancelled, 0, 0) != 0; public bool Cancel() => Interlocked.Exchange(ref m_cancelled, 1) != 0; } // Constants ///