TcpClient.BeginConnect Method (String, Int32, AsyncCallback, Object) (System.Net.Sockets)

Microsoft Developer Network

BeginConnect Method (String, Int32, AsyncCallba...

.NET Framework Class Library

TcpClient..::.BeginConnect Method (String, Int32, AsyncCallback, Object)

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

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

Syntax

Visual Basic (Declaration)

<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading := True)> _
Public Function BeginConnect ( _
    host As String, _
    port As Integer, _
    requestCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult

Visual Basic (Usage)

Dim instance As TcpClient
Dim host As String
Dim port As Integer
Dim requestCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginConnect(host, _
    port, requestCallback, state)

[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public IAsyncResult BeginConnect(
    string host,
    int port,
    AsyncCallback requestCallback,
    Object state
)

Visual C++

[HostProtectionAttribute(SecurityAction::LinkDemand, ExternalThreading = true)]
public:
IAsyncResult^ BeginConnect(
    String^ host, 
    int port, 
    AsyncCallback^ requestCallback, 
    Object^ state
)

JScript

public function BeginConnect(
    host : String, 
    port : int, 
    requestCallback : AsyncCallback, 
    state : Object
) : IAsyncResult

Parameters

host: Type: System..::.String
The name of the remote host.

port: Type: System..::.Int32
The port number of the remote host.

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.

Exceptions

Exception	Condition
ArgumentNullException	The host parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
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.

Remarks

Note:
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.

Note:

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 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.

Examples

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

// Connect asynchronously to the specifed host.
public static void DoBeginConnect3(string host, int port)
{
    TcpClient t = new TcpClient(AddressFamily.InterNetwork);

    connectDone.Reset();

    Console.WriteLine("Establishing Connection to {0}", 
        host);
    t.BeginConnect(host, port, 
        new AsyncCallback(ConnectCallback), t);

    // Wait here until the callback processes the connection.
    connectDone.WaitOne();

    Console.WriteLine("Connection established");
}

Visual C++

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

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

Platforms

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

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.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

TcpClient Class

TcpClient Members

BeginConnect Overload

System.Net.Sockets Namespace