CallbackBehaviorAttribute Klasse

Definition

Konfiguriert eine Rückrufdienstimplementierung in einer Clientanwendung.Configures a callback service implementation in a client application.

public ref class CallbackBehaviorAttribute sealed : Attribute, System::ServiceModel::Description::IEndpointBehavior
[System.AttributeUsage(System.AttributeTargets.Class)]
public sealed class CallbackBehaviorAttribute : Attribute, System.ServiceModel.Description.IEndpointBehavior
type CallbackBehaviorAttribute = class
    inherit Attribute
    interface IEndpointBehavior
Public NotInheritable Class CallbackBehaviorAttribute
Inherits Attribute
Implements IEndpointBehavior
Vererbung
CallbackBehaviorAttribute
Attribute
Implementiert

Beispiele

Das folgende Codebeispiel zeigt ein CallbackBehaviorAttribute für ein Rückrufobjekt, das das SynchronizationContext-Objekt zur Bestimmung des Threads für das Marshallen, die ValidateMustUnderstand-Eigenschaft zum Erzwingen der Nachrichtenvalidierung und die IncludeExceptionDetailInFaults-Eigenschaft zum Zurückgeben von Ausnahmen als FaultException-Objekte zu Debuggingzwecken an den Dienst verwendet.The following code example shows a CallbackBehaviorAttribute on a callback object that uses the SynchronizationContext object to determine which thread to marshal to, the ValidateMustUnderstand property to enforce message validation, and the IncludeExceptionDetailInFaults property to return exceptions as FaultException objects to the service for debugging purposes.

using System;
using System.ServiceModel;
using System.ServiceModel.Channels;
using System.Threading;

namespace Microsoft.WCF.Documentation
{
  [CallbackBehaviorAttribute(
   IncludeExceptionDetailInFaults= true, 
    UseSynchronizationContext=true,
    ValidateMustUnderstand=true
  )]
  public class Client : SampleDuplexHelloCallback
  {
    AutoResetEvent waitHandle;

    public Client()
    {
      waitHandle = new AutoResetEvent(false);
    }

    public void Run()
    {
      // Picks up configuration from the configuration file.
      SampleDuplexHelloClient wcfClient
        = new SampleDuplexHelloClient(new InstanceContext(this), "WSDualHttpBinding_SampleDuplexHello");
      try
      {
        Console.ForegroundColor = ConsoleColor.White;
        Console.WriteLine("Enter a greeting to send and press ENTER: ");
        Console.Write(">>> ");
        Console.ForegroundColor = ConsoleColor.Green;
        string greeting = Console.ReadLine();
        Console.ForegroundColor = ConsoleColor.White;
        Console.WriteLine("Called service with: \r\n\t" + greeting);
        wcfClient.Hello(greeting);
        Console.WriteLine("Execution passes service call and moves to the WaitHandle.");
        this.waitHandle.WaitOne();
        Console.ForegroundColor = ConsoleColor.Blue;
        Console.WriteLine("Set was called.");
        Console.Write("Press ");
        Console.ForegroundColor = ConsoleColor.Red;
        Console.Write("ENTER");
        Console.ForegroundColor = ConsoleColor.Blue;
        Console.Write(" to exit...");
        Console.ReadLine();
      }
      catch (TimeoutException timeProblem)
      {
        Console.WriteLine("The service operation timed out. " + timeProblem.Message);
        Console.ReadLine();
      }
      catch (CommunicationException commProblem)
      {
        Console.WriteLine("There was a communication problem. " + commProblem.Message);
        Console.ReadLine();
      }
    }
    public static void Main()
    {
      Client client = new Client();
      client.Run();
    }

    public void Reply(string response)
    {
      Console.WriteLine("Received output.");
      Console.WriteLine("\r\n\t" + response);
      this.waitHandle.Set();
    }
  }
}

Imports System.ServiceModel
Imports System.ServiceModel.Channels
Imports System.Threading

Namespace Microsoft.WCF.Documentation
  <CallbackBehaviorAttribute(IncludeExceptionDetailInFaults:= True, UseSynchronizationContext:=True, ValidateMustUnderstand:=True)> _
  Public Class Client
      Implements SampleDuplexHelloCallback
    Private waitHandle As AutoResetEvent

    Public Sub New()
      waitHandle = New AutoResetEvent(False)
    End Sub

    Public Sub Run()
      ' Picks up configuration from the configuration file.
      Dim wcfClient As New SampleDuplexHelloClient(New InstanceContext(Me), "WSDualHttpBinding_SampleDuplexHello")
      Try
        Console.ForegroundColor = ConsoleColor.White
        Console.WriteLine("Enter a greeting to send and press ENTER: ")
        Console.Write(">>> ")
        Console.ForegroundColor = ConsoleColor.Green
        Dim greeting As String = Console.ReadLine()
        Console.ForegroundColor = ConsoleColor.White
        Console.WriteLine("Called service with: " & Constants.vbCrLf & Constants.vbTab & greeting)
        wcfClient.Hello(greeting)
        Console.WriteLine("Execution passes service call and moves to the WaitHandle.")
        Me.waitHandle.WaitOne()
        Console.ForegroundColor = ConsoleColor.Blue
        Console.WriteLine("Set was called.")
        Console.Write("Press ")
        Console.ForegroundColor = ConsoleColor.Red
        Console.Write("ENTER")
        Console.ForegroundColor = ConsoleColor.Blue
        Console.Write(" to exit...")
        Console.ReadLine()
      Catch timeProblem As TimeoutException
        Console.WriteLine("The service operation timed out. " & timeProblem.Message)
        Console.ReadLine()
      Catch commProblem As CommunicationException
        Console.WriteLine("There was a communication problem. " & commProblem.Message)
        Console.ReadLine()
      End Try
    End Sub
    Public Shared Sub Main()
      Dim client As New Client()
      client.Run()
    End Sub

    Public Sub Reply(ByVal response As String) Implements SampleDuplexHelloCallback.Reply
      Console.WriteLine("Received output.")
      Console.WriteLine(Constants.vbCrLf & Constants.vbTab & response)
      Me.waitHandle.Set()
    End Sub
  End Class
End Namespace

Hinweise

Verwenden Sie das CallbackBehaviorAttribute-Attribut, um das Ausführungsverhalten einer Rückrufvertragsimplementierung in einer Clientanwendung zu konfigurieren oder zu erweitern.Use the CallbackBehaviorAttribute attribute to configure or extend the execution behavior of a callback contract implementation in a client application. Abgesehen vom Instanziierungsverhalten und den Transaktionseinstellungen erfüllt dieses Attribut dieselbe Funktion für die Rückrufklasse wie das ServiceBehaviorAttribute-Attribut.This attribute performs the same function for the callback class as the ServiceBehaviorAttribute attribute with the exception of instancing behavior and transaction settings.

Das CallbackBehaviorAttribute muss auf die Klasse angewendet werden, die den Rückrufvertrag implementiert.The CallbackBehaviorAttribute must be applied to the class that implements the callback contract. Beim Anwenden auf eine Nicht-Duplex-Vertragsimplementierung wird zur Laufzeit eine InvalidOperationException-Ausnahme ausgelöst.If applied to a non-duplex contract implementation an InvalidOperationException exception is thrown at runtime.

Hinweis

Sie können auch das OperationBehaviorAttribute-Attribut für die Rückrufvorgangsimplementierungen verwenden.You can also use the OperationBehaviorAttribute attribute for the callback operation implementations. Wenn OperationBehaviorAttribute für einen Rückrufvorgang verwendet wird, muss die ReleaseInstanceMode-Eigenschaft auf None festgelegt sein, da sonst zur Laufzeit eine InvalidOperationException-Ausnahme ausgelöst wird.However, if OperationBehaviorAttribute is used on a callback operation, the ReleaseInstanceMode property must be None or an InvalidOperationException exception is thrown at runtime.

Die folgenden Eigenschaften sind verfügbar:The following properties are available:

  • Die AutomaticSessionShutdown-Eigenschaft schließt die Sitzung automatisch, wenn der Kanal geschlossen wird und der Rückruf die Verarbeitung aller übrigen Nachrichten abgeschlossen hat.The AutomaticSessionShutdown property automatically closes the session when the channel is closed and the callback has finished processing any remaining messages.

  • Die ConcurrencyMode-Eigenschaft steuert das interne Threadingmodell und aktiviert so die Unterstützung für wiedereintrittsfähige oder Multithread-Rückrufobjekte.The ConcurrencyMode property controls the internal threading model, enabling support for reentrant or multithreaded callback objects.

  • Die IgnoreExtensionDataObject-Eigenschaft ermöglicht der Laufzeit, zusätzliche Serialisierungsinformationen zu ignorieren, die zum Verarbeiten der Nachricht nicht erforderlich sind.The IgnoreExtensionDataObject property enables the runtime to ignore extra serialization information that is not required to process the message.

  • Die IncludeExceptionDetailInFaults-Eigenschaft gibt an, ob nicht verarbeitete Ausnahmen in einem Dienst zu Debuggingzwecken als SOAP-Fehler an den Dienst zurückgegeben werden.The IncludeExceptionDetailInFaults property specifies whether unhandled exceptions in a service are returned to the service as SOAP faults for debugging purposes.

  • Die MaxItemsInObjectGraph-Eigenschaft schränkt die Anzahl von Elementen in einem Objektdiagramm, die serialisiert werden, ein.The MaxItemsInObjectGraph property limits on the number of items in an object graph that are serialized.

  • Die TransactionIsolationLevel-Eigenschaft gibt die Isolierungsebene der Transaktion an, die vom Vertrag unterstützt wird.The TransactionIsolationLevel property specifies the transaction isolation level that the contract supports.

  • Die TransactionTimeout-Eigenschaft gibt den Zeitraum an, in dem eine Transaktion abgeschlossen werden muss, bevor sie abgebrochen wird.The TransactionTimeout property specifies the time period within which a transaction must complete or it aborts.

  • Die UseSynchronizationContext-Eigenschaft gibt an, ob eingehende Methodenaufrufe automatisch mit dem aktuellen SynchronizationContext-Objekt synchronisiert werden sollen.The UseSynchronizationContext property indicates whether to synchronize inbound method calls automatically using the current SynchronizationContext object.

  • Die ValidateMustUnderstand-Eigenschaft informiert das System, ob es prüfen sollte, dass als MustUnderstand markierte SOAP-Header in der Tat verstanden wurden.The ValidateMustUnderstand property informs the system whether it should confirm that SOAP headers marked as MustUnderstand have, in fact, been understood.

Konstruktoren

CallbackBehaviorAttribute()

Initialisiert eine neue Instanz der CallbackBehaviorAttribute-Klasse.Initializes a new instance of the CallbackBehaviorAttribute class.

Eigenschaften

AutomaticSessionShutdown

Gibt an, ob eine Sitzung automatisch geschlossen wird, wenn ein Dienst eine Duplexsitzung schließt.Specifies whether to automatically close a session when a service closes a duplex session.

ConcurrencyMode

Gibt an, ob ein Dienst einen Thread, mehrere Threads oder wiedereintrittsfähige Aufrufe unterstützt, oder legt dies fest.Gets or sets whether a service supports one thread, multiple threads, or reentrant calls.

IgnoreExtensionDataObject

Ruft einen Wert ab, der angibt, ob unbekannte Serialisierungsdaten gesendet werden sollen, oder legt ihn fest.Gets or sets a value that specifies whether to send unknown serialization data onto the wire.

IncludeExceptionDetailInFaults

Ruft einen Wert ab bzw. legt ihn fest, der angibt, dass allgemeine nicht behandelte Ausführungsausnahmen in eine FaultException<TDetail> vom Typ String konvertiert und als Fehlermeldung gesendet werden.Gets or sets a value that specifies that general unhandled execution exceptions are to be converted into a FaultException<TDetail> of type String and sent as a fault message. Legen Sie dieses Attribut nur während der Entwicklung auf true fest, um Fehler in einem Dienst zu beheben.Set this to true only during development to troubleshoot a service.

MaxItemsInObjectGraph

Ruft die maximale Anzahl der in einem serialisierten Objekt zulässigen Elemente ab oder legt sie fest.Gets or sets the maximum number of items allowed in a serialized object.

TransactionIsolationLevel

Gibt die Isolationsstufe für die Transaktion an.Specifies the transaction isolation level.

TransactionTimeout

Ruft den Zeitraum ab oder legt den Zeitraum fest, innerhalb dessen eine Transaktion abgeschlossen werden muss.Gets or sets the period within which a transaction must complete.

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Geerbt von Attribute)
UseSynchronizationContext

Ruft einen Wert ab bzw. legt einen Wert fest, der angibt, ob der aktuelle Synchronisierungskontext zum Auswählen des Ausführungsthreads verwendet wird.Gets or sets a value that specifies whether to use the current synchronization context to choose the thread of execution.

ValidateMustUnderstand

Ruft einen Wert ab oder legt diesen fest, der angibt, ob das System oder die Anwendung die Verarbeitung von MustUnderstand-SOAP-Headern erzwingt.Gets or sets a value that specifies whether the system or the application enforces SOAP MustUnderstand header processing.

Methoden

Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

(Geerbt von Attribute)
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

(Geerbt von Attribute)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Geerbt von Attribute)
Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Geerbt von Attribute)
IEndpointBehavior.AddBindingParameters(ServiceEndpoint, BindingParameterCollection)

Konfiguriert die Bindungselemente zur Unterstützung des Rückrufverhaltens.Configures the binding elements to support the callback behavior.

IEndpointBehavior.ApplyClientBehavior(ServiceEndpoint, ClientRuntime)

Konfiguriert die Clientlaufzeit, um das Rückrufobjekt zu unterstützen.Configures the client runtime to support the callback object.

IEndpointBehavior.ApplyDispatchBehavior(ServiceEndpoint, EndpointDispatcher)

Implementierung der ApplyDispatchBehavior(ServiceEndpoint, EndpointDispatcher)-Methode.Implementation of the ApplyDispatchBehavior(ServiceEndpoint, EndpointDispatcher) method. Diese Implementierung hat keine Auswirkungen.This implementation has no effect.

IEndpointBehavior.Validate(ServiceEndpoint)

Überprüft die Endpunktbeschreibung vor dem Erstellen der Laufzeit.Validates the endpoint description prior to building the runtime.

Gilt für: