mcs/class/Mono.Posix/Documentation/en/Mono.Unix/UnixClient.xml

   1 <Type Name="UnixClient" FullName="Mono.Unix.UnixClient">
   2   <TypeSignature Language="C#" Value="public class UnixClient : MarshalByRefObject, IDisposable" />
   3   <AssemblyInfo>
   4     <AssemblyName>Mono.Posix</AssemblyName>
   5     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.MarshalByRefObject</BaseTypeName>
  10   </Base>
  11   <Interfaces>
  12     <Interface>
  13       <InterfaceName>System.IDisposable</InterfaceName>
  14     </Interface>
  15   </Interfaces>
  16   <Docs>
  17     <summary>A class to provide client connections to Unix domain socket servers.</summary>
  18     <remarks />
  19   </Docs>
  20   <Members>
  21     <Member MemberName=".ctor">
  22       <MemberSignature Language="C#" Value="public UnixClient ();" />
  23       <MemberType>Constructor</MemberType>
  24       <Parameters />
  25       <Docs>
  26         <summary>Creates a new UnixClient with no connection.</summary>
  27         <remarks />
  28       </Docs>
  29       <AssemblyInfo>
  30         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  31         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  32       </AssemblyInfo>
  33     </Member>
  34     <Member MemberName=".ctor">
  35       <MemberSignature Language="C#" Value="public UnixClient (Mono.Unix.UnixEndPoint ep);" />
  36       <MemberType>Constructor</MemberType>
  37       <Parameters>
  38         <Parameter Name="ep" Type="Mono.Unix.UnixEndPoint" />
  39       </Parameters>
  40       <Docs>
  41         <param name="ep">
  42           <see cref="T:Mono.Unix.UnixEndPoint" /> to connect to.</param>
  43         <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>
  44         <remarks />
  45         <exception cref="T:System.ArgumentNullException">
  46           <paramref name="ep" /> is <see langword="null" />.
  47         </exception>
  48       </Docs>
  49       <AssemblyInfo>
  50         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  51         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  52       </AssemblyInfo>
  53     </Member>
  54     <Member MemberName=".ctor">
  55       <MemberSignature Language="C#" Value="public UnixClient (string path);" />
  56       <MemberType>Constructor</MemberType>
  57       <Parameters>
  58         <Parameter Name="path" Type="System.String" />
  59       </Parameters>
  60       <Docs>
  61         <param name="path">A file system path to the Unix domain socket to connect to.</param>
  62         <summary>Create a new UnixClient and connect to the server specified by path.</summary>
  63         <remarks />
  64         <exception cref="T:System.ArgumentNullException">
  65           <paramref name="path" /> is <see langword="null" />.
  66         </exception>
  67       </Docs>
  68       <AssemblyInfo>
  69         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  70         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  71       </AssemblyInfo>
  72     </Member>
  73     <Member MemberName="Client">
  74       <MemberSignature Language="C#" Value="public System.Net.Sockets.Socket Client { set; get; }" />
  75       <MemberType>Property</MemberType>
  76       <ReturnValue>
  77         <ReturnType>System.Net.Sockets.Socket</ReturnType>
  78       </ReturnValue>
  79       <Docs>
  80         <summary>The underlying <see cref="T:System.Net.Sockets.Socket" /> for this UnixClient.</summary>
  81         <value>The <see cref="T:System.Net.Sockets.Socket" /> for the underlying connection.</value>
  82         <remarks />
  83       </Docs>
  84       <AssemblyInfo>
  85         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  86         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  87       </AssemblyInfo>
  88     </Member>
  89     <Member MemberName="Close">
  90       <MemberSignature Language="C#" Value="public void Close ();" />
  91       <MemberType>Method</MemberType>
  92       <ReturnValue>
  93         <ReturnType>System.Void</ReturnType>
  94       </ReturnValue>
  95       <Parameters />
  96       <Docs>
  97         <summary>Closes the connection</summary>
  98         <remarks />
  99         <exception cref="T:System.ObjectDisposedException">
 100           Instance has been disposed.
 101         </exception>
 102       </Docs>
 103       <AssemblyInfo>
 104         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 105         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 106       </AssemblyInfo>
 107     </Member>
 108     <Member MemberName="Connect">
 109       <MemberSignature Language="C#" Value="public void Connect (Mono.Unix.UnixEndPoint remoteEndPoint);" />
 110       <MemberType>Method</MemberType>
 111       <ReturnValue>
 112         <ReturnType>System.Void</ReturnType>
 113       </ReturnValue>
 114       <Parameters>
 115         <Parameter Name="remoteEndPoint" Type="Mono.Unix.UnixEndPoint" />
 116       </Parameters>
 117       <Docs>
 118         <param name="remoteEndPoint">The <see cref="T:Mono.Unix.UnixEndPoint" /> to connect to.</param>
 119         <summary>Connects to a Unix domain socket specified by the endpoint.</summary>
 120         <remarks />
 121         <exception cref="T:System.ObjectDisposedException">
 122           Instance has been disposed.
 123         </exception>
 124       </Docs>
 125       <AssemblyInfo>
 126         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 127         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 128       </AssemblyInfo>
 129     </Member>
 130     <Member MemberName="Connect">
 131       <MemberSignature Language="C#" Value="public void Connect (string path);" />
 132       <MemberType>Method</MemberType>
 133       <ReturnValue>
 134         <ReturnType>System.Void</ReturnType>
 135       </ReturnValue>
 136       <Parameters>
 137         <Parameter Name="path" Type="System.String" />
 138       </Parameters>
 139       <Docs>
 140         <param name="path">A file system path pointing to the Unix domain socket</param>
 141         <summary>Connects to a Unix domain socket specified by path.</summary>
 142         <remarks />
 143         <exception cref="T:System.ObjectDisposedException">
 144           Instance has been disposed.
 145         </exception>
 146       </Docs>
 147       <AssemblyInfo>
 148         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 149         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 150       </AssemblyInfo>
 151     </Member>
 152     <Member MemberName="Dispose">
 153       <MemberSignature Language="C#" Value="public void Dispose ();" />
 154       <MemberType>Method</MemberType>
 155       <ReturnValue>
 156         <ReturnType>System.Void</ReturnType>
 157       </ReturnValue>
 158       <Parameters />
 159       <Docs>
 160         <summary>Disposes of all managed resources of this UnixClient.</summary>
 161         <remarks>This will close the network connection, if any.</remarks>
 162       </Docs>
 163       <AssemblyInfo>
 164         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 165         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 166       </AssemblyInfo>
 167     </Member>
 168     <Member MemberName="Dispose">
 169       <MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
 170       <MemberType>Method</MemberType>
 171       <ReturnValue>
 172         <ReturnType>System.Void</ReturnType>
 173       </ReturnValue>
 174       <Parameters>
 175         <Parameter Name="disposing" Type="System.Boolean" />
 176       </Parameters>
 177       <Docs>
 178         <param name="disposing">To be added.</param>
 179         <summary>To be added.</summary>
 180         <remarks>To be added.</remarks>
 181       </Docs>
 182       <AssemblyInfo>
 183         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 184         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 185       </AssemblyInfo>
 186     </Member>
 187     <Member MemberName="Finalize">
 188       <MemberSignature Language="C#" Value="~UnixClient ();" />
 189       <MemberType>Method</MemberType>
 190       <ReturnValue>
 191         <ReturnType>System.Void</ReturnType>
 192       </ReturnValue>
 193       <Parameters />
 194       <Docs>
 195         <summary>To be added.</summary>
 196         <remarks>To be added.</remarks>
 197       </Docs>
 198       <AssemblyInfo>
 199         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 200         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 201       </AssemblyInfo>
 202     </Member>
 203     <Member MemberName="GetStream">
 204       <MemberSignature Language="C#" Value="public System.Net.Sockets.NetworkStream GetStream ();" />
 205       <MemberType>Method</MemberType>
 206       <ReturnValue>
 207         <ReturnType>System.Net.Sockets.NetworkStream</ReturnType>
 208       </ReturnValue>
 209       <Parameters />
 210       <Docs>
 211         <summary>Gets the underlying <see cref="T:System.Net.Sockets.NetworkStream" /> for this UnixClient.</summary>
 212         <returns>The <see cref="T:System.Net.Sockets.NetworkStream" /> for this client.</returns>
 213         <remarks />
 214         <exception cref="T:System.ObjectDisposedException">
 215           Instance has been disposed.
 216         </exception>
 217       </Docs>
 218       <AssemblyInfo>
 219         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 220         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 221       </AssemblyInfo>
 222     </Member>
 223     <Member MemberName="LingerState">
 224       <MemberSignature Language="C#" Value="public System.Net.Sockets.LingerOption LingerState { set; get; }" />
 225       <MemberType>Property</MemberType>
 226       <ReturnValue>
 227         <ReturnType>System.Net.Sockets.LingerOption</ReturnType>
 228       </ReturnValue>
 229       <Docs>
 230         <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>
 231         <value>
 232           <see cref="T:System.Net.Sockets.LingerOption" />
 233         </value>
 234         <remarks />
 235         <exception cref="T:System.ObjectDisposedException">
 236           Instance has been disposed.
 237         </exception>
 238       </Docs>
 239       <AssemblyInfo>
 240         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 241         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 242       </AssemblyInfo>
 243     </Member>
 244     <Member MemberName="PeerCredential">
 245       <MemberSignature Language="C#" Value="public Mono.Unix.PeerCred PeerCredential { get; }" />
 246       <MemberType>Property</MemberType>
 247       <ReturnValue>
 248         <ReturnType>Mono.Unix.PeerCred</ReturnType>
 249       </ReturnValue>
 250       <Docs>
 251         <summary>Gets the credentials for the other side of the Unix domain socket connection.</summary>
 252         <value>
 253           <see cref="T:Mono.Unix.PeerCred" />
 254         </value>
 255         <remarks>Not all operating systems support peer credentials on Unix domain sockets.  This might not be available on all systems.</remarks>
 256         <exception cref="T:System.ObjectDisposedException">
 257           Instance has been disposed.
 258         </exception>
 259       </Docs>
 260       <AssemblyInfo>
 261         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 262         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 263       </AssemblyInfo>
 264     </Member>
 265     <Member MemberName="ReceiveBufferSize">
 266       <MemberSignature Language="C#" Value="public int ReceiveBufferSize { set; get; }" />
 267       <MemberType>Property</MemberType>
 268       <ReturnValue>
 269         <ReturnType>System.Int32</ReturnType>
 270       </ReturnValue>
 271       <Docs>
 272         <summary>The size of the receive buffer</summary>
 273         <value>The size of the receive buffer, in bytes.  The default value is 8192 bytes.</value>
 274         <remarks />
 275         <exception cref="T:System.ObjectDisposedException">
 276           Instance has been disposed.
 277         </exception>
 278       </Docs>
 279       <AssemblyInfo>
 280         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 281         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 282       </AssemblyInfo>
 283     </Member>
 284     <Member MemberName="ReceiveTimeout">
 285       <MemberSignature Language="C#" Value="public int ReceiveTimeout { set; get; }" />
 286       <MemberType>Property</MemberType>
 287       <ReturnValue>
 288         <ReturnType>System.Int32</ReturnType>
 289       </ReturnValue>
 290       <Docs>
 291         <summary>The amount of time to wait when receiving data once a read has started.</summary>
 292         <value>Amount of time to wait, in milliseconds.  The default is 0, which means no timeout.</value>
 293         <remarks />
 294         <exception cref="T:System.ObjectDisposedException">
 295           Instance has been disposed.
 296         </exception>
 297       </Docs>
 298       <AssemblyInfo>
 299         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 300         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 301       </AssemblyInfo>
 302     </Member>
 303     <Member MemberName="SendBufferSize">
 304       <MemberSignature Language="C#" Value="public int SendBufferSize { set; get; }" />
 305       <MemberType>Property</MemberType>
 306       <ReturnValue>
 307         <ReturnType>System.Int32</ReturnType>
 308       </ReturnValue>
 309       <Docs>
 310         <summary>The size of the send buffer.</summary>
 311         <value>The size of the send buffer, in bytes. The default value is 8192 bytes.</value>
 312         <remarks />
 313         <exception cref="T:System.ObjectDisposedException">
 314           Instance has been disposed.
 315         </exception>
 316       </Docs>
 317       <AssemblyInfo>
 318         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 319         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 320       </AssemblyInfo>
 321     </Member>
 322     <Member MemberName="SendTimeout">
 323       <MemberSignature Language="C#" Value="public int SendTimeout { set; get; }" />
 324       <MemberType>Property</MemberType>
 325       <ReturnValue>
 326         <ReturnType>System.Int32</ReturnType>
 327       </ReturnValue>
 328       <Docs>
 329         <summary>The amount of time to wait when sending data once a write has started. </summary>
 330         <value>Amount of time to wait, in milliseconds. The default is 0, which means no timeout.</value>
 331         <remarks>To be added.</remarks>
 332         <exception cref="T:System.ObjectDisposedException">
 333           Instance has been disposed.
 334         </exception>
 335       </Docs>
 336       <AssemblyInfo>
 337         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 338         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 339       </AssemblyInfo>
 340     </Member>
 341   </Members>
 342 </Type>