CommunicationObject Class

 

Provides a common base implementation for the basic state machine common to all communication-oriented objects in the system, including channels, listeners, and the channel and listener factories.

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


Public MustInherit Class CommunicationObject
	Implements ICommunicationObject

NameDescription
System_CAPS_protmethodCommunicationObject()

Initializes a new instance of the CommunicationObject class.

System_CAPS_protmethodCommunicationObject(Object)

Initializes a new instance of the CommunicationObject class with the mutually exclusive lock to protect the state transitions specified.

NameDescription
System_CAPS_protpropertyDefaultCloseTimeout

When overridden in a derived class, gets the default interval of time provided for a close operation to complete.

System_CAPS_protpropertyDefaultOpenTimeout

When overridden in a derived class, gets the default interval of time provided for an open operation to complete.

System_CAPS_protpropertyIsDisposed

Gets a value that indicates whether the communication object has been disposed.

System_CAPS_pubpropertyState

Gets a value that indicates the current state of the communication object.

System_CAPS_protpropertyThisLock

Gets the mutually exclusive lock that protects the class instance during a state transition.

NameDescription
System_CAPS_pubmethodAbort()

Causes a communication object to transition immediately from its current state into the closing state.

System_CAPS_pubmethodBeginClose(AsyncCallback, Object)

Begins an asynchronous operation to close a communication object.

System_CAPS_pubmethodBeginClose(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to close a communication object with a specified timeout.

System_CAPS_pubmethodBeginOpen(AsyncCallback, Object)

Begins an asynchronous operation to open a communication object.

System_CAPS_pubmethodBeginOpen(TimeSpan, AsyncCallback, Object)

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

System_CAPS_pubmethodClose()

Causes a communication object to transition from its current state into the closed state.

System_CAPS_pubmethodClose(TimeSpan)

Causes a communication object to transition from its current state into the closed state within a specified interval of time.

System_CAPS_pubmethodEndClose(IAsyncResult)

Completes an asynchronous operation to close a communication object.

System_CAPS_pubmethodEndOpen(IAsyncResult)

Completes an asynchronous operation to open a communication object.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFault()

Causes a communication object to transition from its current state into the faulted state.

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_protmethodGetCommunicationObjectType()

Gets the type of communication object.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnAbort()

Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous abort operation.

System_CAPS_protmethodOnBeginClose(TimeSpan, AsyncCallback, Object)

Inserts processing after a communication object transitions to the closing state due to the invocation of an asynchronous close operation.

System_CAPS_protmethodOnBeginOpen(TimeSpan, AsyncCallback, Object)

Inserts processing on a communication object after it transitions to the opening state due to the invocation of an asynchronous open operation.

System_CAPS_protmethodOnClose(TimeSpan)

Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous close operation.

System_CAPS_protmethodOnClosed()

Invoked during the transition of a communication object into the closing state.

System_CAPS_protmethodOnClosing()

Invoked during the transition of a communication object into the closing state.

System_CAPS_protmethodOnEndClose(IAsyncResult)

Completes an asynchronous operation on the close of a communication object.

System_CAPS_protmethodOnEndOpen(IAsyncResult)

Completes an asynchronous operation on the open of a communication object.

System_CAPS_protmethodOnFaulted()

Inserts processing on a communication object after it transitions to the faulted state due to the invocation of a synchronous fault operation.

System_CAPS_protmethodOnOpen(TimeSpan)

Inserts processing on a communication object after it transitions into the opening state which must complete within a specified interval of time.

System_CAPS_protmethodOnOpened()

Invoked during the transition of a communication object into the opened state.

System_CAPS_protmethodOnOpening()

Invoked during the transition of a communication object into the opening state.

System_CAPS_pubmethodOpen()

Causes a communication object to transition from the created state into the opened state.

System_CAPS_pubmethodOpen(TimeSpan)

Causes a communication object to transition from the created state into the opened state within a specified interval of time.

System_CAPS_protmethodThrowIfDisposed()

Throws an exception if the communication object is disposed.

System_CAPS_protmethodThrowIfDisposedOrImmutable()

Throws an exception if the communication object the State property is not set to the Created state.

System_CAPS_protmethodThrowIfDisposedOrNotOpen()

Throws an exception if the communication object is not in the Opened state.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubeventClosed

Occurs when a communication object transitions into the closed state.

System_CAPS_pubeventClosing

Occurs when a communication object transitions into the closing state.

System_CAPS_pubeventFaulted

Occurs when a communication object transitions into the faulted state.

System_CAPS_pubeventOpened

Occurs when a communication object transitions into the opened state.

System_CAPS_pubeventOpening

Occurs when a communication object transitions into the opening state.

The CommunicationObject class implements the ICommunicationObject interface for all communication objects in Windows Communication Foundation (WCF). The method implementations handle parameter validation, raise events that notify the occurrence of state transitions, provide the means to associated additional processing with these state transitions, and ensure that such state changes are coordinated.

Universal Windows Platform
Available since 8
.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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: