HttpWebRequest.ConnectionGroupName Property

Definition

Namespace:

System.Net

Assembly:

System.Net.Requests.dll

Source:

HttpWebRequest.cs

Gets or sets the name of the connection group for the request.

public:
 virtual property System::String ^ ConnectionGroupName { System::String ^ get(); void set(System::String ^ value); };

public override string? ConnectionGroupName { get; set; }

member this.ConnectionGroupName : string with get, set

Public Overrides Property ConnectionGroupName As String

Property Value

String

The name of the connection group for this request. The default value is null.

Examples

The following code example show how to use user information to form a connection group, assuming that the variables username, password, and domain are set by the application before this code is called.

// Create a secure group name.
// This example uses the SHA1 algorithm.
// Due to collision problems with SHA1, Microsoft recommends SHA256 or better.
SHA1Managed^ Sha1 = gcnew SHA1Managed;
array<Byte>^updHash = Sha1->ComputeHash( Encoding::UTF8->GetBytes( "usernamepassworddomain" ) );
String^ secureGroupName = Encoding::Default->GetString( updHash );

// Create a request for a specific URL.
WebRequest^ myWebRequest = WebRequest::Create( "http://www.contoso.com" );

// Set the authentication credentials for the request.      
myWebRequest->Credentials = gcnew NetworkCredential( "username","password","domain" );
myWebRequest->ConnectionGroupName = secureGroupName;

// Get the response.
WebResponse^ myWebResponse = myWebRequest->GetResponse();

// Insert the code that uses myWebResponse here.
// Close the response.
myWebResponse->Close();

// Create a secure group name.
// This example uses the SHA1 algorithm.
// Due to collision problems with SHA1, Microsoft recommends SHA256 or better.
SHA1Managed Sha1 = new SHA1Managed();
Byte[] updHash = Sha1.ComputeHash(Encoding.UTF8.GetBytes("username" + "password" +  "domain"));
String secureGroupName = Encoding.Default.GetString(updHash);

// Create a request for a specific URL.
WebRequest myWebRequest=WebRequest.Create("http://www.contoso.com");

// Set the authentication credentials for the request.
myWebRequest.Credentials = new NetworkCredential("username", "password", "domain");
myWebRequest.ConnectionGroupName = secureGroupName;

// Get the response.
WebResponse myWebResponse=myWebRequest.GetResponse();

// Insert the code that uses myWebResponse here.

// Close the response.
myWebResponse.Close();

' Create a secure group name.
' This example uses the SHA1 algorithm.
' Due to collision problems with SHA1, Microsoft recommends SHA256 or better.
Dim Sha1 As New SHA1Managed()
Dim updHash As [Byte]() = Sha1.ComputeHash(Encoding.UTF8.GetBytes(("username" + "password" + "domain")))
Dim secureGroupName As [String] = Encoding.Default.GetString(updHash)
   
' Create a request for a specific URL.
Dim myWebRequest As WebRequest = WebRequest.Create("http://www.contoso.com")
   
' Set the authentication credentials for the request.      
myWebRequest.Credentials = New NetworkCredential("username", "password", "domain")
myWebRequest.ConnectionGroupName = secureGroupName
   
' Get the response.
Dim myWebResponse As WebResponse = myWebRequest.GetResponse()
   
' Insert the code that uses myWebResponse here.
' Close the response.
myWebResponse.Close()

Remarks

Caution

WebRequest, HttpWebRequest, ServicePoint, and WebClient are obsolete, and you shouldn't use them for new development. Use HttpClient instead.

The ConnectionGroupName property enables you to associate a request with a connection group. This is useful when your application makes requests to one server for different users, such as a Web site that retrieves customer information from a database server.

Notes to Inheritors

Each connection group creates additional connections for a server. This may result in exceeding the number of connections set by the ConnectionLimit property for that server.

See also

• MaxConnection
• ConnectionGroupName
• Connection Grouping