UdpClient::Client Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the underlying network Socket.

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

property Socket^ Client {
	Socket^ get();
	void set(Socket^ value);

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 demonstrate the use of three protected methods belonging to the UdpClient class.
public ref class MyUdpClientDerivedClass: public UdpClient
      : UdpClient()

   void UsingProtectedMethods()
      //Uses the protected Active property belonging to the UdpClient base class to determine if a connection is established.
      if ( this->Active )
         //Calls the protected Client property belonging to the UdpClient base class.
         Socket^ s = this->Client;

         //Uses the Socket returned by Client to set an option that is not available using UdpClient.
         s->SetSocketOption( SocketOptionLevel::Socket, SocketOptionName::Broadcast, 1 );

.NET Framework
Available since 1.1
Return to top