BeginOpen Method (TimeSpan, AsyncCallback, Object)

ICommunicationObject.BeginOpen Method (TimeSpan, AsyncCallback, Object)

 

Begins an asynchronous operation to open a communication object within a specified interval of time.

Namespace:   System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

IAsyncResult BeginOpen(
	TimeSpan timeout,
	AsyncCallback callback,
	object state
)

Parameters

timeout
Type: System.TimeSpan

The T:System.Timespan that specifies how long the send operation has to complete before timing out.

callback
Type: System.AsyncCallback

The AsyncCallback delegate that receives notification of the completion of the asynchronous open operation.

state
Type: System.Object

An object, specified by the application, that contains state information associated with the asynchronous open operation.

Return Value

Type: System.IAsyncResult

The IAsyncResult that references the asynchronous open operation.

Exception Condition
CommunicationException

The ICommunicationObject was unable to be opened and has entered the Faulted state.

TimeoutException

The specified timeout elapsed before the ICommunicationObject was able to enter the Opened state and has entered the Faulted state.

When an ICommunicationObject is instantiated, it begins in the Created state. In the Created state, the object can be configured (for example, properties can be set, or events can be registered), but it is not yet usable to send or receive messages. The Open method causes an ICommunicationObject to enter into the Opening state where it remains until the open operation succeeds, the open operation times out or fails and the object becomes faulted, or the ICommunicationObject is aborted.

In the Opened state, the ICommunicationObject is usable (for example, messages can be received), but it is no longer configurable.

Notes to Implementers:

The operation must throw a TimeoutException if the specified timeout is exceeded.

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 3.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show:
© 2016 Microsoft