ChannelDispatcher.ReceiveSynchronously Property

Definition

Namespace:

System.ServiceModel.Dispatcher

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.0.0

Source:

ChannelDispatcher.cs

Gets or sets a value that specifies whether the dispatcher uses synchronous calls to read messages from channels.

public:
 property bool ReceiveSynchronously { bool get(); void set(bool value); };

public bool ReceiveSynchronously { get; set; }

member this.ReceiveSynchronously : bool with get, set

Public Property ReceiveSynchronously As Boolean

Property Value

Boolean

true if the dispatcher uses synchronous methods to read messages from channels; otherwise, false. The default is false.

Exceptions

InvalidOperationException

The communication object is in an Opening or Opened state.

ObjectDisposedException

The communication object is in a Closing or Closed state.

CommunicationObjectFaultedException

The communication object is in a Faulted state.

Examples

Uri baseAddress = new Uri("http://localhost:8001/Simple");
ServiceHost serviceHost = new ServiceHost(typeof(CalculatorService), baseAddress);

serviceHost.AddServiceEndpoint(
    typeof(ICalculator),
    new WSHttpBinding(),
    "CalculatorServiceObject");

serviceHost.Open();

IChannelListener icl = serviceHost.ChannelDispatchers[0].Listener;
ChannelDispatcher dispatcher = new ChannelDispatcher(icl);
bool receiveSynchronously = dispatcher.ReceiveSynchronously;

Dim baseAddress As New Uri("http://localhost:8001/Simple")
Dim serviceHost As New ServiceHost(GetType(CalculatorService), baseAddress)

serviceHost.AddServiceEndpoint(GetType(ICalculator), New WSHttpBinding(), "CalculatorServiceObject")

serviceHost.Open()

Dim icl As IChannelListener = serviceHost.ChannelDispatchers(0).Listener
Dim dispatcher As New ChannelDispatcher(icl)
Dim receiveSynchronously As Boolean = dispatcher.ReceiveSynchronously

Remarks

If a binding implements IBindingRuntimePreferences, Windows Communication Foundation (WCF) assigns the value of the ReceiveSynchronously property to this property. So if this value is true, the false default value of ReceiveSynchronously is overridden.

This property can only be set when the instance of the ChannelDispatcher is in the Created state, as this is the only state that is both mutable and not disposed.