WebChannelFactory<TChannel> Class

Reference

Definition

Namespace:: System.ServiceModel.Web

Assembly:: System.ServiceModel.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A class for accessing Windows Communication Foundation (WCF) Web services on a client.

generic <typename TChannel>
 where TChannel : classpublic ref class WebChannelFactory : System::ServiceModel::ChannelFactory<TChannel>

public class WebChannelFactory<TChannel> : System.ServiceModel.ChannelFactory<TChannel> where TChannel : class

type WebChannelFactory<'Channel (requires 'Channel : null)> = class
    inherit ChannelFactory<'Channel (requires 'Channel : null)>

Public Class WebChannelFactory(Of TChannel)
Inherits ChannelFactory(Of TChannel)

Type Parameters

TChannel

The type of channel to create.

Inheritance: Object

CommunicationObject

ChannelFactory

ChannelFactory<TChannel>
WebChannelFactory<TChannel>

Examples

The following code shows how to use the WebChannelFactory<TChannel> class to call a WCF service.

Uri baseAddress = new Uri("http://localhost:8000");
WebServiceHost host = new WebServiceHost(typeof(Service), baseAddress);
try
{
    host.Open();

    WebChannelFactory<IService> cf = new WebChannelFactory<IService>(baseAddress);
    IService channel = cf.CreateChannel();
    string s;

    Console.WriteLine("Calling EchoWithGet via HTTP GET: ");
    s = channel.EchoWithGet("Hello, world");
    Console.WriteLine("   Output: {0}", s);

    Console.WriteLine("");

    Console.WriteLine("Calling EchoWithPost via HTTP POST: ");
    s = channel.EchoWithPost("Hello, world");
    Console.WriteLine("   Output: {0}", s);

    Console.WriteLine("");
}
catch (CommunicationException ex)
{
    Console.WriteLine("An exception occurred: " + ex.Message);
}

Dim baseAddress As New Uri("http://localhost:8000")
Dim host As New WebServiceHost(GetType(Service), baseAddress)
Try
    host.Open()

    Dim cf As New WebChannelFactory(Of IService)(baseAddress)
    Dim channel As IService = cf.CreateChannel()
    Dim s As String

    Console.WriteLine("Calling EchoWithGet via HTTP GET: ")
    s = channel.EchoWithGet("Hello, world")
    Console.WriteLine("   Output:  0}", s)

    Console.WriteLine("")

    Console.WriteLine("Calling EchoWithPost via HTTP POST: ")
    s = channel.EchoWithPost("Hello, world")
    Console.WriteLine("   Output:  0}", s)

    Console.WriteLine("")

Catch ex As CommunicationException
    Console.WriteLine("An exception occurred: " + ex.Message)
End Try

For a full code example, see Basic WCF REST Programming Model Sample.

Remarks

This class is a special ChannelFactory that automatically adds the WebHttpBehavior to the endpoint if it is not already present. Furthermore, it adds a default WebHttpBinding to the endpoint if the binding is not explicitly configured and the address is an HTTP or HTTPS address.

If all the operations of the contract have no return value or have a return value of type Stream, then the WebChannelFactory<TChannel> configures the binding for the appropriate content type.

Constructors

WebChannelFactory<TChannel>()	Initializes a new instance of the WebChannelFactory<TChannel> class.
WebChannelFactory<TChannel>(Binding)	Initializes a new instance of the WebChannelFactory<TChannel> class.
WebChannelFactory<TChannel>(Binding, Uri)	Initializes a new instance of the WebChannelFactory<TChannel> class with the specified binding and Uri.
WebChannelFactory<TChannel>(ServiceEndpoint)	Initializes a new instance of the WebChannelFactory<TChannel> class.
WebChannelFactory<TChannel>(String)	Initializes a new instance of the WebChannelFactory<TChannel> class.
WebChannelFactory<TChannel>(String, Uri)	Initializes a new instance of the WebChannelFactory<TChannel> class with the specified endpoint configuration and Uri.
WebChannelFactory<TChannel>(Type)	Initializes a new instance of the WebChannelFactory<TChannel> class.
WebChannelFactory<TChannel>(Uri)	Initializes a new instance of the WebChannelFactory<TChannel> class with the specified Uri.

Properties

Credentials	Gets the credentials used by clients to communicate a service endpoint over the channels produced by the factory. (Inherited from ChannelFactory)
DefaultCloseTimeout	Gets the default interval of time provided for a close operation to complete. (Inherited from ChannelFactory)
DefaultOpenTimeout	Gets the default interval of time provided for an open operation to complete. (Inherited from ChannelFactory)
Endpoint	Gets the service endpoint to which the channels produced by the factory connect. (Inherited from ChannelFactory)
IsDisposed	Gets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject)
State	Gets a value that indicates the current state of the communication object. (Inherited from CommunicationObject)
ThisLock	Gets the mutually exclusive lock that protects the class instance during a state transition. (Inherited from CommunicationObject)

Methods

Abort()	Causes a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject)
ApplyConfiguration(String)	Initializes the channel factory with the behaviors provided by a specified configuration file and with those in the service endpoint of the channel factory. (Inherited from ChannelFactory)
BeginClose(AsyncCallback, Object)	Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject)
BeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from CommunicationObject)
BeginOpen(AsyncCallback, Object)	Begins an asynchronous operation to open a communication object. (Inherited from CommunicationObject)
BeginOpen(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from CommunicationObject)
Close()	Causes a communication object to transition from its current state into the closed state. (Inherited from CommunicationObject)
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)
CreateChannel()	Creates a channel of a specified type to a specified endpoint address. (Inherited from ChannelFactory<TChannel>)
CreateChannel(EndpointAddress)	Creates a channel that is used to send messages to a service at a specific endpoint address. (Inherited from ChannelFactory<TChannel>)
CreateChannel(EndpointAddress, Uri)	Creates a channel that is used to send messages to a service at a specific endpoint address through a specified transport address. (Inherited from ChannelFactory<TChannel>)
CreateChannelWithActAsToken(SecurityToken)	Creates a channel that is used to send messages to a service with an act as security token. (Inherited from ChannelFactory<TChannel>)
CreateChannelWithActAsToken(SecurityToken, EndpointAddress)	Creates a channel that is used to send messages to a service with an act as security token at a specific endpoint address. (Inherited from ChannelFactory<TChannel>)
CreateChannelWithActAsToken(SecurityToken, EndpointAddress, Uri)	Creates a channel that is used to send messages to a service with an act as security token at a specific endpoint address through a specified transport address. (Inherited from ChannelFactory<TChannel>)
CreateChannelWithIssuedToken(SecurityToken)	Creates a channel that is used to send messages to a service with an issued security token. (Inherited from ChannelFactory<TChannel>)
CreateChannelWithIssuedToken(SecurityToken, EndpointAddress)	Creates a channel that is used to send messages to a service with an issued security token at a specific endpoint address. (Inherited from ChannelFactory<TChannel>)
CreateChannelWithIssuedToken(SecurityToken, EndpointAddress, Uri)	Creates a channel that is used to send messages to a service with an issued security token at a specific endpoint address through a specified transport address. (Inherited from ChannelFactory<TChannel>)
CreateChannelWithOnBehalfOfToken(SecurityToken)	Creates a channel that is used to send messages to a service with an on behalf of security token. (Inherited from ChannelFactory<TChannel>)
CreateChannelWithOnBehalfOfToken(SecurityToken, EndpointAddress)	Creates a channel that is used to send messages to a service with an on behalf of security token at a specific endpoint address. (Inherited from ChannelFactory<TChannel>)
CreateChannelWithOnBehalfOfToken(SecurityToken, EndpointAddress, Uri)	Creates a channel that is used to send messages to a service with an on behalf of security token at a specific endpoint address through a specified transport address. (Inherited from ChannelFactory<TChannel>)
CreateDescription()	Creates a description of the service endpoint. (Inherited from ChannelFactory<TChannel>)
CreateFactory()	Builds the channel factory for the current endpoint of the factory. (Inherited from ChannelFactory)
EndClose(IAsyncResult)	Completes an asynchronous operation to close a communication object. (Inherited from CommunicationObject)
EndOpen(IAsyncResult)	Completes an asynchronous operation to open a communication object. (Inherited from CommunicationObject)
EnsureOpened()	Opens the current channel factory if it is not yet opened. (Inherited from ChannelFactory)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
Fault()	Causes a communication object to transition from its current state into the faulted state. (Inherited from CommunicationObject)
GetCommunicationObjectType()	Gets the type of communication object. (Inherited from CommunicationObject)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetProperty<T>()	Returns the typed object requested, if present, from the appropriate layer in the channel stack, or `null` if not present. (Inherited from ChannelFactory)
GetType()	Gets the Type of the current instance. (Inherited from Object)
InitializeEndpoint(Binding, EndpointAddress)	Initializes the service endpoint of the channel factory with a specified binding and address. (Inherited from ChannelFactory)
InitializeEndpoint(EndpointAddress)	(Inherited from ChannelFactory)
InitializeEndpoint(ServiceEndpoint)	Initializes the service endpoint of the channel factory with a specified endpoint. (Inherited from ChannelFactory)
InitializeEndpoint(String, EndpointAddress)	Initializes the service endpoint of the channel factory with a specified address and configuration. (Inherited from ChannelFactory)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnAbort()	Terminates the inner channel factory of the current channel factory. (Inherited from ChannelFactory)
OnBeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous close operation on the inner channel factory of the current channel factory that has a state object associated with it. (Inherited from ChannelFactory)
OnBeginOpen(TimeSpan, AsyncCallback, Object)	Begins an asynchronous open operation on the inner channel factory of the current channel factory that has a state object associated with it. (Inherited from ChannelFactory)
OnClose(TimeSpan)	Calls close on the inner channel factory with a specified time-out for the completion of the operation. (Inherited from ChannelFactory)
OnCloseAsync(TimeSpan)	(Inherited from ChannelFactory)
OnClosed()	Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject)
OnClosing()	Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject)
OnEndClose(IAsyncResult)	Completes an asynchronous close operation on the inner channel factory of the current channel factory. (Inherited from ChannelFactory)
OnEndOpen(IAsyncResult)	Completes an asynchronous open operation on the inner channel factory of the current channel factory. (Inherited from ChannelFactory)
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)
OnOpen(TimeSpan)	Calls open on the inner channel factory of the current channel factory with a specified time-out for the completion of the operation. (Inherited from ChannelFactory)
OnOpenAsync(TimeSpan)	(Inherited from ChannelFactory)
OnOpened()	Initializes a read-only copy of the ClientCredentials object for the channel factory. (Inherited from ChannelFactory)
OnOpening()	This method is called when the WebChannelFactory<TChannel> is opened.
Open()	Causes a communication object to transition from the created state into the opened state. (Inherited from CommunicationObject)
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)
ThrowIfDisposed()	Throws an exception if the communication object is disposed. (Inherited from CommunicationObject)
ThrowIfDisposedOrImmutable()	Throws an exception if the communication object the State property is not set to the Created state. (Inherited from CommunicationObject)
ThrowIfDisposedOrNotOpen()	Throws an exception if the communication object is not in the Opened state. (Inherited from CommunicationObject)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Events

Closed	Occurs when a communication object transitions into the closed state. (Inherited from CommunicationObject)
Closing	Occurs when a communication object transitions into the closing state. (Inherited from CommunicationObject)
Faulted	Occurs when a communication object transitions into the faulted state. (Inherited from CommunicationObject)
Opened	Occurs when a communication object transitions into the opened state. (Inherited from CommunicationObject)
Opening	Occurs when a communication object transitions into the opening state. (Inherited from CommunicationObject)

Explicit Interface Implementations

IDisposable.Dispose()

Closes the current channel factory.

(Inherited from ChannelFactory)

Applies to