ServiceDescription Class
Represents a complete, in-memory description of the service, including all the endpoints for the service and specifications for their respective addresses, bindings, contracts and behaviors.
Assembly: System.ServiceModel (in System.ServiceModel.dll)
| Name | Description | |
|---|---|---|
![]() | ServiceDescription() | Initializes a new instance of the ServiceDescription class. |
![]() | ServiceDescription(IEnumerable(Of ServiceEndpoint)) | Initializes a new instance of the ServiceDescription class from a specified enumeration of service endpoints. |
| Name | Description | |
|---|---|---|
![]() | Behaviors | Gets the behaviors associated with the service. |
![]() | ConfigurationName | Gets or sets the name of the <service> configuration element. |
![]() | Endpoints | Gets the collection of endpoints from the service description. |
![]() | Name | Gets or sets the name of the service. |
![]() | Namespace | Gets or sets the namespace for the service. |
![]() | ServiceType | Gets the type of the service. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | Determines whether the specified object is equal to the current object.(Inherited from Object.) |
![]() | Finalize() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.) |
![]() | GetHashCode() | Serves as the default hash function. (Inherited from Object.) |
![]() ![]() | GetService(Object) | Returns a service description initialized with a specified service object. |
![]() ![]() | GetService(Type) | Returns a service description initialized with a specified service type. |
![]() | GetType() | |
![]() | MemberwiseClone() | |
![]() | ToString() | Returns a string that represents the current object.(Inherited from Object.) |
The information contained in the ServiceDescription is used by the Windows Communication Foundation (WCF) system to building the run-time components for the service.
Use this method when adding custom behaviors to extend ServiceHost. Programmatically, you must Add(T) the custom service behavior to the Behaviors prior to when you call the Open method on the ServiceHost object.
The GetService(Object) and GetService(Type) methods are available to reflect on behaviors using the Windows Communication Foundation (WCF) programming model when replacing ServiceHostBase with you own hosting mechanism.
Export metadata about a service endpoint by passing ServiceEndpoint as a parameter to ExportEndpoint(ServiceEndpoint). After calling this method, or one of the other export methods provided by WsdlExporter, use the GeneratedWsdlDocuments property to return the collection of ServiceDescription objects.
The following example illustrates various ways to instantiate a ServiceDescription object.
Dim baseAddress As New Uri("http://localhost:8001/Simple") Dim serviceHost As New ServiceHost(GetType(CalculatorService), baseAddress) serviceHost.AddServiceEndpoint(GetType(ICalculator), New WSHttpBinding(), "CalculatorServiceObject") ' Enable Mex Dim smb As New ServiceMetadataBehavior() smb.HttpGetEnabled = True serviceHost.Description.Behaviors.Add(smb) serviceHost.Open() ' Use Default constructor Dim sd As New ServiceDescription() ' Create ServiceDescription from a collection of service endpoints Dim endpoints As New List(Of ServiceEndpoint)() Dim conDescr As New ContractDescription("ICalculator") Dim endpointAddress As New EndpointAddress("http://localhost:8001/Basic") Dim ep As New ServiceEndpoint(conDescr, New BasicHttpBinding(), endpointAddress) endpoints.Add(ep) Dim sd2 As New ServiceDescription(endpoints) '// <Snippet3> '// Iterate through the list of behaviors in the ServiceDescription Dim svcDesc As ServiceDescription = serviceHost.Description Dim sbCol As KeyedByTypeCollection(Of IServiceBehavior) = svcDesc.Behaviors For Each behavior As IServiceBehavior In sbCol Console.WriteLine("Behavior: {0}", CType(behavior, Object).ToString()) Next behavior ' svcDesc is a ServiceDescription. svcDesc = serviceHost.Description Dim configName As String = svcDesc.ConfigurationName Console.WriteLine("Configuration name: {0}", configName) ' Iterate through the endpoints contained in the ServiceDescription Dim sec As ServiceEndpointCollection = svcDesc.Endpoints For Each se As ServiceEndpoint In sec Console.WriteLine("Endpoint:") Console.WriteLine(Constants.vbTab & "Address: {0}", se.Address.ToString()) Console.WriteLine(Constants.vbTab & "Binding: {0}", se.Binding.ToString()) Console.WriteLine(Constants.vbTab & "Contract: {0}", se.Contract.ToString()) Dim behaviors As KeyedByTypeCollection(Of IEndpointBehavior) = se.Behaviors For Each behavior As IEndpointBehavior In behaviors Console.WriteLine("Behavior: {0}", CType(behavior, Object).ToString()) Next behavior Next se Dim name = svcDesc.Name Console.WriteLine("Service Description name: {0}", name) Dim namespc = svcDesc.Namespace Console.WriteLine("Service Description namespace: {0}", namespc) Dim serviceType As Type = svcDesc.ServiceType Console.WriteLine("Service Type: {0}", serviceType.ToString()) ' Instantiate a service description specifying a service object ' Note: Endpoints collection and other properties will be null since ' we have not specified them Dim svcObj As New CalculatorService() Dim sd3 As ServiceDescription = ServiceDescription.GetService(svcObj) Dim serviceName = sd3.Name Console.WriteLine("Service name: {0}", serviceName)
Available since 3.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.



