ICommunicationObject.BeginClose Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Begins an asynchronous operation to close a communication object.
Overloads
| BeginClose(AsyncCallback, Object) |
Begins an asynchronous operation to close a communication object. |
| BeginClose(TimeSpan, AsyncCallback, Object) |
Begins an asynchronous operation to close a communication object with a specified timeout. |
Remarks
This method causes an ICommunicationObject to gracefully transition from the Opened state to the Closed state.
Versions with and without an explicit timeout are provided.
BeginClose(AsyncCallback, Object)
- Source:
- ICommunicationObject.cs
Begins an asynchronous operation to close a communication object.
public:
IAsyncResult ^ BeginClose(AsyncCallback ^ callback, System::Object ^ state);public IAsyncResult BeginClose (AsyncCallback callback, object state);abstract member BeginClose : AsyncCallback * obj -> IAsyncResultPublic Function BeginClose (callback As AsyncCallback, state As Object) As IAsyncResultParameters
- callback
- AsyncCallback
The AsyncCallback delegate that receives notification of the completion of the asynchronous close operation.
- state
- Object
An object, specified by the application, that contains state information associated with the asynchronous close operation.
Returns
The IAsyncResult that references the asynchronous close operation.
Exceptions
BeginClose(AsyncCallback, Object) was called on an object in the Faulted state.
The default timeout elapsed before the ICommunicationObject was able to close gracefully.
Remarks
This method causes an ICommunicationObject to gracefully transition from any state, other than the Opened state to the Closed state. The BeginClose method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages).
Applies to
BeginClose(TimeSpan, AsyncCallback, Object)
- Source:
- ICommunicationObject.cs
Begins an asynchronous operation to close a communication object with a specified timeout.
public:
IAsyncResult ^ BeginClose(TimeSpan timeout, AsyncCallback ^ callback, System::Object ^ state);public IAsyncResult BeginClose (TimeSpan timeout, AsyncCallback callback, object state);abstract member BeginClose : TimeSpan * AsyncCallback * obj -> IAsyncResultPublic Function BeginClose (timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResultParameters
- timeout
- TimeSpan
The TimeSpan that specifies how long the send operation has to complete before timing out.
- callback
- AsyncCallback
The AsyncCallback delegate that receives notification of the completion of the asynchronous close operation.
- state
- Object
An object, specified by the application, that contains state information associated with the asynchronous close operation.
Returns
The IAsyncResult that references the asynchronous close operation.
Exceptions
BeginClose(TimeSpan, AsyncCallback, Object) was called on an object in the Faulted state.
The specified timeout elapsed before the ICommunicationObject was able to close gracefully.
Remarks
This method causes an ICommunicationObject to gracefully transition from any state, other than the Opened state to the Closed state with in a specified interval of time. The BeginClose method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages).
