ChannelFactory ChannelFactory ChannelFactory ChannelFactory Class

定義

クライアントがサービス エンドポイントにメッセージを送信するために使用するチャネルの作成と管理を行います。Creates and manages the channels that are used by clients to send messages to service endpoints.

public ref class ChannelFactory abstract : System::ServiceModel::Channels::CommunicationObject, IDisposable, System::ServiceModel::Channels::IChannelFactory
public abstract class ChannelFactory : System.ServiceModel.Channels.CommunicationObject, IDisposable, System.ServiceModel.Channels.IChannelFactory
type ChannelFactory = class
    inherit CommunicationObject
    interface IChannelFactory
    interface ICommunicationObject
    interface IDisposable
Public MustInherit Class ChannelFactory
Inherits CommunicationObject
Implements IChannelFactory, IDisposable
継承
派生
実装

次のコード例は、チャネル オブジェクトの作成前に、ファクトリによってプログラムでクライアント動作が挿入される方法を示します。The following code example shows how to insert programmatically a client behavior prior to the creation of the channel object by the factory.

public class Client
{
  public static void Main()
  {
    try
    {
      // Picks up configuration from the config file.
      ChannelFactory<ISampleServiceChannel> factory 
        = new ChannelFactory<ISampleServiceChannel>("WSHttpBinding_ISampleService");

      // Add the client side behavior programmatically to all created channels.
      factory.Endpoint.Behaviors.Add(new EndpointBehaviorMessageInspector());

      ISampleServiceChannel wcfClientChannel = factory.CreateChannel();

      // Making calls.
      Console.WriteLine("Enter the greeting to send: ");
      string greeting = Console.ReadLine();
      Console.WriteLine("The service responded: " + wcfClientChannel.SampleMethod(greeting));

      Console.WriteLine("Press ENTER to exit:");
      Console.ReadLine();

      // Done with service. 
      wcfClientChannel.Close();
      Console.WriteLine("Done!");
    }
    catch (TimeoutException timeProblem)
    {
      Console.WriteLine("The service operation timed out. " + timeProblem.Message);
      Console.Read();
    }
    catch (FaultException<SampleFault> fault)
    {
      Console.WriteLine("SampleFault fault occurred: {0}", fault.Detail.FaultMessage);
      Console.Read();
    }
    catch (CommunicationException commProblem)
    {
      Console.WriteLine("There was a communication problem. " + commProblem.Message);
      Console.Read();
    }
  }
Public Class Client
  Public Shared Sub Main()
	Try
	  ' Picks up configuration from the config file.
	  Dim factory As New ChannelFactory(Of ISampleServiceChannel)("WSHttpBinding_ISampleService")

	  ' Add the client side behavior programmatically to all created channels.
	  factory.Endpoint.Behaviors.Add(New EndpointBehaviorMessageInspector())

	  Dim wcfClientChannel As ISampleServiceChannel = factory.CreateChannel()

	  ' Making calls.
	  Console.WriteLine("Enter the greeting to send: ")
            Dim greeting As String = Console.ReadLine()
	  Console.WriteLine("The service responded: " & wcfClientChannel.SampleMethod(greeting))

	  Console.WriteLine("Press ENTER to exit:")
	  Console.ReadLine()

	  ' Done with service. 
	  wcfClientChannel.Close()
	  Console.WriteLine("Done!")
	Catch timeProblem As TimeoutException
	  Console.WriteLine("The service operation timed out. " & timeProblem.Message)
	  Console.Read()
	Catch fault As FaultException(Of SampleFault)
	  Console.WriteLine("SampleFault fault occurred: {0}", fault.Detail.FaultMessage)
	  Console.Read()
	Catch commProblem As CommunicationException
	  Console.WriteLine("There was a communication problem. " & commProblem.Message)
	  Console.Read()
	End Try
  End Sub

注釈

IChannelFactory インターフェイスを実装するチャネル ファクトリとそれらに関連付けられたチャネルは、通常は、通信パターンのイニシエーターによって使用されます。Channel factories that implement the IChannelFactory interface and their associated channels are generally used by the initiators of a communication pattern. IChannelListener インターフェイスを実装するリスナー ファクトリとそれらに関連付けられたリスナーは、通信で受け入れられるメカニズムを提供します。Listener factories that implement the IChannelListener interface and their associated listeners provide the mechanisms with which channels are accepted for communications.

このクラスはチャネル モデルの一部ではなく、サービス モデルの一部です。This class is not part of the channel model, but of the service model. CreateFactory メソッドは、サービス エンドポイントの IChannelFactory を作成する手段を提供します。The CreateFactory method provides the means to create an IChannelFactory for a service endpoint. これを使用して、メタデータやポリシーを使用せずにサービス上のインターフェイス コントラクトに接続するクライアントを構築します。Use it to construct a client that hooks up to an interface contract on the service without using metadata or policy.

注意

ChannelFactory.Credentials.Windows.AllowedImpersonationLevelTokenImpersonationLevel.Anonymous に設定すると、偽装レベルに関係なく、常に匿名ログインが行われます。Setting ChannelFactory.Credentials.Windows.AllowedImpersonationLevel to TokenImpersonationLevel.Anonymous always results in an anonymous logon regardless of impersonation level.

このクラスから派生するマネージド C++ ユーザーに対する特別な注意 :Special note for Managed C++ users deriving from this class:

  • クリーンアップ コードは、デストラクターではなく (On)(Begin)Close (または OnAbort のどちらか一方または両方) に置いてください。Put your cleanup code in (On)(Begin)Close (and/or OnAbort), not in a destructor.

  • デストラクターは使用しないでください。使用すると、コンパイラが IDisposable を自動生成します。Avoid destructors; they cause the compiler to auto-generate IDisposable.

  • 非参照メンバーを使用しないでください。使用すると、コンパイラが IDisposable を自動生成します。Avoid non-reference members; they can cause the compiler to auto-generate IDisposable.

  • ファイナライザーを使用しないでください。使用する場合は、ビルド警告を抑制し、SuppressFinalize(Object) を呼び出し、ファイナライザー自体を (On)(Begin)Close (または OnAbort のどちらか一方または両方) から呼び出して、自動生成される IDisposable の動作をエミュレートする必要があります。Avoid using a finalizer; but if you include one, you should suppress the build warning and call SuppressFinalize(Object) and the finalizer itself from (On)(Begin)Close (and/or OnAbort) to emulate what would have been the auto-generated IDisposable behavior.

プログラムを使用して動作を追加する場合は、チャネルの作成の前に Behaviors の適切な ChannelFactory プロパティに動作が追加されます。When adding behaviors programmatically, the behavior is added to the appropriate Behaviors property on the ChannelFactory prior to the creation of any channel. コード例については、「使用例」のセクションを参照してください。See the example section for a code sample.

コンストラクター

ChannelFactory() ChannelFactory() ChannelFactory() ChannelFactory()

ChannelFactory クラスの新しいインスタンスを初期化します。Initializes a new instance of the ChannelFactory class.

プロパティ

Credentials Credentials Credentials Credentials

このファクトリによって作成されるチャネルを介してサービス エンドポイントと通信するクライアントが使用する資格情報を取得します。Gets the credentials used by clients to communicate a service endpoint over the channels produced by the factory.

DefaultCloseTimeout DefaultCloseTimeout DefaultCloseTimeout DefaultCloseTimeout

クローズ操作が完了するまで待機する既定の時間を取得します。Gets the default interval of time provided for a close operation to complete.

DefaultOpenTimeout DefaultOpenTimeout DefaultOpenTimeout DefaultOpenTimeout

オープン操作が完了するまで待機する既定の時間を取得します。Gets the default interval of time provided for an open operation to complete.

Endpoint Endpoint Endpoint Endpoint

ファクトリによって作成されたチャネルが接続するサービス エンドポイントを取得します。Gets the service endpoint to which the channels produced by the factory connect.

IsDisposed IsDisposed IsDisposed IsDisposed

通信オブジェクトが破棄されたかどうかを示す値を取得します。Gets a value that indicates whether the communication object has been disposed.

(Inherited from CommunicationObject)
State State State State

通信オブジェクトの現在の状態を示す値を取得します。Gets a value that indicates the current state of the communication object.

(Inherited from CommunicationObject)
ThisLock ThisLock ThisLock ThisLock

状態遷移中にクラス インスタンスを保護する相互排他的なロックを取得します。Gets the mutually exclusive lock that protects the class instance during a state transition.

(Inherited from CommunicationObject)

メソッド

Abort() Abort() Abort() Abort()

通信オブジェクトを、直ちに現在の状態から Closing 状態に遷移させます。Causes a communication object to transition immediately from its current state into the closing state.

(Inherited from CommunicationObject)
ApplyConfiguration(String) ApplyConfiguration(String) ApplyConfiguration(String) 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.

BeginClose(AsyncCallback, Object) BeginClose(AsyncCallback, Object) BeginClose(AsyncCallback, Object) BeginClose(AsyncCallback, Object)

通信オブジェクトを閉じるための非同期操作を開始します。Begins an asynchronous operation to close a communication object.

(Inherited from CommunicationObject)
BeginClose(TimeSpan, AsyncCallback, Object) BeginClose(TimeSpan, AsyncCallback, Object) BeginClose(TimeSpan, AsyncCallback, Object) BeginClose(TimeSpan, AsyncCallback, Object)

タイムアウトを指定して、通信オブジェクトをクローズするための非同期操作を開始します。Begins an asynchronous operation to close a communication object with a specified timeout.

(Inherited from CommunicationObject)
BeginOpen(AsyncCallback, Object) BeginOpen(AsyncCallback, Object) BeginOpen(AsyncCallback, Object) BeginOpen(AsyncCallback, Object)

通信オブジェクトを開くための非同期操作を開始します。Begins an asynchronous operation to open a communication object.

(Inherited from CommunicationObject)
BeginOpen(TimeSpan, AsyncCallback, Object) BeginOpen(TimeSpan, AsyncCallback, Object) BeginOpen(TimeSpan, AsyncCallback, Object) BeginOpen(TimeSpan, AsyncCallback, Object)

指定した時間内で通信オブジェクトを開くための非同期操作を開始します。Begins an asynchronous operation to open a communication object within a specified interval of time.

(Inherited from CommunicationObject)
Close() Close() Close() Close()

通信オブジェクトを、現在の状態から Closed 状態に遷移させます。Causes a communication object to transition from its current state into the closed state.

(Inherited from CommunicationObject)
Close(TimeSpan) Close(TimeSpan) Close(TimeSpan) Close(TimeSpan)

指定した時間内で、通信オブジェクトを現在の状態から Closed 状態に遷移させます。Causes a communication object to transition from its current state into the closed state within a specified interval of time.

(Inherited from CommunicationObject)
CreateDescription() CreateDescription() CreateDescription() CreateDescription()

派生クラスで実装された場合は、チャネル ファクトリに関連付けられたサービス エンドポイントの説明を作成します。When implemented in a derived class, creates a description of the service endpoint associated with the channel factory.

CreateFactory() CreateFactory() CreateFactory() CreateFactory()

ファクトリの現在のエンドポイントのチャネル ファクトリを構築します。Builds the channel factory for the current endpoint of the factory.

EndClose(IAsyncResult) EndClose(IAsyncResult) EndClose(IAsyncResult) EndClose(IAsyncResult)

通信オブジェクトを閉じるための非同期操作を完了します。Completes an asynchronous operation to close a communication object.

(Inherited from CommunicationObject)
EndOpen(IAsyncResult) EndOpen(IAsyncResult) EndOpen(IAsyncResult) EndOpen(IAsyncResult)

通信オブジェクトを開くための非同期操作を完了します。Completes an asynchronous operation to open a communication object.

(Inherited from CommunicationObject)
EnsureOpened() EnsureOpened() EnsureOpened() EnsureOpened()

現在のチャネル ファクトリがまだ開いていない場合は、開きます。Opens the current channel factory if it is not yet opened.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
Fault() Fault() Fault() Fault()

通信オブジェクトを、現在の状態から Faulted 状態に遷移させます。Causes a communication object to transition from its current state into the faulted state.

(Inherited from CommunicationObject)
GetCommunicationObjectType() GetCommunicationObjectType() GetCommunicationObjectType() GetCommunicationObjectType()

通信オブジェクトの型を取得します。Gets the type of communication object.

(Inherited from CommunicationObject)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetProperty<T>() GetProperty<T>() GetProperty<T>() GetProperty<T>()

チャネル スタックの適切な層から、要求のあった型指定されたオブジェクト (ある場合) を返します。ない場合は null を返します。Returns the typed object requested, if present, from the appropriate layer in the channel stack, or null if not present.

GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
InitializeEndpoint(Binding, EndpointAddress) InitializeEndpoint(Binding, EndpointAddress) InitializeEndpoint(Binding, EndpointAddress) InitializeEndpoint(Binding, EndpointAddress)

指定したバインドとアドレスを使用して、チャネル ファクトリのサービス エンドポイントを初期化します。Initializes the service endpoint of the channel factory with a specified binding and address.

InitializeEndpoint(ServiceEndpoint) InitializeEndpoint(ServiceEndpoint) InitializeEndpoint(ServiceEndpoint) InitializeEndpoint(ServiceEndpoint)

指定したエンドポイントを使用して、チャネル ファクトリのサービス エンドポイントを初期化します。Initializes the service endpoint of the channel factory with a specified endpoint.

InitializeEndpoint(String, EndpointAddress) InitializeEndpoint(String, EndpointAddress) InitializeEndpoint(String, EndpointAddress) InitializeEndpoint(String, EndpointAddress)

指定したアドレスと構成を使用して、チャネル ファクトリのサービス エンドポイントを初期化します。Initializes the service endpoint of the channel factory with a specified address and configuration.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
OnAbort() OnAbort() OnAbort() OnAbort()

現在のチャネル ファクトリの内部チャネル ファクトリを終了します。Terminates the inner channel factory of the current channel factory.

OnBeginClose(TimeSpan, AsyncCallback, Object) OnBeginClose(TimeSpan, AsyncCallback, Object) OnBeginClose(TimeSpan, AsyncCallback, Object) 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.

OnBeginOpen(TimeSpan, AsyncCallback, Object) OnBeginOpen(TimeSpan, AsyncCallback, Object) OnBeginOpen(TimeSpan, AsyncCallback, Object) OnBeginOpen(TimeSpan, AsyncCallback, Object)

現在のチャネル ファクトリに関連付けられた開始オブジェクトを持つ内部チャネル ファクトリに対して、非同期の open 操作を開始します。Begins an asynchronous open operation on the inner channel factory of the current channel factory that has a state object associated with it.

OnClose(TimeSpan) OnClose(TimeSpan) OnClose(TimeSpan) OnClose(TimeSpan)

操作を完了するために、指定したタイムアウトで、内部チャネル ファクトリに対して close を呼び出します。Calls close on the inner channel factory with a specified time-out for the completion of the operation.

OnClosed() OnClosed() OnClosed() OnClosed()

通信オブジェクトが Closing 状態に遷移しているときに呼び出されます。Invoked during the transition of a communication object into the closing state.

(Inherited from CommunicationObject)
OnClosing() OnClosing() OnClosing() OnClosing()

通信オブジェクトが Closing 状態に遷移しているときに呼び出されます。Invoked during the transition of a communication object into the closing state.

(Inherited from CommunicationObject)
OnEndClose(IAsyncResult) OnEndClose(IAsyncResult) OnEndClose(IAsyncResult) OnEndClose(IAsyncResult)

現在のチャネル ファクトリの内部チャネル ファクトリに対する非同期のクローズ操作を完了します。Completes an asynchronous close operation on the inner channel factory of the current channel factory.

OnEndOpen(IAsyncResult) OnEndOpen(IAsyncResult) OnEndOpen(IAsyncResult) OnEndOpen(IAsyncResult)

現在のチャネル ファクトリの内部チャネル ファクトリに対する非同期の open 操作を完了します。Completes an asynchronous open operation on the inner channel factory of the current channel factory.

OnFaulted() OnFaulted() OnFaulted() OnFaulted()

同期フォールト操作の呼び出しにより通信オブジェクトが Faulted 状態に遷移した後で、通信オブジェクトに処理を挿入します。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) OnOpen(TimeSpan) OnOpen(TimeSpan) OnOpen(TimeSpan)

操作を完了するために、指定したタイムアウトで、現在のチャネル ファクトリの内部チャネル ファクトリに対して open を呼び出します。Calls open on the inner channel factory of the current channel factory with a specified time-out for the completion of the operation.

OnOpened() OnOpened() OnOpened() OnOpened()

チャネル ファクトリの ClientCredentials オブジェクトの読み取り専用コピーを初期化します。Initializes a read-only copy of the ClientCredentials object for the channel factory.

OnOpening() OnOpening() OnOpening() OnOpening()

現在のチャネルの内部チャネルを構築します。Builds the inner channel factory for the current channel.

Open() Open() Open() Open()

通信オブジェクトを、Created 状態から Opened 状態に遷移させます。Causes a communication object to transition from the created state into the opened state.

(Inherited from CommunicationObject)
Open(TimeSpan) Open(TimeSpan) Open(TimeSpan) Open(TimeSpan)

指定した時間内で、通信オブジェクトを Created 状態から Opened 状態に遷移させます。Causes a communication object to transition from the created state into the opened state within a specified interval of time.

(Inherited from CommunicationObject)
ThrowIfDisposed() ThrowIfDisposed() ThrowIfDisposed() ThrowIfDisposed()

通信オブジェクトが破棄された場合に、例外をスローします。Throws an exception if the communication object is disposed.

(Inherited from CommunicationObject)
ThrowIfDisposedOrImmutable() ThrowIfDisposedOrImmutable() ThrowIfDisposedOrImmutable() ThrowIfDisposedOrImmutable()

通信オブジェクトの State プロパティが Created 状態に設定されていない場合、例外をスローします。Throws an exception if the communication object the State property is not set to the Created state.

(Inherited from CommunicationObject)
ThrowIfDisposedOrNotOpen() ThrowIfDisposedOrNotOpen() ThrowIfDisposedOrNotOpen() ThrowIfDisposedOrNotOpen()

通信オブジェクトが Opened 状態ではない場合に、例外をスローします。Throws an exception if the communication object is not in the Opened state.

(Inherited from CommunicationObject)
ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

明示的なインターフェイスの実装

IDisposable.Dispose() IDisposable.Dispose() IDisposable.Dispose() IDisposable.Dispose()

現在のチャネル ファクトリを閉じます。Closes the current channel factory.

イベント

Closed Closed Closed Closed

通信オブジェクトが Closed 状態に遷移すると発生します。Occurs when a communication object transitions into the closed state.

(Inherited from CommunicationObject)
Closing Closing Closing Closing

通信オブジェクトが Closing 状態に遷移すると発生します。Occurs when a communication object transitions into the closing state.

(Inherited from CommunicationObject)
Faulted Faulted Faulted Faulted

通信オブジェクトが Faulted 状態に遷移すると発生します。Occurs when a communication object transitions into the faulted state.

(Inherited from CommunicationObject)
Opened Opened Opened Opened

通信オブジェクトが Opened 状態に遷移すると発生します。Occurs when a communication object transitions into the opened state.

(Inherited from CommunicationObject)
Opening Opening Opening Opening

通信オブジェクトが Opening 状態に遷移すると発生します。Occurs when a communication object transitions into the opening state.

(Inherited from CommunicationObject)

適用対象