ICommunicationObject.Open 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.
Causes a communication object to transition from the created state into the opened state.
Overloads
| Open() |
Causes a communication object to transition from the created state into the opened state. |
| Open(TimeSpan) |
Causes a communication object to transition from the created state into the opened state within a specified interval of time. |
Remarks
Versions with and without an explicit timeout are provided.
Open()
- Source:
- ICommunicationObject.cs
- Source:
- ICommunicationObject.cs
Causes a communication object to transition from the created state into the opened state.
public:
void Open();public void Open ();abstract member Open : unit -> unitPublic Sub Open ()Exceptions
The ICommunicationObject was unable to be opened and has entered the Faulted state.
The default open timeout elapsed before the ICommunicationObject was able to enter the Opened state and has entered the Faulted state.
Remarks
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.
There is also an asynchronous version of the open method that is initiated by calling BeginOpen and completed by calling EndOpen(IAsyncResult).
Applies to
Open(TimeSpan)
- Source:
- ICommunicationObject.cs
- Source:
- ICommunicationObject.cs
Causes a communication object to transition from the created state into the opened state within a specified interval of time.
public:
void Open(TimeSpan timeout);public void Open (TimeSpan timeout);abstract member Open : TimeSpan -> unitPublic Sub Open (timeout As TimeSpan)Parameters
- timeout
- TimeSpan
The TimeSpan that specifies how long the send operation has to complete before timing out.
Exceptions
The ICommunicationObject was unable to be opened and has entered the Faulted state.
The specified timeout elapsed before the ICommunicationObject was able to enter the Opened state and has entered the Faulted state.
Remarks
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.
There is also an asynchronous version of the open method that is initiated by calling BeginOpen and completed by calling EndOpen(IAsyncResult).
Notes to Implementers
The operation must throw a TimeoutException if the specified timeout is exceeded.
