1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
|
<Type Name="TcpClient" FullName="System.Net.Sockets.TcpClient">
<TypeSignature Language="C#" Value="public class TcpClient : IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.3300.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes>
<Attribute>
<AttributeName>System.Resources.NeutralResourcesLanguageAttribute</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Resources.SatelliteContractVersionAttribute</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.CLSCompliantAttribute</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisibleAttribute</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Security.AllowPartiallyTrustedCallersAttribute</AttributeName>
</Attribute>
</Attributes>
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>A slightly more abstracted way to create an outgoing network connections than a <see cref="T:System.Net.Sockets.Socket" />.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<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>
<summary>Gets rid of all unmanaged resources.</summary>
<param name="disposing">If this is true, it gets rid of all managed resources as well.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected virtual void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Connect">
<MemberSignature Language="C#" Value="public void Connect (string hostname, int port);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="hostname" Type="System.String" />
<Parameter Name="port" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Resolves a fully qualified domain name to an IP address and connects to it on a specified port.</summary>
<param name="hostname">The hostname, e.g. "www.myelin.co.nz".</param>
<param name="port">The port number to connect to, e.g. 80 for HTTP.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Connect">
<MemberSignature Language="C#" Value="public void Connect (Net.IPAddress address, int port);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="address" Type="System.Net.IPAddress" />
<Parameter Name="port" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Connects to an IP address on a port.</summary>
<param name="address">The remote <see cref="T:System.Net.IPAddress" />.</param>
<param name="port">The port number to connect to, e.g. 80 for HTTP.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Connect">
<MemberSignature Language="C#" Value="public void Connect (Net.IPEndPoint remoteEP);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="remoteEP" Type="System.Net.IPEndPoint" />
</Parameters>
<Docs>
<summary>Connects to a specified remote endpoint.</summary>
<param name="remoteEP">The remote EndPoint.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetStream">
<MemberSignature Language="C#" Value="public NetworkStream GetStream ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Net.Sockets.NetworkStream</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Gets the <see cref="T:System.Net.Sockets.NetworkStream" /> object connected to the connection socket.</summary>
<returns>The <see cref="T:System.Net.Sockets.NetworkStream" /> object connected to the connection socket.</returns>
<remarks>To be added</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 socket and disposes of all managed resources. Throws <see cref="T:System.Net.Sockets.SocketException" /> if something goes wrong while closing the socket.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TcpClient (Net.IPEndPoint localEP);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="localEP" Type="System.Net.IPEndPoint" />
</Parameters>
<Docs>
<summary>Constructs a new TcpClient with a specified local endpoint. Use this if you want to have your connections originating from a certain port, or a certain IP (on a multi homed system).
</summary>
<param name="localEP">The aforementioned local endpoint</param>
<returns>The new constructed TcpClient.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TcpClient ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary> Constructs a new TcpClient with no connection set up.</summary>
<returns>The new constructed TcpClient.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TcpClient (string hostname, int port);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="hostname" Type="System.String" />
<Parameter Name="port" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Constructs a new TcpClient and connects to a specified host on a specified port. A quick way to set up a network connection.</summary>
<param name="hostname">The host to connect to, e.g. "192.168.0.201" or "www.myelin.co.nz"</param>
<param name="port">The port to connect to, e.g. 80 for HTTP</param>
<returns>The new constructed TcpClient.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Client">
<MemberSignature Language="C#" Value="protected Socket Client { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Net.Sockets.Socket</ReturnType>
</ReturnValue>
<Docs>
<summary>The <see cref="T:System.Net.Sockets.Socket" /> that all network communications passes through.</summary>
<returns>The <see cref="T:System.Net.Sockets.Socket" />.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Active">
<MemberSignature Language="C#" Value="protected bool Active { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>A flag that is 'true' if the TcpClient has an active connection</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ReceiveBufferSize">
<MemberSignature Language="C#" Value="public int ReceiveBufferSize { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>How big the receive buffer is (from the connection socket).</summary>
<param name="value">The new buffer size.</param>
<returns>The buffer size.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SendBufferSize">
<MemberSignature Language="C#" Value="public int SendBufferSize { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>How big the send buffer is (from the connection socket).</summary>
<param name="value">The new buffer size.</param>
<returns>The buffer size.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ReceiveTimeout">
<MemberSignature Language="C#" Value="public int ReceiveTimeout { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>How long before the socket will time out on a Receive() call.</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SendTimeout">
<MemberSignature Language="C#" Value="public int SendTimeout { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary> How long before the socket will time out on a Send() call.</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="LingerState">
<MemberSignature Language="C#" Value="public LingerOption LingerState { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Net.Sockets.LingerOption</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<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>
<param name="value">To be added: an object of type 'LingerOption'</param>
<returns>To be added: an object of type 'LingerOption'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="NoDelay">
<MemberSignature Language="C#" Value="public bool NoDelay { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>If set, outbound data will be sent at once rather than collected until enough is available to fill a packet. This is the TCP_NODELAY sockopt from BSD sockets and WinSock. For more information, look up the Nagle algorithm.</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>
|