Export (0) Print
Expand All

ServiceContractAttribute Class

Indicates that an interface or a class defines a service contract in a Silverlight client application.

System.Object
  System.Attribute
    System.ServiceModel.ServiceContractAttribute

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

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Interface, Inherited := False,  _
	AllowMultiple := False)> _
Public NotInheritable Class ServiceContractAttribute _
	Inherits Attribute

The ServiceContractAttribute type exposes the following members.

  NameDescription
Public methodSupported by Silverlight for Windows PhoneServiceContractAttributeInitializes a new instance of the ServiceContractAttribute class.
Top

  NameDescription
Public propertySupported by Silverlight for Windows PhoneCallbackContractGets or sets the type of callback contract when the contract is a duplex contract.
Public propertySupported by Silverlight for Windows PhoneConfigurationNameGets or sets the name used to locate the service in an application configuration file.
Public propertySupported by Silverlight for Windows PhoneNameGets or sets the name for the <portType> element in Web Services Description Language (WSDL).
Public propertySupported by Silverlight for Windows PhoneNamespaceGets or sets the namespace of the <portType> element in Web Services Description Language (WSDL).
Top

  NameDescription
Public methodSupported by Silverlight for Windows PhoneEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodSupported by Silverlight for Windows PhoneFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodSupported by Silverlight for Windows PhoneGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodSupported by Silverlight for Windows PhoneMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Use the ServiceContractAttribute attribute on an interface (or class) to define a service contract. Then use the OperationContractAttribute attribute on one or more of the class (or interface) methods to define the contract's service operations.

The information expressed by a ServiceContractAttribute and its interface are loosely related to the Web Services Description Language (WSDL) <portType> element. A service contract is used on the service to specify what the service’s endpoint exposes to callers. It is also used on the client to specify the contract of the endpoint with which the client communicates.

NoteNote:

An interface or class that is marked with ServiceContractAttribute must also have at least one method marked with the OperationContractAttribute attribute to expose any functionality. See the Examples section for a code example of the most basic use of the two attributes to define and implement a service.

Use the ServiceContractAttribute properties to modify the service contract.

  • The Name and Namespace properties control the name and namespace of the contract in the WSDL <portType> element.

  • The CallbackContract property specifies the return contract in a two-way (duplex) conversation.

Services implement service contracts, which represent the data exchange that a service type supports. A service class can implement a service contract (by implementing an interface marked with ServiceContractAttribute that has methods marked with OperationContractAttribute) or it can be marked with the ServiceContractAttribute and apply the OperationContractAttribute attribute to its own methods. (If a class implements an interface marked with ServiceContractAttribute, it cannot be itself marked with ServiceContractAttribute.) Methods on service types that are marked with the OperationContractAttribute are treated as part of a default service contract specified by the service type itself.

For more information about

service operations, see OperationContractAttribute.

By default, the Name and Namespace properties are the name of the contract type and http://tempuri.org, respectively. It is recommended that service contracts explicitly set their names and namespaces using these properties. Doing so builds a contract that is not directly connected to the managed type information, enabling you to re-factor your managed code and namespaces without breaking the contract as it is expressed in WSDL.

Clients either use the service contract interface (the interface marked with ServiceContractAttribute) to create a channel to the service or they use the client objects (which combine the type information of the service contract interface with the ClientBase(Of TChannel) class) to communicate with your service.

Using a ServiceContractAttribute class or interface to inherit from another ServiceContractAttribute class or interface extends the parent contract. For example, if an IChildContract interface is marked with ServiceContractAttribute and inherited from another service contract interface, IParentContract, the IChildContract service contract contains the methods of both IParentContract and IChildContract. Extending contracts (whether on classes or interfaces) is very similar to extending managed classes and interfaces.

The most flexible approach to creating clients is to define service contract interfaces first and then have your client class implement that interface. Building clients directly by marking a class with ServiceContractAttribute and its methods with OperationContractAttribute works as well.


    'The following code contains an example of a duplex contract that contains a callback contract.
	<ServiceContract(Name := "SampleContract", Namespace := "Silverlight", CallbackContract := GetType(IDuplexClient))> _
	Public Interface IDuplexService
		<OperationContract(IsOneWay := True)> _
		Sub Order(ByVal name As String, ByVal quantity As Integer)
	End Interface

	<ServiceContract> _
	Public Interface IDuplexClient
		<OperationContract(IsOneWay := True)> _
		Sub Receive(ByVal order As Order)
	End Interface

	Public Class Order
		Private privateStatus As OrderStatus
		Public Property Status() As OrderStatus
			Get
				Return privateStatus
			End Get
			Set(ByVal value As OrderStatus)
				privateStatus = value
			End Set
		End Property
		Private privatePayload As List(Of String)
		Public Property Payload() As List(Of String)
			Get
				Return privatePayload
			End Get
			Set(ByVal value As List(Of String))
				privatePayload = value
			End Set
		End Property
	End Class

	Public Enum OrderStatus
		Processing
		Completed
	End Enum



Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Windows Phone OS 7.0

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

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

Community Additions

ADD
Show:
© 2014 Microsoft