Export (0) Print
Expand All

TcpClient::BeginConnect Method (array<IPAddress>, Int32, AsyncCallback, Object)

Begins an asynchronous request for a remote host connection. The remote host is specified by an IPAddress array and a port number (Int32).

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

[HostProtectionAttribute(SecurityAction::LinkDemand, ExternalThreading = true)]
public:
IAsyncResult^ BeginConnect(
	array<IPAddress^>^ addresses, 
	int port, 
	AsyncCallback^ requestCallback, 
	Object^ state
)

Parameters

addresses
Type: array<System.Net::IPAddress>

At least one IPAddress that designates the remote hosts.

port
Type: System::Int32

The port number of the remote hosts.

requestCallback
Type: System::AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state
Type: System::Object

A user-defined object that contains information about the connect operation. This object is passed to the requestCallback delegate when the operation is complete.

Return Value

Type: System::IAsyncResult
An IAsyncResult object that references the asynchronous connection.

ExceptionCondition
ArgumentNullException

The addresses parameter is nullptr.

SocketException

An error occurred when attempting to access the socket. See the Remarks section for more information.

ObjectDisposedException

The Socket has been closed.

SecurityException

A caller higher in the call stack does not have permission for the requested operation.

ArgumentOutOfRangeException

The port number is not valid.

The asynchronous BeginConnect operation must be completed by calling the EndConnect method. Typically, the method is invoked by the asyncCallback delegate.

This method does not block until the operation completes. To block until the operation completes, use one of the Connect method overloads.

For detailed information about using the asynchronous programming model, see Calling Synchronous Methods Asynchronously.

This method is typically used immediately after a call to the BeginGetHostAddresses method, which can return multiple IP addresses for a single host.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

The following code example creates a TcpClient and connects to a remote host.

// Connect asynchronously to the specifed host. 
static void DoBeginConnect2( String^ host, int port )
{
   TcpClient^ t = gcnew TcpClient( AddressFamily::InterNetwork );
   array<IPAddress^>^remoteHost = Dns::GetHostAddresses( host );
   connectDone->Reset();
   Console::WriteLine( "Establishing Connection to {0}", host );
   t->BeginConnect( remoteHost, port, gcnew AsyncCallback(  &ConnectCallback ), t );

   // Wait here until the callback processes the connection.
   connectDone->WaitOne();
   Console::WriteLine( "Connection established" );
}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft