Client Property
Collapse the table of content
Expand the table of content

UdpClient.Client Property


Gets or sets the underlying network Socket.

Namespace:   System.Net.Sockets
Assembly:  System (in System.dll)

Public Property Client As Socket

Property Value

Type: System.Net.Sockets.Socket

The underlying Network Socket.

UdpClient creates a Socket used to send and receive data over a network. Classes deriving from UdpClient can use this property to get or set this Socket. Use the underlying Socket returned from Client if you require access beyond that which UdpClient provides. You can also use Client to set the underlying Socket to an existing Socket. This is useful if you want to take advantage of the simplicity of UdpClient using a pre-existing Socket.

The following example demonstrates the use of the Client property. In this example, broadcasting is enabled for the underlying Socket.

' This derived class demonstrates the use of three protected methods belonging to the UdpClient class.
Public Class MyUdpClientDerivedClass
   Inherits UdpClient

   Public Sub New()
   End Sub 'NewNew

   Public Sub UsingProtectedMethods()

      'Uses the protected Active property belonging to the UdpClient base class to determine if a connection is established.
      If Me.Active Then
         ' Calls the protected Client property belonging to the UdpClient base class.
         Dim s As Socket = Me.Client
              'Uses the Socket returned by Client to set an option that is not available using UdpClient.
         s.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Broadcast, 1)
      End If
   End Sub 'UsingProtectedMethods 
End Class 'MyUdpClientDerivedClass

.NET Framework
Available since 1.1
Return to top
© 2016 Microsoft