379 lines
16 KiB
XML
379 lines
16 KiB
XML
<Type Name="UnixClient" FullName="Mono.Unix.UnixClient">
|
|
<TypeSignature Language="C#" Value="public class UnixClient : MarshalByRefObject, IDisposable" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit UnixClient extends System.MarshalByRefObject implements class System.IDisposable" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>Mono.Posix</AssemblyName>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.MarshalByRefObject</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>System.IDisposable</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Docs>
|
|
<summary>A class to provide client connections to Unix domain socket servers.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public UnixClient ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Creates a new UnixClient with no connection.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public UnixClient (Mono.Unix.UnixEndPoint ep);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Mono.Unix.UnixEndPoint ep) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters>
|
|
<Parameter Name="ep" Type="Mono.Unix.UnixEndPoint" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="ep">
|
|
<see cref="T:Mono.Unix.UnixEndPoint" /> to connect to.</param>
|
|
<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 />
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="ep" /> is <see langword="null" />.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public UnixClient (string path);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string path) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<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>
|
|
<remarks />
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="path" /> is <see langword="null" />.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Client">
|
|
<MemberSignature Language="C#" Value="public System.Net.Sockets.Socket Client { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.Sockets.Socket Client" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<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="Close">
|
|
<MemberSignature Language="C#" Value="public void Close ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Close() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Closes the connection</summary>
|
|
<remarks />
|
|
<exception cref="T:System.ObjectDisposedException">
|
|
Instance has been disposed.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Connect">
|
|
<MemberSignature Language="C#" Value="public void Connect (Mono.Unix.UnixEndPoint remoteEndPoint);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Connect(class Mono.Unix.UnixEndPoint remoteEndPoint) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<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>
|
|
<remarks />
|
|
<exception cref="T:System.ObjectDisposedException">
|
|
Instance has been disposed.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Connect">
|
|
<MemberSignature Language="C#" Value="public void Connect (string path);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Connect(string path) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<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>
|
|
<remarks />
|
|
<exception cref="T:System.ObjectDisposedException">
|
|
Instance has been disposed.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Dispose">
|
|
<MemberSignature Language="C#" Value="public void Dispose ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<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);" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<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="Finalize">
|
|
<MemberSignature Language="C#" Value="~UnixClient ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Finalize() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<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 ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Net.Sockets.NetworkStream GetStream() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<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>
|
|
<returns>The <see cref="T:System.Net.Sockets.NetworkStream" /> for this client.</returns>
|
|
<remarks />
|
|
<exception cref="T:System.ObjectDisposedException">
|
|
Instance has been disposed.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="LingerState">
|
|
<MemberSignature Language="C#" Value="public System.Net.Sockets.LingerOption LingerState { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.Sockets.LingerOption LingerState" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<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>
|
|
<value>
|
|
<see cref="T:System.Net.Sockets.LingerOption" />
|
|
</value>
|
|
<remarks />
|
|
<exception cref="T:System.ObjectDisposedException">
|
|
Instance has been disposed.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PeerCredential">
|
|
<MemberSignature Language="C#" Value="public Mono.Unix.PeerCred PeerCredential { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class Mono.Unix.PeerCred PeerCredential" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>Mono.Unix.PeerCred</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Gets the credentials for the other side of the Unix domain socket connection.</summary>
|
|
<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>
|
|
<exception cref="T:System.ObjectDisposedException">
|
|
Instance has been disposed.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ReceiveBufferSize">
|
|
<MemberSignature Language="C#" Value="public int ReceiveBufferSize { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 ReceiveBufferSize" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>The size of the receive buffer</summary>
|
|
<value>The size of the receive buffer, in bytes. The default value is 8192 bytes.</value>
|
|
<remarks />
|
|
<exception cref="T:System.ObjectDisposedException">
|
|
Instance has been disposed.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ReceiveTimeout">
|
|
<MemberSignature Language="C#" Value="public int ReceiveTimeout { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 ReceiveTimeout" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>The amount of time to wait when receiving data once a read has started.</summary>
|
|
<value>Amount of time to wait, in milliseconds. The default is 0, which means no timeout.</value>
|
|
<remarks />
|
|
<exception cref="T:System.ObjectDisposedException">
|
|
Instance has been disposed.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SendBufferSize">
|
|
<MemberSignature Language="C#" Value="public int SendBufferSize { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 SendBufferSize" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>The size of the send buffer.</summary>
|
|
<value>The size of the send buffer, in bytes. The default value is 8192 bytes.</value>
|
|
<remarks />
|
|
<exception cref="T:System.ObjectDisposedException">
|
|
Instance has been disposed.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SendTimeout">
|
|
<MemberSignature Language="C#" Value="public int SendTimeout { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 SendTimeout" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>The amount of time to wait when sending data once a write has started. </summary>
|
|
<value>Amount of time to wait, in milliseconds. The default is 0, which means no timeout.</value>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.ObjectDisposedException">
|
|
Instance has been disposed.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|