Export (0) Print
Expand All

Socket.BeginConnect Method (String, Int32, AsyncCallback, Object)

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

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

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

Parameters

host

The name of the remote host.

port

The port number of the remote host.

requestCallback

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

state

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

An IAsyncResult that references the asynchronous connection.

Exception typeCondition

ArgumentNullException

host is a null reference (Nothing in Visual Basic).

ObjectDisposedException

The Socket has been closed.

NotSupportedException

This method is valid for sockets in the InterNetwork or InterNetworkV6 families.

ArgumentOutOfRangeException

The port number is not valid.

InvalidOperationException

The Socket is Listening.

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

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

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

NoteNote:

If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation in the MSDN library for a detailed description of the error.

NoteNote:

If this socket has previously been disconnected, then BeginConnect must be called on a thread that will not exit until the operation is complete. This is a limitation of the underlying provider. Also the EndPoint that is used must be different.

NoteNote:

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing.

NoteNote:

The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous Socket methods. After the first use of a particular context (a specific asynchronous Socket method, a specific Socket instance, and a specific callback), subsequent uses of that context will see a performance improvement.

The following code example initiates an asynchronous connection attempt.

public static ManualResetEvent allDone = 
    new ManualResetEvent(false);

// handles the completion of the prior asynchronous 
// connect call. the socket is passed via the objectState 
// paramater of BeginConnect().
public static void ConnectCallback1(IAsyncResult ar)
{
    allDone.Set();
    Socket s = (Socket) ar.AsyncState;
    s.EndConnect(ar);
}

// Asynchronous connect using host name (resolved by the 
// BeginConnect call.)
public static void BeginConnect3(string host, int port)
{
    Socket s = new Socket(AddressFamily.InterNetwork,
        SocketType.Stream,
        ProtocolType.Tcp);

    allDone.Reset();

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

    // wait here until the connect finishes.  The callback 
    // sets allDone.
    allDone.WaitOne();

    Console.WriteLine("Connection established");
}        

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft