This documentation is archived and is not being maintained.

UdpClient.Client Property

Gets or sets the underlying network Socket.

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

public Socket Client { get; set; }

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.

public static void Main(string[] args)
{
    if (args.Length < 1)
    {
        Console.WriteLine("you must specify a port number!");
        return;
    }

    UdpClient uClient = new UdpClient(Convert.ToInt32(args[0]));
    Socket uSocket = uClient.Client;

    // use the underlying socket to enable broadcast.
    uSocket.SetSocketOption(SocketOptionLevel.Socket, 
                  SocketOptionName.Broadcast, 1);
}
// This derived class demonstrate the use of three protected methods belonging to the UdpClient class.
public __gc class MyUdpClientDerivedClass : public UdpClient{
public:
    MyUdpClientDerivedClass() : 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);
        }
    }
};

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0
Show: