This documentation is archived and is not being maintained.

UdpClient.Client Property

Gets or sets the underlying network Socket.

[Visual Basic]
Protected Property Client As Socket
[C#]
protected Socket Client {get; set;}
[C++]
protected: __property Socket* get_Client();
protected: __property void set_Client(Socket*);
[JScript]
protected function get Client() : Socket;
protected function set Client(Socket);

Property Value

The underlying Network Socket.

Remarks

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.

Example

[Visual Basic, C#, C++] The following example demonstrates a derived class using the protected property Client. In this example, MyUdpClientDerivedClass obtains the underlying Socket to enable broadcasting.

[Visual Basic] 
' 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 'New
   
   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
 


[C#] 
// This derived class demonstrate the use of three protected methods belonging to the UdpClient class.
public class MyUdpClientDerivedClass : UdpClient{

public MyUdpClientDerivedClass() : base(){
}
public 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);
  }
  
}

}

[C++] 
// 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);
        }
    }
};

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

UdpClient Class | UdpClient Members | System.Net.Sockets Namespace | Socket

Show: