<Type Name="UnixClient" FullName="Mono.Unix.UnixClient">
  <TypeSignature Language="C#" Value="public class UnixClient : MarshalByRefObject, IDisposable" />
  <AssemblyInfo>
    <AssemblyName>Mono.Posix</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.MarshalByRefObject</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
  </Interfaces>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public UnixClient ();" />
      <MemberType>Constructor</MemberType>
      <Parameters />
      <Docs>
        <summary>Creates a new UnixClient with no connection.</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public UnixClient (string path);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="path" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="path">A file system path to the Unix domain socket to connect to.</param>
        <summary>Create a new UnixClient and connect to the server specified by path.</summary>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="path" /> is <see langword="null" />.
        </exception>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public UnixClient (Mono.Unix.UnixEndPoint ep);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="ep" Type="Mono.Unix.UnixEndPoint" />
      </Parameters>
      <Docs>
        <param name="ep">
          <see cref="T:Mono.Unix.UnixEndPoint" /> to connect to.</param>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="ep" /> is <see langword="null" />.
        </exception>
        <summary>Creates a new UnixClient and establishes a connection to the passed in <see cref="T:Mono.Unix.UnixEndPoint" />.  Most of the time users will want to use the <see cref="C:Mono.Unix.UnixClient(System.String)" /> constructor instead, unless you already have a <see cref="T:Mono.Unix.UnixEndPoint" />.</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Close">
      <MemberSignature Language="C#" Value="public void Close ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Closes the connection</summary>
        <exception cref="T:System.ObjectDisposedException">
          Instance has been disposed.
        </exception>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Connect">
      <MemberSignature Language="C#" Value="public void Connect (Mono.Unix.UnixEndPoint remoteEndPoint);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="remoteEndPoint" Type="Mono.Unix.UnixEndPoint" />
      </Parameters>
      <Docs>
        <param name="remoteEndPoint">The <see cref="T:Mono.Unix.UnixEndPoint" /> to connect to.</param>
        <summary>Connects to a Unix domain socket specified by the endpoint.</summary>
        <exception cref="T:System.ObjectDisposedException">
          Instance has been disposed.
        </exception>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Connect">
      <MemberSignature Language="C#" Value="public void Connect (string path);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="path" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="path">A file system path pointing to the Unix domain socket</param>
        <summary>Connects to a Unix domain socket specified by path.</summary>
        <exception cref="T:System.ObjectDisposedException">
          Instance has been disposed.
        </exception>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="public void Dispose ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Disposes of all managed resources of this UnixClient.</summary>
        <remarks>This will close the network connection, if any.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="disposing" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="disposing">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetStream">
      <MemberSignature Language="C#" Value="public System.Net.Sockets.NetworkStream GetStream ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.Sockets.NetworkStream</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets the underlying <see cref="T:System.Net.Sockets.NetworkStream" /> for this UnixClient.</summary>
        <exception cref="T:System.ObjectDisposedException">
          Instance has been disposed.
        </exception>
        <returns>The <see cref="T:System.Net.Sockets.NetworkStream" /> for this client.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Client">
      <MemberSignature Language="C#" Value="protected System.Net.Sockets.Socket Client { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.Sockets.Socket</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The underlying <see cref="T:System.Net.Sockets.Socket" /> for this UnixClient.</summary>
        <value>The <see cref="T:System.Net.Sockets.Socket" /> for the underlying connection.</value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="PeerCredential">
      <MemberSignature Language="C#" Value="public Mono.Unix.PeerCred PeerCredential { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Mono.Unix.PeerCred</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the credentials for the other side of the Unix domain socket connection.</summary>
        <exception cref="T:System.ObjectDisposedException">
          Instance has been disposed.
        </exception>
        <value>
          <see cref="T:Mono.Unix.PeerCred" />
        </value>
        <remarks>Not all operating systems support peer credentials on Unix domain sockets.  This might not be available on all systems.</remarks>
      </Docs>
    </Member>
    <Member MemberName="LingerState">
      <MemberSignature Language="C#" Value="public System.Net.Sockets.LingerOption LingerState { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.Sockets.LingerOption</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>If set, the socket will remain open after it has been instructed to close, in order to send data that remains in the buffer.</summary>
        <exception cref="T:System.ObjectDisposedException">
          Instance has been disposed.
        </exception>
        <value>
          <see cref="T:System.Net.Sockets.LingerOption" />
        </value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="ReceiveBufferSize">
      <MemberSignature Language="C#" Value="public int ReceiveBufferSize { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The size of the receive buffer</summary>
        <exception cref="T:System.ObjectDisposedException">
          Instance has been disposed.
        </exception>
        <value>The size of the receive buffer, in bytes.  The default value is 8192 bytes.</value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="ReceiveTimeout">
      <MemberSignature Language="C#" Value="public int ReceiveTimeout { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The amount of time to wait when receiving data once a read has started.</summary>
        <exception cref="T:System.ObjectDisposedException">
          Instance has been disposed.
        </exception>
        <value>Amount of time to wait, in milliseconds.  The default is 0, which means no timeout.</value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="SendBufferSize">
      <MemberSignature Language="C#" Value="public int SendBufferSize { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The size of the send buffer.</summary>
        <exception cref="T:System.ObjectDisposedException">
          Instance has been disposed.
        </exception>
        <value>The size of the send buffer, in bytes. The default value is 8192 bytes.</value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="SendTimeout">
      <MemberSignature Language="C#" Value="public int SendTimeout { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The amount of time to wait when sending data once a write has started. </summary>
        <exception cref="T:System.ObjectDisposedException">
          Instance has been disposed.
        </exception>
        <value>Amount of time to wait, in milliseconds. The default is 0, which means no timeout.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Finalize">
      <MemberSignature Language="C#" Value="~UnixClient ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
  <Docs>
    <summary>A class to provide client connections to Unix domain socket servers.</summary>
    <remarks />
  </Docs>
</Type>
