HttpClient.Connect Method (String, Int32, String, String)

Establish a connection with a remote host.

[Visual Basic]
Overloads Public Function Connect( _
   ByVal hostName As String, _
   ByVal hostPort As Integer, _
   ByVal userName As String, _
   ByVal userPassword As String _
) As Boolean

[C#]
public bool Connect(
   string hostName,
   int hostPort,
   string userName,
   string userPassword
);

Parameters

hostName: A string which specifies the remote host to establish a connection with. This may specify a host name or an Internet address in dot-notation.
hostPort: An integer which specifies the port number for the connection. This value must be greater than zero and the maximum valid port number is 65535.
userName: A string which specifies a username used to authenticate the client session. This argument is only required if access to the resource requires authentication.
userPassword: A string which specifies the password used to authenticate the client session. This argument is only required if access to the resource requires authentication.

Return Value

A boolean value which specifies if the connection has been established. If the client is in blocking mode, a return value of true indicates that the connection has completed and the application may send and receive data from the remote host. If the client is in non-blocking mode, a return value of true indicates that the client has successfully created a socket and the connection is in progress.

When a non-blocking connection has completed, the OnConnect event will be fired. If this method returns false, the connection could not be established and the application should check the value of the LastError property to determine the cause of the failure.

Remarks

This method establishes a connection using assigned property values.

The value of the Timeout property will be used to specify the timeout period.

The value of the Options property will be used to specify the default options for the connection.

The value of the ProtocolVersion property will be used to specify the protocol version.

HttpClient.Connect Method (String, Int32, String, String)

Parameters

Return Value

Remarks

See Also