1 // System.Net.Sockets.Socket.cs
4 // Phillip Pearson (pp@myelin.co.nz)
5 // Dick Porter <dick@ximian.com>
6 // Gonzalo Paniagua Javier (gonzalo@ximian.com)
7 // Sridhar Kulkarni (sridharkulkarni@gmail.com)
8 // Brian Nickel (brian.nickel@gmail.com)
10 // Copyright (C) 2001, 2002 Phillip Pearson and Ximian, Inc.
11 // http://www.myelin.co.nz
12 // (c) 2004-2006 Novell, Inc. (http://www.novell.com)
16 // Permission is hereby granted, free of charge, to any person obtaining
17 // a copy of this software and associated documentation files (the
18 // "Software"), to deal in the Software without restriction, including
19 // without limitation the rights to use, copy, modify, merge, publish,
20 // distribute, sublicense, and/or sell copies of the Software, and to
21 // permit persons to whom the Software is furnished to do so, subject to
22 // the following conditions:
24 // The above copyright notice and this permission notice shall be
25 // included in all copies or substantial portions of the Software.
27 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
28 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
29 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
30 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
31 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
32 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
33 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38 using System.Collections;
39 using System.Runtime.CompilerServices;
40 using System.Runtime.InteropServices;
41 using System.Threading;
43 using System.Security;
47 using System.Net.Configuration;
51 using System.Collections.Generic;
53 using System.Net.NetworkInformation;
57 namespace System.Net.Sockets {
59 public partial class Socket : IDisposable {
62 * These two fields are looked up by name by the runtime, don't change
63 * their name without also updating the runtime code.
65 private static int ipv4Supported = -1, ipv6Supported = -1;
70 // initialize ipv4Supported and ipv6Supported
71 CheckProtocolSupport ();
74 internal static void CheckProtocolSupport ()
76 if(ipv4Supported == -1) {
78 Socket tmp = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
87 if (ipv6Supported == -1) {
89 #if NET_2_0 && CONFIGURATION_DEP
90 SettingsSection config;
91 config = (SettingsSection) System.Configuration.ConfigurationManager.GetSection ("system.net/settings");
93 ipv6Supported = config.Ipv6.Enabled ? -1 : 0;
95 NetConfig config = System.Configuration.ConfigurationSettings.GetConfig("system.net/settings") as NetConfig;
97 ipv6Supported = config.ipv6Enabled ? -1 : 0;
100 if (ipv6Supported != 0) {
102 Socket tmp = new Socket(AddressFamily.InterNetworkV6, SocketType.Stream, ProtocolType.Tcp);
113 public static bool SupportsIPv4 {
115 CheckProtocolSupport();
116 return ipv4Supported == 1;
121 [ObsoleteAttribute ("Use OSSupportsIPv6 instead")]
123 public static bool SupportsIPv6 {
125 CheckProtocolSupport();
126 return ipv6Supported == 1;
130 public static bool OSSupportsIPv4 {
132 CheckProtocolSupport();
133 return ipv4Supported == 1;
138 public static bool OSSupportsIPv6 {
140 CheckProtocolSupport();
141 return ipv6Supported == 1;
145 public static bool OSSupportsIPv6 {
147 NetworkInterface[] nics = NetworkInterface.GetAllNetworkInterfaces ();
149 foreach (NetworkInterface adapter in nics) {
150 if (adapter.Supports (NetworkInterfaceComponent.IPv6))
158 /* the field "socket" is looked up by name by the runtime */
159 private IntPtr socket;
160 private AddressFamily address_family;
161 private SocketType socket_type;
162 private ProtocolType protocol_type;
163 internal bool blocking=true;
164 Thread blocking_thread;
166 private bool isbound;
168 /* When true, the socket was connected at the time of
169 * the last IO operation
171 private bool connected;
172 /* true if we called Close_internal */
174 internal bool disposed;
177 * This EndPoint is used when creating new endpoints. Because
178 * there are many types of EndPoints possible,
179 * seed_endpoint.Create(addr) is used for creating new ones.
180 * As such, this value is set on Bind, SentTo, ReceiveFrom,
183 internal EndPoint seed_endpoint = null;
186 // Creates a new system socket, returning the handle
187 [MethodImplAttribute(MethodImplOptions.InternalCall)]
188 private extern IntPtr Socket_internal(AddressFamily family,
194 public Socket(AddressFamily family, SocketType type, ProtocolType proto)
197 if (family == AddressFamily.Unspecified)
198 throw new ArgumentException ("family");
200 address_family=family;
206 socket = Socket_internal (family, type, proto, out error);
208 throw new SocketException (error);
220 public AddressFamily AddressFamily {
221 get { return address_family; }
225 [MethodImplAttribute(MethodImplOptions.InternalCall)]
226 private extern static void Blocking_internal(IntPtr socket,
230 #if !NET_2_1 || MONOTOUCH
231 public bool Blocking {
236 if (disposed && closed)
237 throw new ObjectDisposedException (GetType ().ToString ());
241 Blocking_internal (socket, value, out error);
244 throw new SocketException (error);
250 public bool Connected {
251 get { return connected; }
252 internal set { connected = value; }
255 public ProtocolType ProtocolType {
256 get { return protocol_type; }
259 public bool NoDelay {
261 if (disposed && closed)
262 throw new ObjectDisposedException (GetType ().ToString ());
266 return (int)(GetSocketOption (
267 SocketOptionLevel.Tcp,
268 SocketOptionName.NoDelay)) != 0;
272 if (disposed && closed)
273 throw new ObjectDisposedException (GetType ().ToString ());
278 SocketOptionLevel.Tcp,
279 SocketOptionName.NoDelay, value ? 1 : 0);
283 public int ReceiveBufferSize {
285 if (disposed && closed) {
286 throw new ObjectDisposedException (GetType ().ToString ());
288 return((int)GetSocketOption (SocketOptionLevel.Socket, SocketOptionName.ReceiveBuffer));
291 if (disposed && closed) {
292 throw new ObjectDisposedException (GetType ().ToString ());
295 throw new ArgumentOutOfRangeException ("value", "The value specified for a set operation is less than zero");
298 SetSocketOption (SocketOptionLevel.Socket, SocketOptionName.ReceiveBuffer, value);
302 public int SendBufferSize {
304 if (disposed && closed) {
305 throw new ObjectDisposedException (GetType ().ToString ());
307 return((int)GetSocketOption (SocketOptionLevel.Socket, SocketOptionName.SendBuffer));
310 if (disposed && closed) {
311 throw new ObjectDisposedException (GetType ().ToString ());
314 throw new ArgumentOutOfRangeException ("value", "The value specified for a set operation is less than zero");
317 SetSocketOption (SocketOptionLevel.Socket,
318 SocketOptionName.SendBuffer,
325 if (disposed && closed) {
326 throw new ObjectDisposedException (GetType ().ToString ());
331 if (address_family == AddressFamily.InterNetwork) {
332 ttl_val = (short)((int)GetSocketOption (SocketOptionLevel.IP, SocketOptionName.IpTimeToLive));
333 } else if (address_family == AddressFamily.InterNetworkV6) {
334 ttl_val = (short)((int)GetSocketOption (SocketOptionLevel.IPv6, SocketOptionName.HopLimit));
336 throw new NotSupportedException ("This property is only valid for InterNetwork and InterNetworkV6 sockets");
342 if (disposed && closed) {
343 throw new ObjectDisposedException (GetType ().ToString ());
346 if (address_family == AddressFamily.InterNetwork) {
347 SetSocketOption (SocketOptionLevel.IP, SocketOptionName.IpTimeToLive, value);
348 } else if (address_family == AddressFamily.InterNetworkV6) {
349 SetSocketOption (SocketOptionLevel.IPv6, SocketOptionName.HopLimit, value);
351 throw new NotSupportedException ("This property is only valid for InterNetwork and InterNetworkV6 sockets");
356 // Returns the remote endpoint details in addr and port
357 [MethodImplAttribute(MethodImplOptions.InternalCall)]
358 private extern static SocketAddress RemoteEndPoint_internal(IntPtr socket, out int error);
360 public EndPoint RemoteEndPoint {
362 if (disposed && closed)
363 throw new ObjectDisposedException (GetType ().ToString ());
366 * If the seed EndPoint is null, Connect, Bind,
367 * etc has not yet been called. MS returns null
370 if (seed_endpoint == null)
376 sa=RemoteEndPoint_internal(socket, out error);
379 throw new SocketException (error);
381 return seed_endpoint.Create (sa);
385 void Linger (IntPtr handle)
387 if (linger_timeout <= 0)
390 // We don't want to receive any more data
392 Shutdown_internal (handle, SocketShutdown.Receive, out error);
396 int seconds = linger_timeout / 1000;
397 int ms = linger_timeout % 1000;
399 // If the other end closes, this will return 'true' with 'Available' == 0
400 Poll_internal (handle, SelectMode.SelectRead, ms * 1000, out error);
406 LingerOption linger = new LingerOption (true, seconds);
407 SetSocketOption_internal (handle, SocketOptionLevel.Socket, SocketOptionName.Linger, linger, null, 0, out error);
408 /* Not needed, we're closing upon return */
414 protected virtual void Dispose (bool explicitDisposing)
421 if ((int) socket != -1) {
425 socket = (IntPtr) (-1);
426 Thread th = blocking_thread;
429 blocking_thread = null;
433 //DateTime start = DateTime.UtcNow;
434 Close_internal (x, out error);
435 //Console.WriteLine ("Time spent in Close_internal: {0}ms", (DateTime.UtcNow - start).TotalMilliseconds);
437 throw new SocketException (error);
442 public void Dispose ()
444 void IDisposable.Dispose ()
448 GC.SuppressFinalize (this);
452 [MethodImplAttribute(MethodImplOptions.InternalCall)]
453 private extern static void Close_internal(IntPtr socket, out int error);
458 ((IDisposable) this).Dispose ();
462 public void Close (int timeout)
464 linger_timeout = timeout;
465 ((IDisposable) this).Dispose ();
469 // Connects to the remote address
470 [MethodImplAttribute(MethodImplOptions.InternalCall)]
471 private extern static void Connect_internal(IntPtr sock,
475 public void Connect (EndPoint remoteEP)
477 SocketAddress serial = null;
479 if (disposed && closed)
480 throw new ObjectDisposedException (GetType ().ToString ());
482 if (remoteEP == null)
483 throw new ArgumentNullException ("remoteEP");
485 IPEndPoint ep = remoteEP as IPEndPoint;
487 if (ep.Address.Equals (IPAddress.Any) || ep.Address.Equals (IPAddress.IPv6Any))
488 throw new SocketException ((int) SocketError.AddressNotAvailable);
490 #if NET_2_1 && !MONOTOUCH
491 if (protocol_type != ProtocolType.Tcp)
492 throw new SocketException ((int) SocketError.AccessDenied);
494 /* TODO: check this for the 1.1 profile too */
496 throw new InvalidOperationException ();
498 serial = remoteEP.Serialize ();
502 blocking_thread = Thread.CurrentThread;
504 Connect_internal (socket, serial, out error);
505 } catch (ThreadAbortException) {
507 Thread.ResetAbort ();
508 error = (int) SocketError.Interrupted;
511 blocking_thread = null;
515 throw new SocketException (error);
523 seed_endpoint = remoteEP;
527 public bool ReceiveAsync (SocketAsyncEventArgs e)
529 // NO check is made whether e != null in MS.NET (NRE is thrown in such case)
531 // LAME SPEC: the ArgumentException is never thrown, instead an NRE is
532 // thrown when e.Buffer and e.BufferList are null (works fine when one is
533 // set to a valid object)
534 if (disposed && closed)
535 throw new ObjectDisposedException (GetType ().ToString ());
537 // We do not support recv into multiple buffers yet
538 if (e.BufferList != null)
539 throw new NotSupportedException ("Mono doesn't support using BufferList at this point.");
541 e.DoOperation (SocketAsyncOperation.Receive, this);
543 // We always return true for now
547 public bool SendAsync (SocketAsyncEventArgs e)
549 // NO check is made whether e != null in MS.NET (NRE is thrown in such case)
551 if (disposed && closed)
552 throw new ObjectDisposedException (GetType ().ToString ());
553 if (e.Buffer == null && e.BufferList == null)
554 throw new ArgumentException ("Either e.Buffer or e.BufferList must be valid buffers.");
556 e.DoOperation (SocketAsyncOperation.Send, this);
558 // We always return true for now
563 [MethodImplAttribute(MethodImplOptions.InternalCall)]
564 extern static bool Poll_internal (IntPtr socket, SelectMode mode, int timeout, out int error);
566 #if !NET_2_1 || MONOTOUCH
567 /* This overload is needed as the async Connect method
568 * also needs to check the socket error status, but
569 * getsockopt(..., SO_ERROR) clears the error.
571 internal bool Poll (int time_us, SelectMode mode, out int socket_error)
573 if (disposed && closed)
574 throw new ObjectDisposedException (GetType ().ToString ());
576 if (mode != SelectMode.SelectRead &&
577 mode != SelectMode.SelectWrite &&
578 mode != SelectMode.SelectError)
579 throw new NotSupportedException ("'mode' parameter is not valid.");
582 bool result = Poll_internal (socket, mode, time_us, out error);
584 throw new SocketException (error);
586 socket_error = (int)GetSocketOption (SocketOptionLevel.Socket, SocketOptionName.Error);
588 if (mode == SelectMode.SelectWrite && result) {
589 /* Update the connected state; for
590 * non-blocking Connect()s this is
591 * when we can find out that the
594 if (socket_error == 0) {
602 [MethodImplAttribute(MethodImplOptions.InternalCall)]
603 private extern static int Receive_internal(IntPtr sock,
610 internal int Receive_nochecks (byte [] buf, int offset, int size, SocketFlags flags, out SocketError error)
613 int ret = Receive_internal (socket, buf, offset, size, flags, out nativeError);
614 error = (SocketError) nativeError;
615 if (error != SocketError.Success && error != SocketError.WouldBlock && error != SocketError.InProgress)
623 [MethodImplAttribute(MethodImplOptions.InternalCall)]
624 private extern static void GetSocketOption_obj_internal(IntPtr socket,
625 SocketOptionLevel level, SocketOptionName name, out object obj_val,
628 [MethodImplAttribute(MethodImplOptions.InternalCall)]
629 private extern static int Send_internal(IntPtr sock,
630 byte[] buf, int offset,
635 internal int Send_nochecks (byte [] buf, int offset, int size, SocketFlags flags, out SocketError error)
638 error = SocketError.Success;
644 int ret = Send_internal (socket, buf, offset, size, flags, out nativeError);
646 error = (SocketError)nativeError;
648 if (error != SocketError.Success && error != SocketError.WouldBlock && error != SocketError.InProgress)
656 public object GetSocketOption (SocketOptionLevel optionLevel, SocketOptionName optionName)
658 if (disposed && closed)
659 throw new ObjectDisposedException (GetType ().ToString ());
664 GetSocketOption_obj_internal (socket, optionLevel, optionName, out obj_val,
667 throw new SocketException (error);
669 if (optionName == SocketOptionName.Linger) {
670 return((LingerOption)obj_val);
671 } else if (optionName == SocketOptionName.AddMembership ||
672 optionName == SocketOptionName.DropMembership) {
673 return((MulticastOption)obj_val);
674 } else if (obj_val is int) {
675 return((int)obj_val);
681 [MethodImplAttribute (MethodImplOptions.InternalCall)]
682 private extern static void Shutdown_internal (IntPtr socket, SocketShutdown how, out int error);
684 public void Shutdown (SocketShutdown how)
686 if (disposed && closed)
687 throw new ObjectDisposedException (GetType ().ToString ());
691 Shutdown_internal (socket, how, out error);
694 throw new SocketException (error);
697 [MethodImplAttribute(MethodImplOptions.InternalCall)]
698 private extern static void SetSocketOption_internal (IntPtr socket, SocketOptionLevel level,
699 SocketOptionName name, object obj_val,
700 byte [] byte_val, int int_val,
703 public void SetSocketOption (SocketOptionLevel optionLevel, SocketOptionName optionName, int optionValue)
705 if (disposed && closed)
706 throw new ObjectDisposedException (GetType ().ToString ());
710 SetSocketOption_internal (socket, optionLevel, optionName, null,
711 null, optionValue, out error);
714 throw new SocketException (error);
717 private void ThrowIfUpd ()
720 if (protocol_type == ProtocolType.Udp)
721 throw new SocketException ((int)SocketError.ProtocolOption);
725 #if NET_2_1 && !MONOTOUCH
726 static void CheckConnect (SocketAsyncEventArgs e)
728 // NO check is made whether e != null in MS.NET (NRE is thrown in such case)
730 if (e.RemoteEndPoint == null)
731 throw new ArgumentNullException ("remoteEP");
732 if (e.BufferList != null)
733 throw new ArgumentException ("Multiple buffers cannot be used with this method.");
736 public bool ConnectAsync (SocketAsyncEventArgs e)
738 if (disposed && closed)
739 throw new ObjectDisposedException (GetType ().ToString ());
743 e.DoOperation (SocketAsyncOperation.Connect, this);
745 // We always return true for now
749 public static bool ConnectAsync (SocketType socketType, ProtocolType protocolType, SocketAsyncEventArgs e)
751 // exception ordering requires to check before creating the socket (good thing resource wise too)
754 Socket s = new Socket (AddressFamily.InterNetwork, socketType, protocolType);
755 e.DoOperation (SocketAsyncOperation.Connect, s);
757 // We always return true for now
761 public static void CancelConnectAsync (SocketAsyncEventArgs e)
764 throw new ArgumentNullException ("e");
766 Socket s = e.ConnectSocket;
767 if ((s != null) && (s.blocking_thread != null))
768 s.blocking_thread.Abort ();