1 out of 4 rated this helpful - Rate this topic

InstanceContext Class

Represents the context information for a service instance.

System.Object
  System.ServiceModel.Channels.CommunicationObject
    System.ServiceModel.InstanceContext

Namespace:  System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
public sealed class InstanceContext : CommunicationObject, 
	IExtensibleObject<InstanceContext>

The InstanceContext type exposes the following members.

  Name Description
Public method InstanceContext(Object) Initializes a new instance of the InstanceContext class for a specified object that implements the service instance.
Public method InstanceContext(ServiceHostBase) Initializes a new instance of the InstanceContext class for a service hosted by a specified host.
Public method InstanceContext(ServiceHostBase, Object) Initializes a new instance of the InstanceContext class for a specified object that implements the service instance and is hosted by a specified host.
Top
  Name Description
Protected property DefaultCloseTimeout When overridden in a derived class, gets the default interval of time provided for a close operation to complete. (Inherited from CommunicationObject.)
Protected property DefaultOpenTimeout When overridden in a derived class, gets the default interval of time provided for an open operation to complete. (Inherited from CommunicationObject.)
Public property Extensions Gets the extension collection, if any, associated with the service instance.
Public property Host Gets the host for the service instance.
Public property IncomingChannels Gets the sessionful channels that are incoming to the service instance.
Protected property IsDisposed Gets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject.)
Public property ManualFlowControlLimit Gets or sets a limit on the number of messages that can be processed by the instance context.
Public property OutgoingChannels Gets the sessionful channels that are outgoing from the service instance.
Public property State Gets a value that indicates the current state of the communication object. (Inherited from CommunicationObject.)
Public property SynchronizationContext Gets or sets the context used for thread synchronization with the current instance context.
Protected property ThisLock Gets the mutually exclusive lock that protects the class instance during a state transition. (Inherited from CommunicationObject.)
Top
  Name Description
Public method Abort Causes a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject.)
Public method BeginClose(AsyncCallback, Object) Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public method BeginClose(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from CommunicationObject.)
Public method BeginOpen(AsyncCallback, Object) Begins an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Public method BeginOpen(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from CommunicationObject.)
Public method Close() Causes a communication object to transition from its current state into the closed state. (Inherited from CommunicationObject.)
Public method Close(TimeSpan) Causes a communication object to transition from its current state into the closed state within a specified interval of time. (Inherited from CommunicationObject.)
Public method EndClose Completes an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public method EndOpen Completes an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Fault Causes a communication object to transition from its current state into the faulted state. (Inherited from CommunicationObject.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method GetCommunicationObjectType Gets the type of communication object. (Inherited from CommunicationObject.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetServiceInstance() Returns the instance of the service for the instance context.
Public method GetServiceInstance(Message) Returns the instance of the service for the instance context in response to an incoming message.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IncrementManualFlowControlLimit Increases the number of messages that can be processed by the service instance.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnAbort Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous abort operation. (Inherited from CommunicationObject.)
Protected method OnBeginClose Inserts processing after a communication object transitions to the closing state due to the invocation of an asynchronous close operation. (Inherited from CommunicationObject.)
Protected method OnBeginOpen Inserts processing on a communication object after it transitions to the opening state due to the invocation of an asynchronous open operation. (Inherited from CommunicationObject.)
Protected method OnClose Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous close operation. (Inherited from CommunicationObject.)
Protected method OnClosed Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected method OnClosing Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected method OnEndClose Completes an asynchronous operation on the close of a communication object. (Inherited from CommunicationObject.)
Protected method OnEndOpen Completes an asynchronous operation on the open of a communication object. (Inherited from CommunicationObject.)
Protected method OnFaulted Inserts processing on a communication object after it transitions to the faulted state due to the invocation of a synchronous fault operation. (Inherited from CommunicationObject.)
Protected method OnOpen Inserts processing on a communication object after it transitions into the opening state which must complete within a specified interval of time. (Inherited from CommunicationObject.)
Protected method OnOpened Invoked during the transition of a communication object into the opened state. (Inherited from CommunicationObject.)
Protected method OnOpening Invoked during the transition of a communication object into the opening state. (Inherited from CommunicationObject.)
Public method Open() Causes a communication object to transition from the created state into the opened state. (Inherited from CommunicationObject.)
Public method Open(TimeSpan) Causes a communication object to transition from the created state into the opened state within a specified interval of time. (Inherited from CommunicationObject.)
Public method ReleaseServiceInstance Releases the service instance.
Protected method ThrowIfDisposed Throws an exception if the communication object is disposed. (Inherited from CommunicationObject.)
Protected method ThrowIfDisposedOrImmutable Throws an exception if the communication object the State property is not set to the Created state. (Inherited from CommunicationObject.)
Protected method ThrowIfDisposedOrNotOpen Throws an exception if the communication object is not in the Opened state. (Inherited from CommunicationObject.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public event Closed Occurs when a communication object transitions into the closed state. (Inherited from CommunicationObject.)
Public event Closing Occurs when a communication object transitions into the closing state. (Inherited from CommunicationObject.)
Public event Faulted Occurs when a communication object transitions into the faulted state. (Inherited from CommunicationObject.)
Public event Opened Occurs when a communication object transitions into the opened state. (Inherited from CommunicationObject.)
Public event Opening Occurs when a communication object transitions into the opening state. (Inherited from CommunicationObject.)
Top

The following code illustrates how to obtain instance context information from a service:


string info = "";

OperationContext operationContext = OperationContext.Current;
InstanceContext instanceContext = operationContext.InstanceContext;

info += "    " + "State: " + instanceContext.State.ToString() + "\n";
info += "    " + "ManualFlowControlLimit: " + instanceContext.ManualFlowControlLimit.ToString() + "\n";
info += "    " + "HashCode: " + instanceContext.GetHashCode().ToString() + "\n";

return info;


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ