ChannelListenerBase<TChannel> Class

Reference

Definition

Namespace:: System.ServiceModel.Channels

Assembly:: System.ServiceModel.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.

Provides a common base implementation for channel listeners on a service to accept channels produced by the client factories.

generic <typename TChannel>
 where TChannel : class, IChannelpublic ref class ChannelListenerBase abstract : System::ServiceModel::Channels::ChannelListenerBase, System::ServiceModel::Channels::IChannelListener<TChannel>

public abstract class ChannelListenerBase<TChannel> : System.ServiceModel.Channels.ChannelListenerBase, System.ServiceModel.Channels.IChannelListener<TChannel> where TChannel : class, IChannel

type ChannelListenerBase<'Channel (requires 'Channel : null and 'Channel :> IChannel)> = class
    inherit ChannelListenerBase
    interface IChannelListener<'Channel (requires 'Channel : null and 'Channel :> IChannel)>
    interface IChannelListener
    interface ICommunicationObject

Public MustInherit Class ChannelListenerBase(Of TChannel)
Inherits ChannelListenerBase
Implements IChannelListener(Of TChannel)

Type Parameters

TChannel

The type of channel the channel listeners accept.

Inheritance: Object

CommunicationObject

ChannelManagerBase

ChannelListenerBase
ChannelListenerBase<TChannel>

Implements: IChannelListener IChannelListener<TChannel> ICommunicationObject

Remarks

The channel listeners on a service wait for and then accept the channels created by factories on the client. Once the channel connection is established between client and service, they can communicate by exchanging messages

Constructors

ChannelListenerBase<TChannel>()	Initializes a new instance of the ChannelListenerBase<TChannel> class.
ChannelListenerBase<TChannel>(IDefaultCommunicationTimeouts)	Initializes a new instance of the ChannelListenerBase<TChannel> class with specified default communication timeouts.

Properties

DefaultCloseTimeout	Gets the default interval of time provided for a close operation to complete. (Inherited from ChannelListenerBase)
DefaultOpenTimeout	Gets the default interval of time provided for an open operation to complete. (Inherited from ChannelListenerBase)
DefaultReceiveTimeout	Gets the default interval of time provided for a receive operation to complete. (Inherited from ChannelListenerBase)
DefaultSendTimeout	Gets the default interval of time provided for a send operation to complete. (Inherited from ChannelListenerBase)
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)
Uri	When implemented in derived class, gets the URI on which the channel listener listens for an incoming channel. (Inherited from ChannelListenerBase)

Methods

Abort()	Causes a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject)
AcceptChannel()	Accepts a channel of the type specified by the current channel listener.
AcceptChannel(TimeSpan)	Accepts a channel of the type specified by the current channel listener within a specified interval of time.
BeginAcceptChannel(AsyncCallback, Object)	Begins an asynchronous operation to accept a channel of the type specified by the current channel listener.
BeginAcceptChannel(TimeSpan, AsyncCallback, Object)	When implemented in a derived class, begins an asynchronous operation to accept a channel of the type specified by the current channel listener within a specified interval of time.
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)
BeginWaitForChannel(TimeSpan, AsyncCallback, Object)	When implemented in a derived class, begins an asynchronous operation to wait for a channel to arrive. (Inherited from ChannelListenerBase)
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)
EndAcceptChannel(IAsyncResult)	When implemented in a derived class, completes an asynchronous operation to accept a channel.
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)
EndWaitForChannel(IAsyncResult)	When implemented in a derived class, completes an asynchronous operation to wait for channels to arrive. (Inherited from ChannelListenerBase)
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 a typed object requested, if present, from the appropriate layer in the channel stack. (Inherited from ChannelListenerBase)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnAbort()	Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous abort operation. (Inherited from CommunicationObject)
OnAcceptChannel(TimeSpan)	When implemented in a derived class, provides an extensibility point when accepting a channel.
OnBeginAcceptChannel(TimeSpan, AsyncCallback, Object)	When implemented in a derived class, provides an asynchronous extensibility point when beginning to accept a channel.
OnBeginClose(TimeSpan, AsyncCallback, Object)	Inserts processing after a communication object transitions to the closing state due to the invocation of an asynchronous close operation. (Inherited from CommunicationObject)
OnBeginOpen(TimeSpan, AsyncCallback, Object)	Inserts processing on a communication object after it transitions to the opening state due to the invocation of an asynchronous open operation. (Inherited from CommunicationObject)
OnBeginWaitForChannel(TimeSpan, AsyncCallback, Object)	When implemented in a derived class, provides a point of extensibility when starting to wait for a channel to arrive. (Inherited from ChannelListenerBase)
OnClose(TimeSpan)	Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous close operation. (Inherited from CommunicationObject)
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)
OnEndAcceptChannel(IAsyncResult)	When implemented in a derived class, provides an asynchronous extensibility point when completing the acceptance a channel.
OnEndClose(IAsyncResult)	Completes an asynchronous operation on the close of a communication object. (Inherited from CommunicationObject)
OnEndOpen(IAsyncResult)	Completes an asynchronous operation on the open of a communication object. (Inherited from CommunicationObject)
OnEndWaitForChannel(IAsyncResult)	When implemented in a derived class, provides a point of extensibility when ending the waiting for a channel to arrive. (Inherited from ChannelListenerBase)
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)	Inserts processing on a communication object after it transitions into the opening state which must complete within a specified interval of time. (Inherited from CommunicationObject)
OnOpened()	Invoked during the transition of a communication object into the opened state. (Inherited from CommunicationObject)
OnOpening()	Invoked during the transition of a communication object into the opening state. (Inherited from CommunicationObject)
OnWaitForChannel(TimeSpan)	When overridden in a derived class, provides a point of extensibility when waiting for a channel to arrive. (Inherited from ChannelListenerBase)
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)
WaitForChannel(TimeSpan)	When implemented in a derived class, waits for a channel to arrive. (Inherited from ChannelListenerBase)

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

IDefaultCommunicationTimeouts.CloseTimeout	Gets the interval of time after which the close method, invoked by a communication object, times out. (Inherited from ChannelManagerBase)
IDefaultCommunicationTimeouts.OpenTimeout	Gets the interval of time after which the open method, invoked by a communication object, times out. (Inherited from ChannelManagerBase)
IDefaultCommunicationTimeouts.ReceiveTimeout	Gets the interval of time after which the receive method, invoked by a communication object, times out. (Inherited from ChannelManagerBase)
IDefaultCommunicationTimeouts.SendTimeout	Gets the interval of time after which the send method, invoked by a communication object, times out. (Inherited from ChannelManagerBase)

Applies to

Share via